WrongVariableNameInVarTagRule - fix iteratee variable above foreach

src/Analyser/NodeScopeResolver.php

@@ -2897,6 +2897,9 @@ private function processVarAnnotation(MutatingScope $scope, array $variableNames
 
 	private function enterForeach(MutatingScope $scope, Foreach_ $stmt): MutatingScope
 	{
+		if ($stmt->expr instanceof Variable && is_string($stmt->expr->name)) {
+			$scope = $this->processVarAnnotation($scope, [$stmt->expr->name], $stmt);
+		}
 		$iterateeType = $scope->getType($stmt->expr);
 		$vars = [];
 		if ($stmt->valueVar instanceof Variable && is_string($stmt->valueVar->name)) {

src/Rules/PhpDoc/WrongVariableNameInVarTagRule.php

@@ -62,7 +62,7 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		if ($node instanceof Node\Stmt\Foreach_) {
-			return $this->processForeach($node->keyVar, $node->valueVar, $varTags);
+			return $this->processForeach($node->expr, $node->keyVar, $node->valueVar, $varTags);
 		}
 
 		if ($node instanceof Node\Stmt\Static_) {
@@ -168,9 +168,12 @@ private function getAssignedVariables(Expr $expr): array
 	 * @param \PHPStan\PhpDoc\Tag\VarTag[] $varTags
 	 * @return \PHPStan\Rules\RuleError[]
 	 */
-	private function processForeach(?Node\Expr $keyVar, Node\Expr $valueVar, array $varTags): array
+	private function processForeach(Node\Expr $iterateeExpr, ?Node\Expr $keyVar, Node\Expr $valueVar, array $varTags): array
 	{
 		$variableNames = [];
+		if ($iterateeExpr instanceof Node\Expr\Variable && is_string($iterateeExpr->name)) {
+			$variableNames[] = $iterateeExpr->name;
+		}
 		if ($keyVar instanceof Node\Expr\Variable && is_string($keyVar->name)) {
 			$variableNames[] = $keyVar->name;
 		}

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -4776,7 +4776,7 @@ public function dataForeachArrayType(): array
 			],
 			[
 				__DIR__ . '/data/foreach/type-in-comment-no-variable-2.php',
-				'mixed',
+				'*ERROR*',
 				'$value',
 			],
 			[
@@ -10758,6 +10758,11 @@ public function dataBug4500(): array
 		return $this->gatherAssertTypes(__DIR__ . '/data/bug-4500.php');
 	}
 
+	public function dataBug4504(): array
+	{
+		return $this->gatherAssertTypes(__DIR__ . '/data/bug-4504.php');
+	}
+
 	/**
 	 * @param string $file
 	 * @return array<string, mixed[]>
@@ -10972,6 +10977,7 @@ private function gatherAssertTypes(string $file): array
 	 * @dataProvider dataBug4415
 	 * @dataProvider dataCompact
 	 * @dataProvider dataBug4500
+	 * @dataProvider dataBug4504
 	 * @param string $assertType
 	 * @param string $file
 	 * @param mixed ...$args

tests/PHPStan/Analyser/data/bug-4504.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Bug4504TypeInference;
+
+use function PHPStan\Analyser\assertType;
+
+class Foo
+{
+
+	public function sayHello($models): void
+	{
+		/** @var \Iterator<A> $models */
+		foreach ($models as $k => $v) {
+			assertType('Bug4504TypeInference\A', $v);
+		}
+
+		assertType('array()|Iterator<mixed, Bug4504TypeInference\A>', $models);
+	}
+
+}
+

tests/PHPStan/Rules/PhpDoc/WrongVariableNameInVarTagRuleTest.php

@@ -31,11 +31,7 @@ public function testRule(): void
 				23,
 			],
 			[
-				'Variable $list in PHPDoc tag @var does not match any variable in the foreach loop: $key, $var',
-				29,
-			],
-			[
-				'Variable $foo in PHPDoc tag @var does not match any variable in the foreach loop: $key, $val',
+				'Variable $foo in PHPDoc tag @var does not match any variable in the foreach loop: $list, $key, $val',
 				66,
 			],
 			[
@@ -86,6 +82,10 @@ public function testRule(): void
 				'Variable $foo in PHPDoc tag @var does not exist.',
 				210,
 			],
+			[
+				'PHPDoc tag @var above foreach loop does not specify variable name.',
+				234,
+			],
 			[
 				'Variable $foo in PHPDoc tag @var does not exist.',
 				248,
@@ -151,4 +151,9 @@ public function testBug4500(): void
 		]);
 	}
 
+	public function testBug4504(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-4504.php'], []);
+	}
+
 }

tests/PHPStan/Rules/PhpDoc/data/bug-4504.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Bug4504;
+
+class Foo
+{
+
+	public function sayHello($models): void
+	{
+		/** @var \Iterator<A> $models */
+		foreach ($models as $k => $v) {
+
+		}
+	}
+
+}

tests/PHPStan/Rules/PhpDoc/data/wrong-variable-name-var.php

@@ -26,7 +26,7 @@ public function doFoo()
 	public function doBar(array $list)
 	{
 		/** @var int[] $list */
-		foreach ($list as $key => $var) { // ERROR
+		foreach ($list as $key => $var) {
 
 		}