Fix ArrayType::castToArrayKeyType() for template types

phpstan · May 9, 2020 · 0a992c2 · 0a992c2
1 parent 3eb6e79
commit 0a992c2
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 21 deletions.
diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -285,31 +285,35 @@ public function count(): Type
 
 	public static function castToArrayKeyType(Type $offsetType): Type
 	{
-		if ($offsetType instanceof UnionType) {
-			return TypeCombinator::union(...array_map(static function (Type $type): Type {
-				return self::castToArrayKeyType($type);
-			}, $offsetType->getTypes()));
-		}
+		return TypeTraverser::map($offsetType, static function (Type $offsetType, callable $traverse): Type {
+			if ($offsetType instanceof TemplateType) {
+				return $offsetType;
+			}
 
-		if ($offsetType instanceof ConstantScalarType) {
-			/** @var int|string $offsetValue */
-			$offsetValue = key([$offsetType->getValue() => null]);
-			return is_int($offsetValue) ? new ConstantIntegerType($offsetValue) : new ConstantStringType($offsetValue);
-		}
+			if ($offsetType instanceof ConstantScalarType) {
+				/** @var int|string $offsetValue */
+				$offsetValue = key([$offsetType->getValue() => null]);
+				return is_int($offsetValue) ? new ConstantIntegerType($offsetValue) : new ConstantStringType($offsetValue);
+			}
 
-		if ($offsetType instanceof IntegerType) {
-			return $offsetType;
-		}
+			if ($offsetType instanceof IntegerType) {
+				return $offsetType;
+			}
 
-		if ($offsetType instanceof FloatType || $offsetType instanceof BooleanType) {
-			return new IntegerType();
-		}
+			if ($offsetType instanceof FloatType || $offsetType instanceof BooleanType) {
+				return new IntegerType();
+			}
 
-		if ($offsetType instanceof StringType) {
-			return $offsetType;
-		}
+			if ($offsetType instanceof StringType) {
+				return $offsetType;
+			}
+
+			if ($offsetType instanceof UnionType || $offsetType instanceof IntersectionType) {
+				return $traverse($offsetType);
+			}
 
-		return new UnionType([new IntegerType(), new StringType()]);
+			return new UnionType([new IntegerType(), new StringType()]);
+		});
 	}
 
 	public function inferTemplateTypes(Type $receivedType): TemplateTypeMap

diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -125,7 +125,12 @@ public function getAllArrays(): array
 				$builder->setOffsetValueType($this->keyTypes[$i], $this->valueTypes[$i]);
 			}
 
-			$arrays[] = $builder->getArray();
+			$array = $builder->getArray();
+			if (!$array instanceof ConstantArrayType) {
+				throw new \PHPStan\ShouldNotHappenException();
+			}
+
+			$arrays[] = $array;
 		}
 
 		return $this->allArrays = $arrays;

diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -9879,6 +9879,11 @@ public function dataInheritPhpDocMerging(): array
 		);
 	}
 
+	public function dataBug3266(): array
+	{
+		return $this->gatherAssertTypes(__DIR__ . '/data/bug-3266.php');
+	}
+
 	/**
 	 * @dataProvider dataBug2574
 	 * @dataProvider dataBug2577
@@ -9923,6 +9928,7 @@ public function dataInheritPhpDocMerging(): array
 	 * @dataProvider dataBug2232
 	 * @dataProvider dataBug3009
 	 * @dataProvider dataInheritPhpDocMerging
+	 * @dataProvider dataBug3266
 	 * @param ConstantStringType $expectedType
 	 * @param Type $actualType
 	 */

diff --git a/tests/PHPStan/Analyser/data/bug-3266.php b/tests/PHPStan/Analyser/data/bug-3266.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Bug3266;
+
+use function PHPStan\Analyser\assertType;
+
+class Foo
+{
+
+	/**
+	 * @phpstan-template TKey
+	 * @phpstan-template TValue
+	 * @phpstan-param  array<TKey, TValue>  $iterator
+	 * @phpstan-return array<TKey, TValue>
+	 */
+	public function iteratorToArray($iterator)
+	{
+		assertType('array<TKey (method Bug3266\Foo::iteratorToArray(), argument), TValue (method Bug3266\Foo::iteratorToArray(), argument)>', $iterator);
+		$array = [];
+		foreach ($iterator as $key => $value) {
+			assertType('TKey (method Bug3266\Foo::iteratorToArray(), argument)', $key);
+			assertType('TValue (method Bug3266\Foo::iteratorToArray(), argument)', $value);
+			$array[$key] = $value;
+			assertType('array<TKey (method Bug3266\Foo::iteratorToArray(), argument), TValue (method Bug3266\Foo::iteratorToArray(), argument)>', $array);
+		}
+
+		assertType('array<TKey (method Bug3266\Foo::iteratorToArray(), argument), TValue (method Bug3266\Foo::iteratorToArray(), argument)>', $array);
+
+		return $array;
+	}
+
+}