narrow types in foreach expr

staabm · staabm · commit e0721e6e84c7 · 2025-07-27T10:32:55.000+02:00
diff --git a/.phpunit.cache/test-results b/.phpunit.cache/test-results
diff --git a/bug-13310.php b/bug-13310.php
@@ -0,0 +1,23 @@
+<?php
+
+function get_array(): array
+{
+	return [];
+}
+
+$tests = get_array();
+
+foreach ($tests as $test) {
+
+// information fichiers
+	$test['information'] = '';
+	$test['information'] .= $test['a'] ? 'test' : '';
+	$test['information'] .= $test['b'] ? 'test' : '';
+	$test['information'] .= $test['c'] ? 'test' : '';
+	$test['information'] .= $test['d'] ? 'test' : '';
+	$test['information'] .= $test['e'] ? 'test' : '';
+	$test['information'] .= $test['f'] ? 'test' : '';
+	$test['information'] .= $test['g'] ? 'test' : '';
+	$test['information'] .= $test['h'] ? 'test' : '';
+
+}
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -1250,6 +1250,19 @@ private function processStmtNode(
 			$exprType = $scope->getType($stmt->expr);
 			$isIterableAtLeastOnce = $exprType->isIterableAtLeastOnce();
 			if ($exprType->isIterable()->no() || $isIterableAtLeastOnce->maybe()) {
+				$foreachType = $this->getForeachType();
+				if (
+					!$foreachType->isSuperTypeOf($exprType)->yes()
+					&& $finalScope->getType($stmt->expr)->equals($foreachType)
+				) {
+					// restore iteratee type, in case the type was narrowed while entering the foreach
+					$finalScope = $finalScope->assignExpression(
+						$stmt->expr,
+						$exprType,
+						$scope->getNativeType($stmt->expr),
+					);
+				}
+
 				$finalScope = $finalScope->mergeWith($scope->filterByTruthyValue(new BooleanOr(
 					new BinaryOp\Identical(
 						$stmt->expr,
@@ -6307,11 +6320,35 @@ private function processVarAnnotation(MutatingScope $scope, array $variableNames
 		return $scope;
 	}
 
+	private function getForeachType(): Type
+	{
+		return TypeCombinator::union(
+			new ArrayType(new MixedType(), new MixedType()),
+			new ObjectType(Traversable::class),
+		);
+	}
+
 	private function enterForeach(MutatingScope $scope, MutatingScope $originalScope, Foreach_ $stmt): MutatingScope
 	{
 		if ($stmt->expr instanceof Variable && is_string($stmt->expr->name)) {
 			$scope = $this->processVarAnnotation($scope, [$stmt->expr->name], $stmt);
 		}
+
+		// narrow the iteratee type to those supported by foreach
+		$foreachType = $this->getForeachType();
+		$scope = $scope->specifyExpressionType(
+			$stmt->expr,
+			TypeCombinator::intersect(
+				$scope->getType($stmt->expr),
+				$foreachType,
+			),
+			TypeCombinator::intersect(
+				$scope->getNativeType($stmt->expr),
+				$foreachType,
+			),
+			TrinaryLogic::createYes(),
+		);
+
 		$iterateeType = $originalScope->getType($stmt->expr);
 		if (
 			($stmt->valueVar instanceof Variable && is_string($stmt->valueVar->name))
diff --git a/test.php b/test.php
@@ -0,0 +1,11 @@
+<?php
+
+use function PHPStan\Testing\assertType;
+
+function fooBar(mixed $mixed): void {
+    assertType('mixed', $mixed);
+    foreach ($mixed as $v) {
+        assertType('non-empty-array|Traversable', $mixed);
+    }
+    assertType('mixed', $mixed);
+}
diff --git a/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php b/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
@@ -5816,7 +5816,7 @@ public static function dataIterable(): array
 				'$iterableWithoutTypehint[0]',
 			],
 			[
-				'iterable',
+				'array|Traversable',
 				'$iterableWithIterableTypehint',
 			],
 			[
@@ -5828,7 +5828,7 @@ public static function dataIterable(): array
 				'$mixed',
 			],
 			[
-				'iterable<Iterables\Bar>',
+				'array<Iterables\Bar>|(iterable<Iterables\Bar>&Traversable)',
 				'$iterableWithConcreteTypehint',
 			],
 			[
@@ -5844,7 +5844,7 @@ public static function dataIterable(): array
 				'$this->doBar()',
 			],
 			[
-				'iterable<Iterables\Baz>',
+				'array<Iterables\Baz>|(iterable<Iterables\Baz>&Traversable)',
 				'$this->doBaz()',
 			],
 			[
diff --git a/tests/PHPStan/Analyser/nsrt/bug-13270a.php b/tests/PHPStan/Analyser/nsrt/bug-13270a.php
@@ -14,7 +14,7 @@ final class HelloWorld
 	public function test(array $data): void
 	{
 		foreach($data as $k => $v) {
-			assertType('non-empty-array<mixed>', $data);
+			assertType('non-empty-array', $data);
 			$data[$k]['a'] = true;
 			assertType("non-empty-array<(non-empty-array&hasOffsetValue('a', true))|(ArrayAccess&hasOffsetValue('a', true))>", $data);
 			foreach($data[$k] as $val) {
diff --git a/tests/PHPStan/Analyser/nsrt/bug-13312.php b/tests/PHPStan/Analyser/nsrt/bug-13312.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace Bug13312;
+
+use function PHPStan\Testing\assertType;
+
+function fooArr(array $arr): void {
+	assertType('array', $arr);
+	foreach ($arr as $v) {
+		assertType('non-empty-array', $arr);
+	}
+	assertType('array', $arr);
+
+	for ($i = 0; $i < count($arr); ++$i) {
+		assertType('non-empty-array', $arr);
+	}
+	assertType('array', $arr);
+}
+
+/** @param list<mixed> $arr */
+function foo(array $arr): void {
+	assertType('list<mixed>', $arr);
+	foreach ($arr as $v) {
+		assertType('non-empty-list<mixed>', $arr);
+	}
+	assertType('list<mixed>', $arr);
+
+	for ($i = 0; $i < count($arr); ++$i) {
+		assertType('non-empty-list<mixed>', $arr);
+	}
+	assertType('list<mixed>', $arr);
+}
+
+
+function fooBar(mixed $mixed): void {
+	assertType('mixed', $mixed);
+	foreach ($mixed as $v) {
+		assertType('array|Traversable', $mixed); // could be non-empty-array|Traversable
+	}
+	assertType('mixed', $mixed);
+
+	foreach ($mixed as $v) {}
+
+	assertType('mixed', $mixed);
+}
diff --git a/tests/PHPStan/Analyser/nsrt/composer-array-bug.php b/tests/PHPStan/Analyser/nsrt/composer-array-bug.php
@@ -18,26 +18,26 @@ public function doFoo(): void
 		if (!empty($this->config['authors'])) {
 			assertType("mixed~(0|0.0|''|'0'|array{}|false|null)", $this->config['authors']);
 			foreach ($this->config['authors'] as $key => $author) {
-				assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+				assertType("array|Traversable", $this->config['authors']);
 
 				if (!is_array($author)) {
 					$this->errors[] = 'authors.'.$key.' : should be an array, '.gettype($author).' given';
-					assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 					unset($this->config['authors'][$key]);
-					assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 					continue;
 				}
-				assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+				assertType("array|Traversable", $this->config['authors']);
 				foreach (['homepage', 'email', 'name', 'role'] as $authorData) {
 					if (isset($author[$authorData]) && !is_string($author[$authorData])) {
 						$this->errors[] = 'authors.'.$key.'.'.$authorData.' : invalid value, must be a string';
 						unset($this->config['authors'][$key][$authorData]);
 					}
 				}
 				if (isset($author['homepage'])) {
-					assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 					unset($this->config['authors'][$key]['homepage']);
-					assertType("array|ArrayAccess|string", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 				}
 				if (isset($author['email']) && !filter_var($author['email'], FILTER_VALIDATE_EMAIL)) {
 					unset($this->config['authors'][$key]['email']);
@@ -47,8 +47,8 @@ public function doFoo(): void
 				}
 			}
 
-			assertType("non-empty-array&hasOffsetValue('authors', mixed~(0|0.0|false|null))", $this->config);
-			assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+			assertType("non-empty-array&hasOffsetValue('authors', mixed~(0|0.0|''|'0'|array{}|false|null))", $this->config);
+			assertType("mixed~(0|0.0|''|'0'|array{}|false|null)", $this->config['authors']);
 
 			if (empty($this->config['authors'])) {
 				unset($this->config['authors']);
@@ -57,7 +57,7 @@ public function doFoo(): void
 				assertType("non-empty-array&hasOffsetValue('authors', mixed~(0|0.0|''|'0'|array{}|false|null))", $this->config);
 			}
 
-			assertType('array', $this->config);
+			assertType("non-empty-array&hasOffsetValue('authors', mixed~(0|0.0|''|'0'|array{}|false|null))", $this->config);
 		}
 	}
 
diff --git a/tests/PHPStan/Analyser/nsrt/composer-non-empty-array-after-unset.php b/tests/PHPStan/Analyser/nsrt/composer-non-empty-array-after-unset.php
@@ -15,10 +15,10 @@ public function doFoo()
 		if (!empty($this->config['authors'])) {
 			assertType("mixed~(0|0.0|''|'0'|array{}|false|null)", $this->config['authors']);
 			foreach ($this->config['authors'] as $key => $author) {
-				assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+				assertType("array|Traversable", $this->config['authors']);
 				if (!is_array($author)) {
 					unset($this->config['authors'][$key]);
-					assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 					continue;
 				}
 				foreach (['homepage', 'email', 'name', 'role'] as $authorData) {
@@ -33,13 +33,13 @@ public function doFoo()
 					unset($this->config['authors'][$key]['email']);
 				}
 				if (empty($this->config['authors'][$key])) {
-					assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 					unset($this->config['authors'][$key]);
-					assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+					assertType("array|Traversable", $this->config['authors']);
 				}
-				assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+				assertType("array|Traversable", $this->config['authors']);
 			}
-			assertType("mixed~(0|0.0|false|null)", $this->config['authors']);
+			assertType("mixed~(0|0.0|''|'0'|array{}|false|null)", $this->config['authors']);
 		}
 	}
 
diff --git a/tests/PHPStan/Rules/Arrays/IterableInForeachRuleTest.php b/tests/PHPStan/Rules/Arrays/IterableInForeachRuleTest.php
@@ -139,4 +139,9 @@ public function testMixed(bool $checkExplicitMixed, bool $checkImplicitMixed, ar
 		$this->analyse([__DIR__ . '/data/foreach-mixed.php'], $errors);
 	}
 
+	public function testBug13312(): void
+	{
+		$this->analyse([__DIR__ . '/../../Analyser/nsrt/bug-13312.php'], []);
+	}
+
 }

Original file line number	Diff line number	Diff line change
`@@ -5816,7 +5816,7 @@ public static function dataIterable(): array`
`5816`	`5816`	`'$iterableWithoutTypehint[0]',`
`5817`	`5817`	`],`
`5818`	`5818`	`[`
`5819`		`- 'iterable',`
	`5819`	`+ 'array\|Traversable',`
`5820`	`5820`	`'$iterableWithIterableTypehint',`
`5821`	`5821`	`],`
`5822`	`5822`	`[`
`@@ -5828,7 +5828,7 @@ public static function dataIterable(): array`
`5828`	`5828`	`'$mixed',`
`5829`	`5829`	`],`
`5830`	`5830`	`[`
`5831`		`- 'iterable<Iterables\Bar>',`
	`5831`	`+ 'array<Iterables\Bar>\|(iterable<Iterables\Bar>&Traversable)',`
`5832`	`5832`	`'$iterableWithConcreteTypehint',`
`5833`	`5833`	`],`
`5834`	`5834`	`[`
`@@ -5844,7 +5844,7 @@ public static function dataIterable(): array`
`5844`	`5844`	`'$this->doBar()',`
`5845`	`5845`	`],`
`5846`	`5846`	`[`
`5847`		`- 'iterable<Iterables\Baz>',`
	`5847`	`+ 'array<Iterables\Baz>\|(iterable<Iterables\Baz>&Traversable)',`
`5848`	`5848`	`'$this->doBaz()',`
`5849`	`5849`	`],`
`5850`	`5850`	`[`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ final class HelloWorld`
`14`	`14`	`public function test(array $data): void`
`15`	`15`	`{`
`16`	`16`	`foreach($data as $k => $v) {`
`17`		`- assertType('non-empty-array<mixed>', $data);`
	`17`	`+ assertType('non-empty-array', $data);`
`18`	`18`	`$data[$k]['a'] = true;`
`19`	`19`	`assertType("non-empty-array<(non-empty-array&hasOffsetValue('a', true))\|(ArrayAccess&hasOffsetValue('a', true))>", $data);`
`20`	`20`	`foreach($data[$k] as $val) {`
Original file line number	Diff line number	Diff line change
`@@ -18,26 +18,26 @@ public function doFoo(): void`
`18`	`18`	`if (!empty($this->config['authors'])) {`
`19`	`19`	`assertType("mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null)", $this->config['authors']);`
`20`	`20`	`foreach ($this->config['authors'] as $key => $author) {`
`21`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`21`	`+ assertType("array\|Traversable", $this->config['authors']);`
`22`	`22`
`23`	`23`	`if (!is_array($author)) {`
`24`	`24`	`$this->errors[] = 'authors.'.$key.' : should be an array, '.gettype($author).' given';`
`25`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`25`	`+ assertType("array\|Traversable", $this->config['authors']);`
`26`	`26`	`unset($this->config['authors'][$key]);`
`27`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`27`	`+ assertType("array\|Traversable", $this->config['authors']);`
`28`	`28`	`continue;`
`29`	`29`	`}`
`30`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`30`	`+ assertType("array\|Traversable", $this->config['authors']);`
`31`	`31`	`foreach (['homepage', 'email', 'name', 'role'] as $authorData) {`
`32`	`32`	`if (isset($author[$authorData]) && !is_string($author[$authorData])) {`
`33`	`33`	`$this->errors[] = 'authors.'.$key.'.'.$authorData.' : invalid value, must be a string';`
`34`	`34`	`unset($this->config['authors'][$key][$authorData]);`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`	`if (isset($author['homepage'])) {`
`38`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`38`	`+ assertType("array\|Traversable", $this->config['authors']);`
`39`	`39`	`unset($this->config['authors'][$key]['homepage']);`
`40`		`- assertType("array\|ArrayAccess\|string", $this->config['authors']);`
	`40`	`+ assertType("array\|Traversable", $this->config['authors']);`
`41`	`41`	`}`
`42`	`42`	`if (isset($author['email']) && !filter_var($author['email'], FILTER_VALIDATE_EMAIL)) {`
`43`	`43`	`unset($this->config['authors'][$key]['email']);`
`@@ -47,8 +47,8 @@ public function doFoo(): void`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`50`		`- assertType("non-empty-array&hasOffsetValue('authors', mixed~(0\|0.0\|false\|null))", $this->config);`
`51`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`50`	`+ assertType("non-empty-array&hasOffsetValue('authors', mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null))", $this->config);`
	`51`	`+ assertType("mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null)", $this->config['authors']);`
`52`	`52`
`53`	`53`	`if (empty($this->config['authors'])) {`
`54`	`54`	`unset($this->config['authors']);`
`@@ -57,7 +57,7 @@ public function doFoo(): void`
`57`	`57`	`assertType("non-empty-array&hasOffsetValue('authors', mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null))", $this->config);`
`58`	`58`	`}`
`59`	`59`
`60`		`- assertType('array', $this->config);`
	`60`	`+ assertType("non-empty-array&hasOffsetValue('authors', mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null))", $this->config);`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,10 @@ public function doFoo()`
`15`	`15`	`if (!empty($this->config['authors'])) {`
`16`	`16`	`assertType("mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null)", $this->config['authors']);`
`17`	`17`	`foreach ($this->config['authors'] as $key => $author) {`
`18`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`18`	`+ assertType("array\|Traversable", $this->config['authors']);`
`19`	`19`	`if (!is_array($author)) {`
`20`	`20`	`unset($this->config['authors'][$key]);`
`21`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`21`	`+ assertType("array\|Traversable", $this->config['authors']);`
`22`	`22`	`continue;`
`23`	`23`	`}`
`24`	`24`	`foreach (['homepage', 'email', 'name', 'role'] as $authorData) {`
`@@ -33,13 +33,13 @@ public function doFoo()`
`33`	`33`	`unset($this->config['authors'][$key]['email']);`
`34`	`34`	`}`
`35`	`35`	`if (empty($this->config['authors'][$key])) {`
`36`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`36`	`+ assertType("array\|Traversable", $this->config['authors']);`
`37`	`37`	`unset($this->config['authors'][$key]);`
`38`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`38`	`+ assertType("array\|Traversable", $this->config['authors']);`
`39`	`39`	`}`
`40`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`40`	`+ assertType("array\|Traversable", $this->config['authors']);`
`41`	`41`	`}`
`42`		`- assertType("mixed~(0\|0.0\|false\|null)", $this->config['authors']);`
	`42`	`+ assertType("mixed~(0\|0.0\|''\|'0'\|array{}\|false\|null)", $this->config['authors']);`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -139,4 +139,9 @@ public function testMixed(bool $checkExplicitMixed, bool $checkImplicitMixed, ar`
`139`	`139`	`$this->analyse([__DIR__ . '/data/foreach-mixed.php'], $errors);`
`140`	`140`	`}`
`141`	`141`
	`142`	`+ public function testBug13312(): void`
	`143`	`+ {`
	`144`	`+ $this->analyse([__DIR__ . '/../../Analyser/nsrt/bug-13312.php'], []);`
	`145`	`+ }`
	`146`	`+`
`142`	`147`	`}`