Allow setting types for dynamic constants

ssigwart · ssigwart · commit f18c7a9f3ec1 · 2024-10-27T13:01:35.000-04:00
diff --git a/src/Analyser/ConstantResolver.php b/src/Analyser/ConstantResolver.php
@@ -302,8 +302,14 @@ public function resolvePredefinedConstant(string $resolvedConstantName): ?Type
 
 	public function resolveConstantType(string $constantName, Type $constantType): Type
 	{
-		if ($constantType->isConstantValue()->yes() && in_array($constantName, $this->dynamicConstantNames, true)) {
-			return $constantType->generalize(GeneralizePrecision::lessSpecific());
+		if ($constantType->isConstantValue()->yes()) {
+			if (array_key_exists($constantName, $this->dynamicConstantNames)) {
+				$phpdocTypes = $this->dynamicConstantNames[$constantName];
+				return $this->reflectionProviderProvider->getReflectionProvider()->getSignatureMapProvider()->getTypeFromString($phpdocTypes, null);
+			}
+			if (in_array($constantName, $this->dynamicConstantNames, true)) {
+				return $constantType->generalize(GeneralizePrecision::lessSpecific());
+			}
 		}
 
 		return $constantType;
@@ -312,6 +318,17 @@ public function resolveConstantType(string $constantName, Type $constantType): T
 	public function resolveClassConstantType(string $className, string $constantName, Type $constantType, ?Type $nativeType): Type
 	{
 		$lookupConstantName = sprintf('%s::%s', $className, $constantName);
+		if (array_key_exists($lookupConstantName, $this->dynamicConstantNames)) {
+			if ($nativeType !== null) {
+				return $nativeType;
+			}
+
+			if ($constantType->isConstantValue()->yes()) {
+				$phpdocTypes = $this->dynamicConstantNames[$lookupConstantName];
+				return $this->getReflectionProvider()->getSignatureMapProvider()->getTypeFromString($phpdocTypes, $className);
+			}
+		}
+
 		if (in_array($lookupConstantName, $this->dynamicConstantNames, true)) {
 			if ($nativeType !== null) {
 				return $nativeType;
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -5701,6 +5701,11 @@ public function getConstantReflection(Type $typeWithConstant, string $constantNa
 		return $typeWithConstant->getConstant($constantName);
 	}
 
+	public function getConstantExplicitTypeFromConfig(string $constantName, Type $constantType): ?Type
+	{
+		return $this->constantResolver->resolveConstantType($constantName, $constantType);
+	}
+
 	/**
 	 * @return array<string, ExpressionTypeHolder>
 	 */
diff --git a/src/Analyser/Scope.php b/src/Analyser/Scope.php
@@ -80,6 +80,8 @@ public function getMethodReflection(Type $typeWithMethod, string $methodName): ?
 
 	public function getConstantReflection(Type $typeWithConstant, string $constantName): ?ClassConstantReflection;
 
+	public function getConstantExplicitTypeFromConfig(string $constantName, Type $constantType): ?Type;
+
 	public function getIterableKeyType(Type $iteratee): Type;
 
 	public function getIterableValueType(Type $iteratee): Type;
diff --git a/src/Reflection/BetterReflection/BetterReflectionProvider.php b/src/Reflection/BetterReflection/BetterReflectionProvider.php
@@ -475,4 +475,9 @@ private function resolveName(
 		return null;
 	}
 
+	public function getSignatureMapProvider(): SignatureMapProvider
+	{
+		return $this->signatureMapProvider;
+	}
+
 }
diff --git a/src/Reflection/ClassReflection.php b/src/Reflection/ClassReflection.php
@@ -177,6 +177,11 @@ public function getNativeReflection(): ReflectionClass|ReflectionEnum
 		return $this->reflection;
 	}
 
+	public function getSignatureMapProvider(): SignatureMapProvider
+	{
+		return $this->signatureMapProvider;
+	}
+
 	public function getFileName(): ?string
 	{
 		if (!is_bool($this->filename)) {
diff --git a/src/Reflection/ReflectionProvider.php b/src/Reflection/ReflectionProvider.php
@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\SignatureMap\SignatureMapProvider;
 
 /** @api */
 interface ReflectionProvider
@@ -36,4 +37,6 @@ public function getConstant(Node\Name $nameNode, ?NamespaceAnswerer $namespaceAn
 
 	public function resolveConstantName(Node\Name $nameNode, ?NamespaceAnswerer $namespaceAnswerer): ?string;
 
+	public function getSignatureMapProvider(): SignatureMapProvider;
+
 }
diff --git a/src/Reflection/ReflectionProvider/DummyReflectionProvider.php b/src/Reflection/ReflectionProvider/DummyReflectionProvider.php
@@ -9,6 +9,7 @@
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\NamespaceAnswerer;
 use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Reflection\SignatureMap\SignatureMapProvider;
 use PHPStan\ShouldNotHappenException;
 
 final class DummyReflectionProvider implements ReflectionProvider
@@ -69,4 +70,8 @@ public function resolveConstantName(Node\Name $nameNode, ?NamespaceAnswerer $nam
 		return null;
 	}
 
+	public function getSignatureMapProvider(): SignatureMapProvider
+	{
+		throw new ShouldNotHappenException();
+	}
 }
diff --git a/src/Reflection/ReflectionProvider/MemoizingReflectionProvider.php b/src/Reflection/ReflectionProvider/MemoizingReflectionProvider.php
@@ -9,6 +9,8 @@
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\NamespaceAnswerer;
 use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Reflection\SignatureMap\SignatureMapProvider;
+
 use function strtolower;
 
 final class MemoizingReflectionProvider implements ReflectionProvider
@@ -96,4 +98,9 @@ public function resolveConstantName(Node\Name $nameNode, ?NamespaceAnswerer $nam
 		return $this->provider->resolveConstantName($nameNode, $namespaceAnswerer);
 	}
 
+	public function getSignatureMapProvider(): SignatureMapProvider
+	{
+		return $this->provider->getSignatureMapProvider();
+	}
+
 }
diff --git a/src/Reflection/SignatureMap/FunctionSignatureMapProvider.php b/src/Reflection/SignatureMap/FunctionSignatureMapProvider.php
@@ -9,6 +9,7 @@
 use PHPStan\Reflection\InitializerExprTypeResolver;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\Type;
 use PHPStan\Type\TypehintHelper;
 use ReflectionFunctionAbstract;
 use function array_change_key_case;
@@ -259,4 +260,8 @@ public function getClassConstantMetadata(string $className, string $constantName
 		throw new ShouldNotHappenException();
 	}
 
+	public function getTypeFromString(string $typeString, ?string $className): Type
+	{
+		return $this->parser->getTypeFromString($typeString, $className);
+	}
 }
diff --git a/src/Reflection/SignatureMap/Php8SignatureMapProvider.php b/src/Reflection/SignatureMap/Php8SignatureMapProvider.php
@@ -499,4 +499,8 @@ private function findConstantType(string $className, string $constantName): ?Typ
 		return null;
 	}
 
+	public function getTypeFromString(string $typeString, ?string $className): Type
+	{
+		return $this->functionSignatureMapProvider->getTypeFromString($typeString, $className);
+	}
 }
diff --git a/src/Reflection/SignatureMap/SignatureMapParser.php b/src/Reflection/SignatureMap/SignatureMapParser.php
@@ -46,7 +46,7 @@ public function getFunctionSignature(array $map, ?string $className): FunctionSi
 		);
 	}
 
-	private function getTypeFromString(string $typeString, ?string $className): Type
+	public function getTypeFromString(string $typeString, ?string $className): Type
 	{
 		if ($typeString === '') {
 			return new MixedType(true);
diff --git a/src/Reflection/SignatureMap/SignatureMapProvider.php b/src/Reflection/SignatureMap/SignatureMapProvider.php
@@ -40,4 +40,5 @@ public function hasClassConstantMetadata(string $className, string $constantName
 	 */
 	public function getClassConstantMetadata(string $className, string $constantName): array;
 
+	public function getTypeFromString(string $typeString, ?string $className): Type;
 }
diff --git a/src/Type/Php/DefineConstantTypeSpecifyingExtension.php b/src/Type/Php/DefineConstantTypeSpecifyingExtension.php
@@ -50,11 +50,16 @@ public function specifyTypes(
 			return new SpecifiedTypes([], []);
 		}
 
+		$finalType = $scope->getConstantExplicitTypeFromConfig(
+			$constantName->getValue(),
+			$scope->getType($node->getArgs()[1]->value),
+		);
+
 		return $this->typeSpecifier->create(
 			new Node\Expr\ConstFetch(
 				new Node\Name\FullyQualified($constantName->getValue()),
 			),
-			$scope->getType($node->getArgs()[1]->value),
+			$finalType,
 			TypeSpecifierContext::createTruthy(),
 			$scope,
 		)->setAlwaysOverwriteTypes();
diff --git a/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php b/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
@@ -8450,6 +8450,10 @@ public function dataDynamicConstants(): array
 				'string',
 				'DynamicConstants\DynamicConstantClass::DYNAMIC_CONSTANT_IN_CLASS',
 			],
+			[
+				'string|null',
+				'DynamicConstants\DynamicConstantClass::DYNAMIC_CONSTANT_WITH_EXPLICIT_TYPES_IN_CLASS',
+			],
 			[
 				"'abc123def'",
 				'DynamicConstants\DynamicConstantClass::PURE_CONSTANT_IN_CLASS',
@@ -8459,13 +8463,17 @@ public function dataDynamicConstants(): array
 				'DynamicConstants\NoDynamicConstantClass::DYNAMIC_CONSTANT_IN_CLASS',
 			],
 			[
-				'false',
+				'bool',
 				'GLOBAL_DYNAMIC_CONSTANT',
 			],
 			[
 				'123',
 				'GLOBAL_PURE_CONSTANT',
 			],
+			[
+				'string|null',
+				'GLOBAL_DYNAMIC_CONSTANT_WITH_EXPLICIT_TYPES',
+			],
 		];
 	}
 
@@ -8485,6 +8493,8 @@ public function testDynamicConstants(
 			[
 				'DynamicConstants\\DynamicConstantClass::DYNAMIC_CONSTANT_IN_CLASS',
 				'GLOBAL_DYNAMIC_CONSTANT',
+				'DynamicConstants\\DynamicConstantClass::DYNAMIC_CONSTANT_WITH_EXPLICIT_TYPES_IN_CLASS' => 'string|null',
+				'GLOBAL_DYNAMIC_CONSTANT_WITH_EXPLICIT_TYPES' => 'string|null'
 			],
 		);
 	}
diff --git a/tests/PHPStan/Analyser/data/dynamic-constant.php b/tests/PHPStan/Analyser/data/dynamic-constant.php
@@ -4,10 +4,12 @@
 
 define('GLOBAL_PURE_CONSTANT', 123);
 define('GLOBAL_DYNAMIC_CONSTANT', false);
+define('GLOBAL_DYNAMIC_CONSTANT_WITH_EXPLICIT_TYPES', null);
 
 class DynamicConstantClass
 {
 	const DYNAMIC_CONSTANT_IN_CLASS = 'abcdef';
+	const DYNAMIC_CONSTANT_WITH_EXPLICIT_TYPES_IN_CLASS = 'xyz';
 	const PURE_CONSTANT_IN_CLASS = 'abc123def';
 }
 

Original file line number	Diff line number	Diff line change
`@@ -475,4 +475,9 @@ private function resolveName(`
`475`	`475`	`return null;`
`476`	`476`	`}`
`477`	`477`
	`478`	`+ public function getSignatureMapProvider(): SignatureMapProvider`
	`479`	`+ {`
	`480`	`+ return $this->signatureMapProvider;`
	`481`	`+ }`
	`482`	`+`
`478`	`483`	`}`
Original file line number	Diff line number	Diff line change
`@@ -177,6 +177,11 @@ public function getNativeReflection(): ReflectionClass\|ReflectionEnum`
`177`	`177`	`return $this->reflection;`
`178`	`178`	`}`
`179`	`179`
	`180`	`+ public function getSignatureMapProvider(): SignatureMapProvider`
	`181`	`+ {`
	`182`	`+ return $this->signatureMapProvider;`
	`183`	`+ }`
	`184`	`+`
`180`	`185`	`public function getFileName(): ?string`
`181`	`186`	`{`
`182`	`187`	`if (!is_bool($this->filename)) {`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use PHPStan\Reflection\FunctionReflection;`
`10`	`10`	`use PHPStan\Reflection\NamespaceAnswerer;`
`11`	`11`	`use PHPStan\Reflection\ReflectionProvider;`
	`12`	`+use PHPStan\Reflection\SignatureMap\SignatureMapProvider;`
`12`	`13`	`use PHPStan\ShouldNotHappenException;`
`13`	`14`
`14`	`15`	`final class DummyReflectionProvider implements ReflectionProvider`
`@@ -69,4 +70,8 @@ public function resolveConstantName(Node\Name $nameNode, ?NamespaceAnswerer $nam`
`69`	`70`	`return null;`
`70`	`71`	`}`
`71`	`72`
	`73`	`+ public function getSignatureMapProvider(): SignatureMapProvider`
	`74`	`+ {`
	`75`	`+ throw new ShouldNotHappenException();`
	`76`	`+ }`
`72`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -499,4 +499,8 @@ private function findConstantType(string $className, string $constantName): ?Typ`
`499`	`499`	`return null;`
`500`	`500`	`}`
`501`	`501`
	`502`	`+ public function getTypeFromString(string $typeString, ?string $className): Type`
	`503`	`+ {`
	`504`	`+ return $this->functionSignatureMapProvider->getTypeFromString($typeString, $className);`
	`505`	`+ }`
`502`	`506`	`}`