Deprecate TypeUtils::getArrays() and TypeUtils::getAnyArrays()

herndlm · ondrejmirtes · commit 774f54ecb5d4 · 2022-10-06T06:34:54.000+02:00
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -4701,8 +4701,8 @@ private static function generalizeType(Type $a, Type $b): Type
 
 				$aValueType = $generalArraysA->getIterableValueType();
 				$bValueType = $generalArraysB->getIterableValueType();
-				$aArrays = TypeUtils::getAnyArrays($aValueType);
-				$bArrays = TypeUtils::getAnyArrays($bValueType);
+				$aArrays = $aValueType->getArrays();
+				$bArrays = $bValueType->getArrays();
 				if (
 					count($aArrays) === 1
 					&& !$aArrays[0] instanceof ConstantArrayType
@@ -4883,7 +4883,7 @@ private static function getArrayDepth(ArrayType $type): int
 		$depth = 0;
 		while ($type instanceof ArrayType) {
 			$temp = $type->getIterableValueType();
-			$arrays = TypeUtils::getAnyArrays($temp);
+			$arrays = $temp->getArrays();
 			if (count($arrays) === 1) {
 				$type = $arrays[0];
 			} else {
diff --git a/src/Rules/Arrays/InvalidKeyInArrayDimFetchRule.php b/src/Rules/Arrays/InvalidKeyInArrayDimFetchRule.php
@@ -7,7 +7,6 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\MixedType;
-use PHPStan\Type\TypeUtils;
 use PHPStan\Type\VerbosityLevel;
 use function count;
 use function sprintf;
@@ -34,7 +33,7 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$varType = $scope->getType($node->var);
-		if (count(TypeUtils::getAnyArrays($varType)) === 0) {
+		if (count($varType->getArrays()) === 0) {
 			return [];
 		}
 
diff --git a/src/Rules/Comparison/ImpossibleCheckTypeHelper.php b/src/Rules/Comparison/ImpossibleCheckTypeHelper.php
@@ -108,16 +108,30 @@ public function findSpecifiedType(
 					}
 
 					if (!$haystackType instanceof ConstantArrayType || count($haystackType->getValueTypes()) > 0) {
-						$haystackArrayTypes = TypeUtils::getArrays($haystackType);
+						$haystackArrayTypes = $haystackType->getArrays();
 						if (count($haystackArrayTypes) === 1 && $haystackArrayTypes[0]->getIterableValueType() instanceof NeverType) {
 							return null;
 						}
 
 						if ($isNeedleSupertype->maybe() || $isNeedleSupertype->yes()) {
 							foreach ($haystackArrayTypes as $haystackArrayType) {
-								foreach (TypeUtils::getConstantScalars($haystackArrayType->getIterableValueType()) as $constantScalarType) {
-									if ($constantScalarType->isSuperTypeOf($needleType)->yes()) {
-										continue 2;
+								if ($haystackArrayType instanceof ConstantArrayType) {
+									foreach ($haystackArrayType->getValueTypes() as $i => $haystackArrayValueType) {
+										if ($haystackArrayType->isOptionalKey($i)) {
+											continue;
+										}
+
+										foreach (TypeUtils::getConstantScalars($haystackArrayValueType) as $constantScalarType) {
+											if ($constantScalarType->isSuperTypeOf($needleType)->yes()) {
+												continue 3;
+											}
+										}
+									}
+								} else {
+									foreach (TypeUtils::getConstantScalars($haystackArrayType->getIterableValueType()) as $constantScalarType) {
+										if ($constantScalarType->isSuperTypeOf($needleType)->yes()) {
+											continue 2;
+										}
 									}
 								}
 
diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -44,6 +44,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getArrays(): array
+	{
+		return [];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -41,6 +41,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getArrays(): array
+	{
+		return [];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -40,6 +40,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getArrays(): array
+	{
+		return [];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -73,6 +73,11 @@ public function getReferencedClasses(): array
 		);
 	}
 
+	public function getArrays(): array
+	{
+		return [$this];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -100,6 +100,11 @@ public function getReferencedClasses(): array
 		return UnionTypeHelper::getReferencedClasses($this->types);
 	}
 
+	public function getArrays(): array
+	{
+		return UnionTypeHelper::getArrays($this->getTypes());
+	}
+
 	public function getConstantArrays(): array
 	{
 		return UnionTypeHelper::getConstantArrays($this->getTypes());
diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -63,6 +63,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getArrays(): array
+	{
+		return [];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/Php/ArrayFilterFunctionReturnTypeReturnTypeExtension.php b/src/Type/Php/ArrayFilterFunctionReturnTypeReturnTypeExtension.php
@@ -29,7 +29,6 @@
 use PHPStan\Type\StaticTypeFactory;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
-use PHPStan\Type\TypeUtils;
 use function array_map;
 use function count;
 use function is_string;
@@ -70,7 +69,7 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 
 		if ($callbackArg === null || ($callbackArg instanceof ConstFetch && strtolower($callbackArg->name->parts[0]) === 'null')) {
 			return TypeCombinator::union(
-				...array_map([$this, 'removeFalsey'], TypeUtils::getArrays($arrayArgType)),
+				...array_map([$this, 'removeFalsey'], $arrayArgType->getArrays()),
 			);
 		}
 
@@ -139,7 +138,7 @@ public function removeFalsey(Type $type): Type
 				if ($isFalsey->maybe()) {
 					$builder->setOffsetValueType($keys[$offset], TypeCombinator::remove($value, $falseyTypes), true);
 				} elseif ($isFalsey->no()) {
-					$builder->setOffsetValueType($keys[$offset], $value);
+					$builder->setOffsetValueType($keys[$offset], $value, $type->isOptionalKey($offset));
 				}
 			}
 
diff --git a/src/Type/Php/ArraySearchFunctionDynamicReturnTypeExtension.php b/src/Type/Php/ArraySearchFunctionDynamicReturnTypeExtension.php
@@ -14,7 +14,6 @@
 use PHPStan\Type\ObjectWithoutClassType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
-use PHPStan\Type\TypeUtils;
 use function count;
 
 final class ArraySearchFunctionDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
@@ -57,7 +56,7 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 			$typesFromConstantArrays[] = new NullType();
 		}
 
-		$haystackArrays = TypeUtils::getAnyArrays($haystackArgType);
+		$haystackArrays = $haystackArgType->getArrays();
 		if (count($haystackArrays) === 0) {
 			return ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
 		}
diff --git a/src/Type/StaticType.php b/src/Type/StaticType.php
@@ -104,6 +104,11 @@ public function getReferencedClasses(): array
 		return $this->getStaticObjectType()->getReferencedClasses();
 	}
 
+	public function getArrays(): array
+	{
+		return $this->getStaticObjectType()->getArrays();
+	}
+
 	public function getConstantArrays(): array
 	{
 		return $this->getStaticObjectType()->getConstantArrays();
diff --git a/src/Type/Traits/LateResolvableTypeTrait.php b/src/Type/Traits/LateResolvableTypeTrait.php
@@ -21,6 +21,11 @@ trait LateResolvableTypeTrait
 
 	private ?Type $result = null;
 
+	public function getArrays(): array
+	{
+		return $this->resolve()->getArrays();
+	}
+
 	public function getConstantArrays(): array
 	{
 		return $this->resolve()->getConstantArrays();
diff --git a/src/Type/Traits/MaybeArrayTypeTrait.php b/src/Type/Traits/MaybeArrayTypeTrait.php
@@ -7,6 +7,11 @@
 trait MaybeArrayTypeTrait
 {
 
+	public function getArrays(): array
+	{
+		return [];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/Traits/NonArrayTypeTrait.php b/src/Type/Traits/NonArrayTypeTrait.php
@@ -7,6 +7,11 @@
 trait NonArrayTypeTrait
 {
 
+	public function getArrays(): array
+	{
+		return [];
+	}
+
 	public function getConstantArrays(): array
 	{
 		return [];
diff --git a/src/Type/Type.php b/src/Type/Type.php
@@ -24,6 +24,9 @@ interface Type
 	 */
 	public function getReferencedClasses(): array;
 
+	/** @return list<ArrayType> */
+	public function getArrays(): array;
+
 	/** @return list<ConstantArrayType> */
 	public function getConstantArrays(): array;
 
diff --git a/src/Type/TypeUtils.php b/src/Type/TypeUtils.php
@@ -19,6 +19,8 @@ class TypeUtils
 
 	/**
 	 * @return ArrayType[]
+	 *
+	 * @deprecated Use PHPStan\Type\Type::getArrays() instead and handle optional ConstantArrayType keys if necessary.
 	 */
 	public static function getArrays(Type $type): array
 	{
@@ -123,6 +125,8 @@ public static function getAnyConstantTypes(Type $type): array
 
 	/**
 	 * @return ArrayType[]
+	 *
+	 * @deprecated Use PHPStan\Type\Type::getArrays() instead.
 	 */
 	public static function getAnyArrays(Type $type): array
 	{
diff --git a/src/Type/UnionType.php b/src/Type/UnionType.php
@@ -97,6 +97,11 @@ public function getReferencedClasses(): array
 		return UnionTypeHelper::getReferencedClasses($this->getTypes());
 	}
 
+	public function getArrays(): array
+	{
+		return UnionTypeHelper::getArrays($this->getTypes());
+	}
+
 	public function getConstantArrays(): array
 	{
 		return UnionTypeHelper::getConstantArrays($this->getTypes());
diff --git a/src/Type/UnionTypeHelper.php b/src/Type/UnionTypeHelper.php
@@ -32,6 +32,20 @@ public static function getReferencedClasses(array $types): array
 		);
 	}
 
+	/**
+	 * @param Type[] $types
+	 * @return list<ArrayType>
+	 */
+	public static function getArrays(array $types): array
+	{
+		return array_merge(
+			...array_map(
+				static fn (Type $type) => $type->getArrays(),
+				$types,
+			),
+		);
+	}
+
 	/**
 	 * @param Type[] $types
 	 * @return list<ConstantArrayType>

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`use PHPStan\Rules\Rule;`
`8`	`8`	`use PHPStan\Rules\RuleErrorBuilder;`
`9`	`9`	`use PHPStan\Type\MixedType;`
`10`		`-use PHPStan\Type\TypeUtils;`
`11`	`10`	`use PHPStan\Type\VerbosityLevel;`
`12`	`11`	`use function count;`
`13`	`12`	`use function sprintf;`
`@@ -34,7 +33,7 @@ public function processNode(Node $node, Scope $scope): array`
`34`	`33`	`}`
`35`	`34`
`36`	`35`	`$varType = $scope->getType($node->var);`
`37`		`- if (count(TypeUtils::getAnyArrays($varType)) === 0) {`
	`36`	`+ if (count($varType->getArrays()) === 0) {`
`38`	`37`	`return [];`
`39`	`38`	`}`
`40`	`39`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,11 @@ public function getReferencedClasses(): array`
`44`	`44`	`return [];`
`45`	`45`	`}`
`46`	`46`
	`47`	`+ public function getArrays(): array`
	`48`	`+ {`
	`49`	`+ return [];`
	`50`	`+ }`
	`51`	`+`
`47`	`52`	`public function getConstantArrays(): array`
`48`	`53`	`{`
`49`	`54`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,11 @@ public function getReferencedClasses(): array`
`41`	`41`	`return [];`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ public function getArrays(): array`
	`45`	`+ {`
	`46`	`+ return [];`
	`47`	`+ }`
	`48`	`+`
`44`	`49`	`public function getConstantArrays(): array`
`45`	`50`	`{`
`46`	`51`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,11 @@ public function getReferencedClasses(): array`
`40`	`40`	`return [];`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ public function getArrays(): array`
	`44`	`+ {`
	`45`	`+ return [];`
	`46`	`+ }`
	`47`	`+`
`43`	`48`	`public function getConstantArrays(): array`
`44`	`49`	`{`
`45`	`50`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,11 @@ public function getReferencedClasses(): array`
`73`	`73`	`);`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ public function getArrays(): array`
	`77`	`+ {`
	`78`	`+ return [$this];`
	`79`	`+ }`
	`80`	`+`
`76`	`81`	`public function getConstantArrays(): array`
`77`	`82`	`{`
`78`	`83`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,11 @@ public function getReferencedClasses(): array`
`100`	`100`	`return UnionTypeHelper::getReferencedClasses($this->types);`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ public function getArrays(): array`
	`104`	`+ {`
	`105`	`+ return UnionTypeHelper::getArrays($this->getTypes());`
	`106`	`+ }`
	`107`	`+`
`103`	`108`	`public function getConstantArrays(): array`
`104`	`109`	`{`
`105`	`110`	`return UnionTypeHelper::getConstantArrays($this->getTypes());`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,11 @@ public function getReferencedClasses(): array`
`63`	`63`	`return [];`
`64`	`64`	`}`
`65`	`65`
	`66`	`+ public function getArrays(): array`
	`67`	`+ {`
	`68`	`+ return [];`
	`69`	`+ }`
	`70`	`+`
`66`	`71`	`public function getConstantArrays(): array`
`67`	`72`	`{`
`68`	`73`	`return [];`