Keep list on unset() with nested dim fetch

staabm · web-flow · commit 2fea15de06ea · 2025-07-17T17:05:19.000+02:00
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -48,6 +48,12 @@ parameters:
 			count: 2
 			path: src/Analyser/NodeScopeResolver.php
 
+		-
+			message: '#^Doing instanceof PHPStan\\Type\\Constant\\ConstantStringType is error\-prone and deprecated\. Use Type\:\:getConstantStrings\(\) instead\.$#'
+			identifier: phpstanApi.instanceofType
+			count: 1
+			path: src/Analyser/NodeScopeResolver.php
+
 		-
 			message: '#^Parameter \#2 \$node of method PHPStan\\BetterReflection\\SourceLocator\\Ast\\Strategy\\NodeToReflection\:\:__invoke\(\) expects PhpParser\\Node\\Expr\\ArrowFunction\|PhpParser\\Node\\Expr\\Closure\|PhpParser\\Node\\Expr\\FuncCall\|PhpParser\\Node\\Stmt\\Class_\|PhpParser\\Node\\Stmt\\Const_\|PhpParser\\Node\\Stmt\\Enum_\|PhpParser\\Node\\Stmt\\Function_\|PhpParser\\Node\\Stmt\\Interface_\|PhpParser\\Node\\Stmt\\Trait_, PhpParser\\Node\\Stmt\\ClassLike given\.$#'
 			identifier: argument.type
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -163,13 +163,15 @@
 use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Accessory\AccessoryArrayListType;
+use PHPStan\Type\Accessory\HasOffsetValueType;
 use PHPStan\Type\Accessory\NonEmptyArrayType;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\ClosureType;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\Constant\ConstantIntegerType;
+use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\FileTypeMapper;
 use PHPStan\Type\GeneralizePrecision;
@@ -5936,9 +5938,35 @@ private function produceArrayDimFetchAssignValueToWrite(array $dimFetchStack, ar
 				}
 				$offsetValueType = TypeCombinator::intersect($offsetValueType, TypeCombinator::union(...$types));
 			}
-			$valueToWrite = $offsetValueType->setOffsetValueType($offsetType, $valueToWrite, $i === 0);
 
 			$arrayDimFetch = $dimFetchStack[$i] ?? null;
+			if (
+				$offsetType !== null
+				&& $arrayDimFetch !== null
+				&& $scope->hasExpressionType($arrayDimFetch)->yes()
+			) {
+				$hasOffsetType = null;
+				if ($offsetType instanceof ConstantStringType || $offsetType instanceof ConstantIntegerType) {
+					$hasOffsetType = new HasOffsetValueType($offsetType, $valueToWrite);
+				}
+				$valueToWrite = $offsetValueType->setExistingOffsetValueType($offsetType, $valueToWrite);
+
+				if ($hasOffsetType !== null) {
+					$valueToWrite = TypeCombinator::intersect(
+						$valueToWrite,
+						$hasOffsetType,
+					);
+				} elseif ($valueToWrite->isArray()->yes()) {
+					$valueToWrite = TypeCombinator::intersect(
+						$valueToWrite,
+						new NonEmptyArrayType(),
+					);
+				}
+
+			} else {
+				$valueToWrite = $offsetValueType->setOffsetValueType($offsetType, $valueToWrite, $i === 0);
+			}
+
 			if ($arrayDimFetch === null || !$offsetValueType->isList()->yes()) {
 				continue;
 			}
diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -156,11 +156,7 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni
 
 	public function setExistingOffsetValueType(Type $offsetType, Type $valueType): Type
 	{
-		if ((new ConstantIntegerType(0))->isSuperTypeOf($offsetType)->yes()) {
-			return $this;
-		}
-
-		return new ErrorType();
+		return $this;
 	}
 
 	public function unsetOffset(Type $offsetType): Type
diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -184,6 +184,10 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni
 
 	public function setExistingOffsetValueType(Type $offsetType, Type $valueType): Type
 	{
+		if (!$offsetType->equals($this->offsetType)) {
+			return $this;
+		}
+
 		return new self($this->offsetType, $valueType);
 	}
 
diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -693,15 +693,8 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni
 
 	public function setExistingOffsetValueType(Type $offsetType, Type $valueType): Type
 	{
-		$offsetType = $offsetType->toArrayKey();
 		$builder = ConstantArrayTypeBuilder::createFromConstantArray($this);
-		foreach ($this->keyTypes as $keyType) {
-			if ($offsetType->isSuperTypeOf($keyType)->no()) {
-				continue;
-			}
-
-			$builder->setOffsetValueType($keyType, $valueType);
-		}
+		$builder->setOffsetValueType($offsetType, $valueType);
 
 		return $builder->getArray();
 	}
diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -829,6 +829,10 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni
 			}
 		}
 
+		if ($this->isList()->yes() && $this->getIterableValueType()->isArray()->yes()) {
+			$result = TypeCombinator::intersect($result, new AccessoryArrayListType());
+		}
+
 		return $result;
 	}
 
diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -226,6 +226,7 @@ private static function findTestFiles(): iterable
 		yield __DIR__ . '/../Rules/Arrays/data/bug-11679.php';
 		yield __DIR__ . '/../Rules/Methods/data/bug-4801.php';
 		yield __DIR__ . '/../Rules/Arrays/data/narrow-superglobal.php';
+		yield __DIR__ . '/../Rules/Methods/data/bug-12927.php';
 	}
 
 	/**
diff --git a/tests/PHPStan/Analyser/nsrt/bug-12274.php b/tests/PHPStan/Analyser/nsrt/bug-12274.php
@@ -56,8 +56,8 @@ function testKeepNestedListAfterIssetIndex(array $nestedList, int $i, int $j): v
 		assertType('list<list<int>>', $nestedList);
 		assertType('list<int>', $nestedList[$i]);
 		$nestedList[$i][$j] = 21;
-		assertType('non-empty-list<non-empty-list<int>>', $nestedList);
-		assertType('non-empty-list<int>', $nestedList[$i]);
+		assertType('non-empty-list<list<int>>', $nestedList);
+		assertType('list<int>', $nestedList[$i]);
 	}
 	assertType('list<list<int>>', $nestedList);
 }
diff --git a/tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php b/tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php
@@ -1224,6 +1224,11 @@ public function testBug1O580(): void
 	}
 
 	#[RequiresPhp('>= 8.0')]
+	public function testBug12927(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-12927.php'], []);
+	}
+
 	public function testBug4443(): void
 	{
 		$this->analyse([__DIR__ . '/data/bug-4443.php'], [
diff --git a/tests/PHPStan/Rules/Methods/data/bug-12927.php b/tests/PHPStan/Rules/Methods/data/bug-12927.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace Bug12927;
+
+use function PHPStan\Testing\assertType;
+
+class HelloWorld
+{
+	/**
+	 * @param list<array{abc: string}> $list
+	 * @return list<array<string>>
+	 */
+	public function sayHello(array $list): array
+	{
+		foreach($list as $k => $v) {
+			unset($list[$k]['abc']);
+			assertType('non-empty-list<array{}|array{abc: string}>', $list);
+			assertType('array{}|array{abc: string}', $list[$k]);
+		}
+		return $list;
+	}
+
+	/**
+	 * @param list<array<string, string>> $list
+	 */
+	public function sayFoo(array $list): void
+	{
+		foreach($list as $k => $v) {
+			unset($list[$k]['abc']);
+			assertType('non-empty-list<array<string, string>>', $list);
+			assertType('array<string, string>', $list[$k]);
+		}
+		assertType('list<array<string, string>>', $list);
+	}
+
+	/**
+	 * @param list<array<string, string>> $list
+	 */
+	public function sayFoo2(array $list): void
+	{
+		foreach($list as $k => $v) {
+			$list[$k]['abc'] = 'world';
+			assertType("non-empty-list<non-empty-array<string, string>&hasOffsetValue('abc', 'world')>", $list);
+			assertType("non-empty-array<string, string>&hasOffsetValue('abc', 'world')", $list[$k]);
+		}
+		assertType("list<non-empty-array<string, string>&hasOffsetValue('abc', 'world')>", $list);
+	}
+
+	/**
+	 * @param list<array<string, string>> $list
+	 */
+	public function sayFooBar(array $list): void
+	{
+		foreach($list as $k => $v) {
+			if (rand(0,1)) {
+				unset($list[$k]);
+			}
+			assertType('array<int<0, max>, array<string, string>>', $list);
+			assertType('array<string, string>', $list[$k]);
+		}
+		assertType('array<string, string>', $list[$k]);
+	}
+}
diff --git a/tests/PHPStan/Rules/Properties/TypesAssignedToPropertiesRuleTest.php b/tests/PHPStan/Rules/Properties/TypesAssignedToPropertiesRuleTest.php
@@ -800,4 +800,17 @@ public function testBug12675(): void
 		$this->analyse([__DIR__ . '/data/bug-12675.php'], []);
 	}
 
+	public function testBug11171(): void
+	{
+		$this->checkExplicitMixed = true;
+		$this->analyse([__DIR__ . '/data/bug-11171.php'], []);
+	}
+
+	#[RequiresPhp('>= 8.0')]
+	public function testBug8282(): void
+	{
+		$this->checkExplicitMixed = true;
+		$this->analyse([__DIR__ . '/data/bug-8282.php'], []);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Properties/data/bug-11171.php b/tests/PHPStan/Rules/Properties/data/bug-11171.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Bug11171;
+
+class TypeExpression
+{
+	public string $value;
+
+	/**
+	 * @var list<array{start_index: int, expression: self}>
+	 */
+	public array $innerTypeExpressions = [];
+
+	/**
+	 * @param \Closure(self): void $callback
+	 */
+	public function walkTypes(\Closure $callback): void
+	{
+		$startIndexOffset = 0;
+
+		foreach ($this->innerTypeExpressions as $k => ['start_index' => $startIndexOrig,
+				 'expression' => $inner,]) {
+			$this->innerTypeExpressions[$k]['start_index'] += $startIndexOffset;
+
+			$innerLengthOrig = \strlen($inner->value);
+
+			$inner->walkTypes($callback);
+
+			$this->value = substr_replace(
+				$this->value,
+				$inner->value,
+				$startIndexOrig + $startIndexOffset,
+				$innerLengthOrig
+			);
+
+			$startIndexOffset += \strlen($inner->value) - $innerLengthOrig;
+		}
+
+		$callback($this);
+	}
+}
diff --git a/tests/PHPStan/Rules/Properties/data/bug-8282.php b/tests/PHPStan/Rules/Properties/data/bug-8282.php
@@ -0,0 +1,31 @@
+<?php // lint >= 8.0
+
+namespace Bug8282;
+
+/**
+ * @phpstan-type record array{id: positive-int, name: string}
+ */
+class Collection
+{
+	/** @param list<record> $list */
+	public function __construct(
+		public array $list
+	)
+	{
+	}
+
+	public function updateName(int $index, string $name): void
+	{
+		assert(isset($this->list[$index]));
+		$this->list[$index]['name'] = $name;
+	}
+
+	public function updateNameById(int $id, string $name): void
+	{
+		foreach ($this->list as $index => $entry) {
+			if ($entry['id'] === $id) {
+				$this->list[$index]['name'] = $name;
+			}
+		}
+	}
+}
diff --git a/tests/PHPStan/Rules/Variables/ParameterOutAssignedTypeRuleTest.php b/tests/PHPStan/Rules/Variables/ParameterOutAssignedTypeRuleTest.php
@@ -5,6 +5,7 @@
 use PHPStan\Rules\Rule as TRule;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\RequiresPhp;
 
 /**
  * @extends RuleTestCase<ParameterOutAssignedTypeRule>
@@ -43,7 +44,7 @@ public function testRule(): void
 				47,
 			],
 			[
-				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doBaz3() expects list<list<int>>, array<int<0, max>, array<int<0, max>, int>> given.',
+				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doBaz3() expects list<list<int>>, list<array<int<0, max>, int>> given.',
 				56,
 			],
 			[
@@ -74,4 +75,10 @@ public function testBug13093b(): void
 		$this->analyse([__DIR__ . '/data/bug-13093b.php'], []);
 	}
 
+	#[RequiresPhp('>= 8.0')]
+	public function testBug12754(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-12754.php'], []);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Variables/ParameterOutExecutionEndTypeRuleTest.php b/tests/PHPStan/Rules/Variables/ParameterOutExecutionEndTypeRuleTest.php
@@ -58,4 +58,9 @@ public function testBug11363(): void
 		$this->analyse([__DIR__ . '/data/bug-11363.php'], []);
 	}
 
+	public function testBug12330(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-12330.php'], []);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Variables/data/bug-12330.php b/tests/PHPStan/Rules/Variables/data/bug-12330.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Bug12330;
+
+/**
+ * @param array{items: list<array<string, mixed>>} $options
+ * @param-out array{items: list<array<string, mixed>>} $options
+ */
+function alterItems(array &$options): void
+{
+	foreach ($options['items'] as $i => $item) {
+		$options['items'][$i]['options']['title'] = $item['name'];
+	}
+}
+
+/**
+ * @param array{items: array<int, array<string, mixed>>} $options
+ * @param-out array{items: array<int, array<string, mixed>>} $options
+ */
+function alterItems2(array &$options): void
+{
+	foreach ($options['items'] as $i => $item) {
+		$options['items'][$i]['options']['title'] = $item['name'];
+	}
+}
diff --git a/tests/PHPStan/Rules/Variables/data/bug-12754.php b/tests/PHPStan/Rules/Variables/data/bug-12754.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Bug12754;
+
+class HelloWorld
+{
+	/**
+	 * @param list<array{string, string}> $list
+	 * @return void
+	 */
+	public function modify(array &$list): void
+	{
+		foreach ($list as $int => $array) {
+			$list[$int][1] = $this->apply($array[1]);
+		}
+	}
+
+	/**
+	 * @param string $value
+	 * @return string
+	 */
+	public function apply(string $value): mixed
+	{
+		return $value;
+	}
+}
diff --git a/tests/PHPStan/Rules/Variables/data/bug-8113.php b/tests/PHPStan/Rules/Variables/data/bug-8113.php

Original file line number	Diff line number	Diff line change
`@@ -156,11 +156,7 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni`
`156`	`156`
`157`	`157`	`public function setExistingOffsetValueType(Type $offsetType, Type $valueType): Type`
`158`	`158`	`{`
`159`		`- if ((new ConstantIntegerType(0))->isSuperTypeOf($offsetType)->yes()) {`
`160`		`- return $this;`
`161`		`- }`
`162`		`-`
`163`		`- return new ErrorType();`
	`159`	`+ return $this;`
`164`	`160`	`}`
`165`	`161`
`166`	`162`	`public function unsetOffset(Type $offsetType): Type`
Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,10 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni`
`184`	`184`
`185`	`185`	`public function setExistingOffsetValueType(Type $offsetType, Type $valueType): Type`
`186`	`186`	`{`
	`187`	`+ if (!$offsetType->equals($this->offsetType)) {`
	`188`	`+ return $this;`
	`189`	`+ }`
	`190`	`+`
`187`	`191`	`return new self($this->offsetType, $valueType);`
`188`	`192`	`}`
`189`	`193`
Original file line number	Diff line number	Diff line change
`@@ -829,6 +829,10 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $uni`
`829`	`829`	`}`
`830`	`830`	`}`
`831`	`831`
	`832`	`+ if ($this->isList()->yes() && $this->getIterableValueType()->isArray()->yes()) {`
	`833`	`+ $result = TypeCombinator::intersect($result, new AccessoryArrayListType());`
	`834`	`+ }`
	`835`	`+`
`832`	`836`	`return $result;`
`833`	`837`	`}`
`834`	`838`
Original file line number	Diff line number	Diff line change
`@@ -226,6 +226,7 @@ private static function findTestFiles(): iterable`
`226`	`226`	`yield __DIR__ . '/../Rules/Arrays/data/bug-11679.php';`
`227`	`227`	`yield __DIR__ . '/../Rules/Methods/data/bug-4801.php';`
`228`	`228`	`yield __DIR__ . '/../Rules/Arrays/data/narrow-superglobal.php';`
	`229`	`+ yield __DIR__ . '/../Rules/Methods/data/bug-12927.php';`
`229`	`230`	`}`
`230`	`231`
`231`	`232`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -56,8 +56,8 @@ function testKeepNestedListAfterIssetIndex(array $nestedList, int $i, int $j): v`
`56`	`56`	`assertType('list<list<int>>', $nestedList);`
`57`	`57`	`assertType('list<int>', $nestedList[$i]);`
`58`	`58`	`$nestedList[$i][$j] = 21;`
`59`		`- assertType('non-empty-list<non-empty-list<int>>', $nestedList);`
`60`		`- assertType('non-empty-list<int>', $nestedList[$i]);`
	`59`	`+ assertType('non-empty-list<list<int>>', $nestedList);`
	`60`	`+ assertType('list<int>', $nestedList[$i]);`
`61`	`61`	`}`
`62`	`62`	`assertType('list<list<int>>', $nestedList);`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1224,6 +1224,11 @@ public function testBug1O580(): void`
`1224`	`1224`	`}`
`1225`	`1225`
`1226`	`1226`	`#[RequiresPhp('>= 8.0')]`
	`1227`	`+ public function testBug12927(): void`
	`1228`	`+ {`
	`1229`	`+ $this->analyse([__DIR__ . '/data/bug-12927.php'], []);`
	`1230`	`+ }`
	`1231`	`+`
`1227`	`1232`	`public function testBug4443(): void`
`1228`	`1233`	`{`
`1229`	`1234`	`$this->analyse([__DIR__ . '/data/bug-4443.php'], [`