Adding a docblock right before a foreach with information on the iterable/array fails

[MetalArend]

Bug report

If you write a docblock with a @var to describe the type of a variable right before a foreach loop, only the $key and $value variables are considered correct names to be used.
All the other variables in the scope are not considered.

Code snippet that reproduces the problem

https://phpstan.org/r/e9da45dc-458e-4cc9-b5bd-c8f37e4d5279

Expected output

At least the array itself should be considered a correct variable to have a @var docblock about. And even the other variables in the scope might be considered.

Thanks for considering this and taking the time to read this issue. I love what you do with phpstan a lot!

[ondrejmirtes]

Hi, thank you, this is a great opportunity for a contribution :)

This is where the logic is currently processed: https://github.com/phpstan/phpstan-src/blob/b07b33d2ff9b888b8c7baa1ff64d4aa71624cf99/src/Analyser/NodeScopeResolver.php#L2453-L2476

Additionally, this rule needs modification: https://github.com/phpstan/phpstan-src/blob/b07b33d2ff9b888b8c7baa1ff64d4aa71624cf99/src/Rules/PhpDoc/WrongVariableNameInVarTagRule.php#L72

The behaviour can be tested by adding a new dataProvider to NodeScopeResolverTest::testFileAsserts() (and getting inspired by some of the current data providers)

Additionally, WrongVariableNameInVarTagRuleTest should be modified too.

Looking forward to a PR :)

[ondrejmirtes]

This already works.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.