[BCB] ConstantReflection

UPGRADING.md

@@ -293,3 +293,8 @@ Instead of `PHPStanTestCase::createBroker()`, call `PHPStanTestCase::createRefle
 * Remove `Type::acceptsWithReason()`, `Type:accepts()` return type changed from `TrinaryLogic` to [`AcceptsResult`](https://apiref.phpstan.org/2.0.x/PHPStan.Type.AcceptsResult.html)
 * Remove `CompoundType::isAcceptedWithReasonBy()`, `CompoundType::isAcceptedBy()` return type changed from `TrinaryLogic` to [`AcceptsResult`](https://apiref.phpstan.org/2.0.x/PHPStan.Type.AcceptsResult.html)
 * `RuleLevelHelper::accepts()` return type changed from `bool` to [`RuleLevelHelperAcceptsResult`](https://apiref.phpstan.org/2.0.x/PHPStan.Type.AcceptsResult.html)
+* Changes around `ClassConstantReflection`
+  * Class `ClassConstantReflection` removed from BC promise, renamed to `RealClassConstantReflection`
+  * Interface `ConstantReflection` renamed to `ClassConstantReflection`
+  * Added more methods around PHPDoc types and native types to the (new) `ClassConstantReflection`
+  * Interface `GlobalConstantReflection` renamed to `ConstantReflection`

src/Analyser/MutatingScope.php

@@ -52,9 +52,9 @@
 use PHPStan\Reflection\Callables\CallableParametersAcceptor;
 use PHPStan\Reflection\Callables\SimpleImpurePoint;
 use PHPStan\Reflection\Callables\SimpleThrowPoint;
+use PHPStan\Reflection\ClassConstantReflection;
 use PHPStan\Reflection\ClassMemberReflection;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\Dummy\DummyConstructorReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\ExtendedPropertyReflection;
@@ -5326,7 +5326,7 @@ public function canCallMethod(MethodReflection $methodReflection): bool
 	}
 
 	/** @api */
-	public function canAccessConstant(ConstantReflection $constantReflection): bool
+	public function canAccessConstant(ClassConstantReflection $constantReflection): bool
 	{
 		return $this->canAccessClassMember($constantReflection);
 	}
@@ -5690,7 +5690,7 @@ private function propertyFetchType(Type $fetchedOnType, string $propertyName, Ex
 		return $propertyReflection->getReadableType();
 	}
 
-	public function getConstantReflection(Type $typeWithConstant, string $constantName): ?ConstantReflection
+	public function getConstantReflection(Type $typeWithConstant, string $constantName): ?ClassConstantReflection
 	{
 		if ($typeWithConstant instanceof UnionType) {
 			$newTypes = [];

src/Analyser/OutOfClassScope.php

@@ -2,9 +2,9 @@
 
 namespace PHPStan\Analyser;
 
+use PHPStan\Reflection\ClassConstantReflection;
 use PHPStan\Reflection\ClassMemberAccessAnswerer;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\PropertyReflection;
 
@@ -36,7 +36,7 @@ public function canCallMethod(MethodReflection $methodReflection): bool
 		return $methodReflection->isPublic();
 	}
 
-	public function canAccessConstant(ConstantReflection $constantReflection): bool
+	public function canAccessConstant(ClassConstantReflection $constantReflection): bool
 	{
 		return $constantReflection->isPublic();
 	}

src/Analyser/Scope.php

@@ -6,9 +6,9 @@
 use PhpParser\Node\Expr;
 use PhpParser\Node\Name;
 use PhpParser\Node\Param;
+use PHPStan\Reflection\ClassConstantReflection;
 use PHPStan\Reflection\ClassMemberAccessAnswerer;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\ExtendedPropertyReflection;
 use PHPStan\Reflection\FunctionReflection;
@@ -73,7 +73,7 @@ public function getPropertyReflection(Type $typeWithProperty, string $propertyNa
 
 	public function getMethodReflection(Type $typeWithMethod, string $methodName): ?ExtendedMethodReflection;
 
-	public function getConstantReflection(Type $typeWithConstant, string $constantName): ?ConstantReflection;
+	public function getConstantReflection(Type $typeWithConstant, string $constantName): ?ClassConstantReflection;
 
 	public function getIterableKeyType(Type $iteratee): Type;
 

src/PhpDoc/PhpDocBlock.php

@@ -3,8 +3,8 @@
 namespace PHPStan\PhpDoc;
 
 use PHPStan\PhpDoc\Tag\AssertTagParameter;
+use PHPStan\Reflection\ClassConstantReflection;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\Php\PhpMethodReflection;
 use PHPStan\Reflection\Php\PhpPropertyReflection;
@@ -334,7 +334,7 @@ private static function resolvePhpDocBlockFromClass(
 	): ?self
 	{
 		if ($classReflection->$hasMethodName($name)) {
-			/** @var PropertyReflection|MethodReflection|ConstantReflection $parentReflection */
+			/** @var PropertyReflection|MethodReflection|ClassConstantReflection $parentReflection */
 			$parentReflection = $classReflection->$getMethodName($name);
 			if ($parentReflection->isPrivate()) {
 				return null;

src/Reflection/BetterReflection/BetterReflectionProvider.php

@@ -34,9 +34,9 @@
 use PHPStan\Reflection\ClassNameHelper;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\Constant\RuntimeConstantReflection;
+use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\FunctionReflectionFactory;
-use PHPStan\Reflection\GlobalConstantReflection;
 use PHPStan\Reflection\InitializerExprContext;
 use PHPStan\Reflection\InitializerExprTypeResolver;
 use PHPStan\Reflection\NamespaceAnswerer;
@@ -71,7 +71,7 @@ final class BetterReflectionProvider implements ReflectionProvider
 	/** @var ClassReflection[] */
 	private static array $anonymousClasses = [];
 
-	/** @var array<string, GlobalConstantReflection> */
+	/** @var array<string, ConstantReflection> */
 	private array $cachedConstants = [];
 
 	/**
@@ -389,7 +389,7 @@ public function hasConstant(Node\Name $nameNode, ?NamespaceAnswerer $namespaceAn
 		return $this->resolveConstantName($nameNode, $namespaceAnswerer) !== null;
 	}
 
-	public function getConstant(Node\Name $nameNode, ?NamespaceAnswerer $namespaceAnswerer): GlobalConstantReflection
+	public function getConstant(Node\Name $nameNode, ?NamespaceAnswerer $namespaceAnswerer): ConstantReflection
 	{
 		$constantName = $this->resolveConstantName($nameNode, $namespaceAnswerer);
 		if ($constantName === null) {

src/Reflection/ClassConstantReflection.php

@@ -3,141 +3,22 @@
 namespace PHPStan\Reflection;
 
 use PhpParser\Node\Expr;
-use PHPStan\BetterReflection\Reflection\Adapter\ReflectionClassConstant;
-use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
-use PHPStan\Type\TypehintHelper;
 
-/**
- * @api
- */
-final class ClassConstantReflection implements ConstantReflection
+/** @api */
+interface ClassConstantReflection extends ClassMemberReflection, ConstantReflection
 {
 
-	private ?Type $valueType = null;
+	public function getValueExpr(): Expr;
 
-	public function __construct(
-		private InitializerExprTypeResolver $initializerExprTypeResolver,
-		private ClassReflection $declaringClass,
-		private ReflectionClassConstant $reflection,
-		private ?Type $nativeType,
-		private ?Type $phpDocType,
-		private ?string $deprecatedDescription,
-		private bool $isDeprecated,
-		private bool $isInternal,
-	)
-	{
-	}
+	public function isFinal(): bool;
 
-	public function getName(): string
-	{
-		return $this->reflection->getName();
-	}
+	public function hasPhpDocType(): bool;
 
-	public function getFileName(): ?string
-	{
-		return $this->declaringClass->getFileName();
-	}
+	public function getPhpDocType(): ?Type;
 
-	public function getValueExpr(): Expr
-	{
-		return $this->reflection->getValueExpression();
-	}
+	public function hasNativeType(): bool;
 
-	public function hasPhpDocType(): bool
-	{
-		return $this->phpDocType !== null;
-	}
-
-	public function getPhpDocType(): ?Type
-	{
-		return $this->phpDocType;
-	}
-
-	public function hasNativeType(): bool
-	{
-		return $this->nativeType !== null;
-	}
-
-	public function getNativeType(): ?Type
-	{
-		return $this->nativeType;
-	}
-
-	public function getValueType(): Type
-	{
-		if ($this->valueType === null) {
-			if ($this->phpDocType !== null) {
-				if ($this->nativeType !== null) {
-					return $this->valueType = TypehintHelper::decideType(
-						$this->nativeType,
-						$this->phpDocType,
-					);
-				}
-
-				return $this->phpDocType;
-			} elseif ($this->nativeType !== null) {
-				return $this->nativeType;
-			}
-
-			$this->valueType = $this->initializerExprTypeResolver->getType($this->getValueExpr(), InitializerExprContext::fromClassReflection($this->declaringClass));
-		}
-
-		return $this->valueType;
-	}
-
-	public function getDeclaringClass(): ClassReflection
-	{
-		return $this->declaringClass;
-	}
-
-	public function isStatic(): bool
-	{
-		return true;
-	}
-
-	public function isPrivate(): bool
-	{
-		return $this->reflection->isPrivate();
-	}
-
-	public function isPublic(): bool
-	{
-		return $this->reflection->isPublic();
-	}
-
-	public function isFinal(): bool
-	{
-		return $this->reflection->isFinal();
-	}
-
-	public function isDeprecated(): TrinaryLogic
-	{
-		return TrinaryLogic::createFromBoolean($this->isDeprecated);
-	}
-
-	public function getDeprecatedDescription(): ?string
-	{
-		if ($this->isDeprecated) {
-			return $this->deprecatedDescription;
-		}
-
-		return null;
-	}
-
-	public function isInternal(): TrinaryLogic
-	{
-		return TrinaryLogic::createFromBoolean($this->isInternal);
-	}
-
-	public function getDocComment(): ?string
-	{
-		$docComment = $this->reflection->getDocComment();
-		if ($docComment === false) {
-			return null;
-		}
-
-		return $docComment;
-	}
+	public function getNativeType(): ?Type;
 
 }

src/Reflection/ClassMemberAccessAnswerer.php

@@ -17,6 +17,6 @@ public function canAccessProperty(PropertyReflection $propertyReflection): bool;
 
 	public function canCallMethod(MethodReflection $methodReflection): bool;
 
-	public function canAccessConstant(ConstantReflection $constantReflection): bool;
+	public function canAccessConstant(ClassConstantReflection $constantReflection): bool;
 
 }

src/Reflection/ClassReflection.php

@@ -81,7 +81,7 @@ final class ClassReflection
 	/** @var ExtendedPropertyReflection[] */
 	private array $properties = [];
 
-	/** @var ClassConstantReflection[] */
+	/** @var RealClassClassConstantReflection[] */
 	private array $constants = [];
 
 	/** @var EnumCaseReflection[]|null  */
@@ -1082,7 +1082,7 @@ public function getConstant(string $name): ClassConstantReflection
 				$nativeType = $this->signatureMapProvider->getClassConstantMetadata($declaringClass->getName(), $name)['nativeType'];
 			}
 
-			$this->constants[$name] = new ClassConstantReflection(
+			$this->constants[$name] = new RealClassClassConstantReflection(
 				$this->initializerExprTypeResolver,
 				$declaringClass,
 				$reflectionConstant,

src/Reflection/Constant/RuntimeConstantReflection.php

@@ -2,11 +2,11 @@
 
 namespace PHPStan\Reflection\Constant;
 
-use PHPStan\Reflection\GlobalConstantReflection;
+use PHPStan\Reflection\ConstantReflection;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
 
-final class RuntimeConstantReflection implements GlobalConstantReflection
+final class RuntimeConstantReflection implements ConstantReflection
 {
 
 	public function __construct(

src/Reflection/ConstantReflection.php

@@ -2,12 +2,23 @@
 
 namespace PHPStan\Reflection;
 
-use PhpParser\Node\Expr;
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\Type;
 
 /** @api */
-interface ConstantReflection extends ClassMemberReflection, GlobalConstantReflection
+interface ConstantReflection
 {
 
-	public function getValueExpr(): Expr;
+	public function getName(): string;
+
+	public function getValueType(): Type;
+
+	public function isDeprecated(): TrinaryLogic;
+
+	public function getDeprecatedDescription(): ?string;
+
+	public function isInternal(): TrinaryLogic;
+
+	public function getFileName(): ?string;
 
 }

src/Reflection/Dummy/DummyConstantReflection.php → src/Reflection/Dummy/DummyClassConstantReflection.php

@@ -4,15 +4,15 @@
 
 use PhpParser\Node\Expr;
 use PHPStan\Node\Expr\TypeExpr;
+use PHPStan\Reflection\ClassConstantReflection;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\ReflectionProviderStaticAccessor;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 use stdClass;
 
-final class DummyConstantReflection implements ConstantReflection
+final class DummyClassConstantReflection implements ClassConstantReflection
 {
 
 	public function __construct(private string $name)
@@ -26,6 +26,11 @@ public function getDeclaringClass(): ClassReflection
 		return $reflectionProvider->getClass(stdClass::class);
 	}
 
+	public function isFinal(): bool
+	{
+		return false;
+	}
+
 	public function getFileName(): ?string
 	{
 		return null;
@@ -81,4 +86,24 @@ public function getDocComment(): ?string
 		return null;
 	}
 
+	public function hasPhpDocType(): bool
+	{
+		return false;
+	}
+
+	public function getPhpDocType(): ?Type
+	{
+		return null;
+	}
+
+	public function hasNativeType(): bool
+	{
+		return false;
+	}
+
+	public function getNativeType(): ?Type
+	{
+		return null;
+	}
+
 }