Implement getConstantStrings() on Type

phpstan · Nov 9, 2022 · 144304c · 144304c
1 parent f4a1214
commit 144304c
Show file tree

Hide file tree

Showing 63 changed files with 212 additions and 56 deletions.
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -2957,7 +2957,7 @@ private function expressionTypeIsUnchangeable(ExpressionTypeHolder $typeHolder):
 			&& $expr->name instanceof FullyQualified
 			&& $expr->name->toLowerString() === 'function_exists'
 			&& isset($expr->getArgs()[0])
-			&& count(TypeUtils::getConstantStrings($this->getType($expr->getArgs()[0]->value))) === 1
+			&& count($this->getType($expr->getArgs()[0]->value)->getConstantStrings()) === 1
 			&& (new ConstantBooleanType(true))->isSuperTypeOf($type)->yes();
 	}
 

diff --git a/src/Reflection/InitializerExprTypeResolver.php b/src/Reflection/InitializerExprTypeResolver.php
@@ -376,7 +376,7 @@ public function getConcatType(Expr $left, Expr $right, callable $getTypeCallback
 
 		// we limit the number of union-types for performance reasons
 		if ($leftStringType instanceof UnionType && count($leftStringType->getTypes()) <= 16 && $rightStringType instanceof ConstantStringType) {
-			$constantStrings = TypeUtils::getConstantStrings($leftStringType);
+			$constantStrings = $leftStringType->getConstantStrings();
 			if (count($constantStrings) > 0) {
 				$strings = [];
 				foreach ($constantStrings as $constantString) {
@@ -391,7 +391,7 @@ public function getConcatType(Expr $left, Expr $right, callable $getTypeCallback
 			}
 		}
 		if ($rightStringType instanceof UnionType && count($rightStringType->getTypes()) <= 16 && $leftStringType instanceof ConstantStringType) {
-			$constantStrings = TypeUtils::getConstantStrings($rightStringType);
+			$constantStrings = $rightStringType->getConstantStrings();
 			if (count($constantStrings) > 0) {
 				$strings = [];
 				foreach ($constantStrings as $constantString) {

diff --git a/src/Rules/Classes/InstantiationRule.php b/src/Rules/Classes/InstantiationRule.php
@@ -234,7 +234,7 @@ private function getClassNames(Node $node, Scope $scope): array
 		return array_merge(
 			array_map(
 				static fn (ConstantStringType $type): array => [$type->getValue(), true],
-				TypeUtils::getConstantStrings($type),
+				$type->getConstantStrings(),
 			),
 			array_map(
 				static fn (string $name): array => [$name, false],

diff --git a/src/Rules/DeadCode/UnusedPrivateMethodRule.php b/src/Rules/DeadCode/UnusedPrivateMethodRule.php
@@ -14,7 +14,6 @@
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
-use PHPStan\Type\TypeUtils;
 use function array_map;
 use function count;
 use function sprintf;
@@ -76,7 +75,7 @@ public function processNode(Node $node, Scope $scope): array
 				$methodNames = [$methodCallNode->name->toString()];
 			} else {
 				$methodNameType = $callScope->getType($methodCallNode->name);
-				$strings = TypeUtils::getConstantStrings($methodNameType);
+				$strings = $methodNameType->getConstantStrings();
 				if (count($strings) === 0) {
 					return [];
 				}

diff --git a/src/Rules/DeadCode/UnusedPrivatePropertyRule.php b/src/Rules/DeadCode/UnusedPrivatePropertyRule.php
@@ -13,7 +13,6 @@
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
-use PHPStan\Type\TypeUtils;
 use function array_key_exists;
 use function array_map;
 use function count;
@@ -125,7 +124,7 @@ public function processNode(Node $node, Scope $scope): array
 				$propertyNames = [$fetch->name->toString()];
 			} else {
 				$propertyNameType = $usage->getScope()->getType($fetch->name);
-				$strings = TypeUtils::getConstantStrings($propertyNameType);
+				$strings = $propertyNameType->getConstantStrings();
 				if (count($strings) === 0) {
 					return [];
 				}

diff --git a/src/Rules/Functions/PrintfParametersRule.php b/src/Rules/Functions/PrintfParametersRule.php
@@ -9,7 +9,6 @@
 use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\Type\TypeUtils;
 use function array_filter;
 use function count;
 use function in_array;
@@ -73,7 +72,7 @@ public function processNode(Node $node, Scope $scope): array
 
 		$formatArgType = $scope->getType($args[$formatArgumentPosition]->value);
 		$placeHoldersCount = null;
-		foreach (TypeUtils::getConstantStrings($formatArgType) as $formatString) {
+		foreach ($formatArgType->getConstantStrings() as $formatString) {
 			$format = $formatString->getValue();
 			$tempPlaceHoldersCount = $this->getPlaceholdersCount($name, $format);
 			if ($placeHoldersCount === null) {

diff --git a/src/Rules/Properties/AccessPropertiesRule.php b/src/Rules/Properties/AccessPropertiesRule.php
@@ -16,7 +16,6 @@
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
-use PHPStan\Type\TypeUtils;
 use PHPStan\Type\VerbosityLevel;
 use function array_map;
 use function array_merge;
@@ -48,7 +47,7 @@ public function processNode(Node $node, Scope $scope): array
 		if ($node->name instanceof Identifier) {
 			$names = [$node->name->name];
 		} else {
-			$names = array_map(static fn (ConstantStringType $type): string => $type->getValue(), TypeUtils::getConstantStrings($scope->getType($node->name)));
+			$names = array_map(static fn (ConstantStringType $type): string => $type->getValue(), $scope->getType($node->name)->getConstantStrings());
 		}
 
 		$errors = [];

diff --git a/src/Rules/Properties/AccessStaticPropertiesRule.php b/src/Rules/Properties/AccessStaticPropertiesRule.php
@@ -54,7 +54,7 @@ public function processNode(Node $node, Scope $scope): array
 		if ($node->name instanceof Node\VarLikeIdentifier) {
 			$names = [$node->name->name];
 		} else {
-			$names = array_map(static fn (ConstantStringType $type): string => $type->getValue(), TypeUtils::getConstantStrings($scope->getType($node->name)));
+			$names = array_map(static fn (ConstantStringType $type): string => $type->getValue(), $scope->getType($node->name)->getConstantStrings());
 		}
 
 		$errors = [];

diff --git a/src/Rules/Properties/PropertyReflectionFinder.php b/src/Rules/Properties/PropertyReflectionFinder.php
@@ -9,7 +9,6 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\Type;
-use PHPStan\Type\TypeUtils;
 use function array_map;
 
 class PropertyReflectionFinder
@@ -25,7 +24,7 @@ public function findPropertyReflectionsFromNode($propertyFetch, Scope $scope): a
 			if ($propertyFetch->name instanceof Node\Identifier) {
 				$names = [$propertyFetch->name->name];
 			} else {
-				$names = array_map(static fn (ConstantStringType $name): string => $name->getValue(), TypeUtils::getConstantStrings($scope->getType($propertyFetch->name)));
+				$names = array_map(static fn (ConstantStringType $name): string => $name->getValue(), $scope->getType($propertyFetch->name)->getConstantStrings());
 			}
 
 			$reflections = [];
@@ -58,7 +57,7 @@ public function findPropertyReflectionsFromNode($propertyFetch, Scope $scope): a
 		if ($propertyFetch->name instanceof VarLikeIdentifier) {
 			$names = [$propertyFetch->name->name];
 		} else {
-			$names = array_map(static fn (ConstantStringType $name): string => $name->getValue(), TypeUtils::getConstantStrings($scope->getType($propertyFetch->name)));
+			$names = array_map(static fn (ConstantStringType $name): string => $name->getValue(), $scope->getType($propertyFetch->name)->getConstantStrings());
 		}
 
 		$reflections = [];

diff --git a/src/Rules/Regexp/RegularExpressionPatternRule.php b/src/Rules/Regexp/RegularExpressionPatternRule.php
@@ -10,7 +10,6 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\Constant\ConstantStringType;
-use PHPStan\Type\TypeUtils;
 use function in_array;
 use function sprintf;
 use function str_starts_with;
@@ -65,7 +64,7 @@ private function extractPatterns(FuncCall $functionCall, Scope $scope): array
 
 		$patternStrings = [];
 
-		foreach (TypeUtils::getConstantStrings($patternType) as $constantStringType) {
+		foreach ($patternType->getConstantStrings() as $constantStringType) {
 			if (
 				!in_array($functionName, [
 					'preg_match',

diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -55,6 +55,11 @@ public function getConstantArrays(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -46,6 +46,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof MixedType) {

diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -46,6 +46,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/AccessoryNonFalsyStringType.php b/src/Type/Accessory/AccessoryNonFalsyStringType.php
@@ -47,6 +47,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -46,6 +46,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -58,6 +58,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -57,6 +57,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/HasPropertyType.php b/src/Type/Accessory/HasPropertyType.php
@@ -39,6 +39,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function getPropertyName(): string
 	{
 		return $this->propertyName;

diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -52,6 +52,11 @@ public function getConstantArrays(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -51,6 +51,11 @@ public function getConstantArrays(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType) {

diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -38,6 +38,11 @@ public function __construct()
 	{
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function describe(VerbosityLevel $level): string
 	{
 		return 'bool';

diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -74,6 +74,11 @@ public function getReferencedClasses(): array
 		return array_merge($classes, $this->returnType->getReferencedClasses());
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof CompoundType && !$type instanceof self) {

diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -230,6 +230,11 @@ public function getConstant(string $constantName): ConstantReflection
 		return $this->objectType->getConstant($constantName);
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function isIterable(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/Constant/ConstantStringType.php b/src/Type/Constant/ConstantStringType.php
@@ -64,6 +64,11 @@ public function getValue(): string
 		return $this->value;
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [$this];
+	}
+
 	public function isClassStringType(): TrinaryLogic
 	{
 		if ($this->isClassString) {

diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -46,6 +46,11 @@ public function getReferencedClasses(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type instanceof self || $type->isInteger()->yes()) {

diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -41,6 +41,11 @@ public function describe(VerbosityLevel $level): string
 		return 'int';
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -111,6 +111,11 @@ public function getConstantArrays(): array
 		return UnionTypeHelper::getConstantArrays($this->getTypes());
 	}
 
+	public function getConstantStrings(): array
+	{
+		return UnionTypeHelper::getConstantStrings($this->getTypes());
+	}
+
 	public function accepts(Type $otherType, bool $strictTypes): TrinaryLogic
 	{
 		foreach ($this->types as $type) {

diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -60,6 +60,11 @@ public function getReferencedClasses(): array
 		);
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		if ($type->isConstantArray()->yes() && $type->isIterableAtLeastOnce()->no()) {

diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -73,6 +73,11 @@ public function getConstantArrays(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		return TrinaryLogic::createYes();

diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -56,6 +56,11 @@ public function getConstantArrays(): array
 		return [];
 	}
 
+	public function getConstantStrings(): array
+	{
+		return [];
+	}
+
 	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
 	{
 		return TrinaryLogic::createYes();