Skip to content

Fix ignore comment handling for multiple traits in a single file #4804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
takaram wants to merge 3 commits into
base: 2.1.x
Choose a base branch
from
+51 −1
Open

Fix ignore comment handling for multiple traits in a single file #4804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6eafaa
Fix ignore comment handling for multiple traits in a single file
takaram Jan 22, 2026
f14c554
Add more test
takaram Jan 27, 2026
5fd94f4
Fix name collision
takaram Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Analyser/FileAnalyser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ public function analyseFile(
}
if ($node instanceof InTraitNode) {
$traitNode = $node->getOriginalNode();
$linesToIgnore[$scope->getFileDescription()] = $this->getLinesToIgnoreFromTokens([$traitNode]);
$fileDescription = $scope->getFileDescription();
$linesToIgnore[$fileDescription] ??= [];
$linesToIgnore[$fileDescription] += $this->getLinesToIgnoreFromTokens([$traitNode]);
Copy link
Member

@ondrejmirtes ondrejmirtes Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please explain what's happening here? $scope->getFileDescription() should be unique per trait usage.

Copy link
Contributor Author

@takaram takaram Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The value of $scope->getFileDescription() contains:

  • File path where the trait is defined
  • Name of the class which uses the trait

It does not contain trait name, so is not necessarily unique when a file has two or more traits.


$traitFileName = $node->getTraitReflection()->getFileName();
if ($traitFileName !== null) {
Expand Down
12 changes: 12 additions & 0 deletions tests/PHPStan/Analyser/AnalyserIntegrationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1625,6 +1625,18 @@ public function testBug13980(): void
$this->assertNoErrors($errors);
}

public function testBug13945(): void
{
$errors = $this->runAnalyse(__DIR__ . '/data/bug-13945.php');
$this->assertNoErrors($errors);
}

public function testBug13945Two(): void
{
$errors = $this->runAnalyse(__DIR__ . '/data/bug-13945-2.php');
$this->assertNoErrors($errors);
}

/**
* @param string[]|null $allAnalysedFiles
* @return list<Error>
Expand Down
18 changes: 18 additions & 0 deletions tests/PHPStan/Analyser/data/bug-13945-2.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php declare(strict_types = 1);

namespace Bug13945Two;

trait Foo {
public function baz(): void {
$this->myProperty = "a"; // @phpstan-ignore property.notFound
}
}

trait Baz {
}

class HelloWorld
{
use Baz;
use Foo;
}
18 changes: 18 additions & 0 deletions tests/PHPStan/Analyser/data/bug-13945.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php declare(strict_types = 1);

namespace Bug13945;

trait Foo {
public function baz(): void {
$this->myProperty = "a"; // @phpstan-ignore property.notFound
}
}

trait Baz {
}

class HelloWorld
{
use Foo;
use Baz;
Comment on lines +16 to +17
Copy link
Contributor

@staabm staabm Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in phpstan/phpstan#13945 its reported that the errors emitted depend on the order of this use-statements.

I think it would be good than, to additional test this with use in different order

Copy link
Contributor Author

@takaram takaram Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a test case

}
Loading