Add extensible ClassReflection::getAllowedSubTypes()

conf/config.level0.neon

@@ -34,6 +34,7 @@ rules:
 	- PHPStan\Rules\Arrays\EmptyArrayItemRule
 	- PHPStan\Rules\Arrays\OffsetAccessWithoutDimForReadingRule
 	- PHPStan\Rules\Cast\UnsetCastRule
+	- PHPStan\Rules\Classes\AllowedSubTypesRule
 	- PHPStan\Rules\Classes\ClassAttributesRule
 	- PHPStan\Rules\Classes\ClassConstantAttributesRule
 	- PHPStan\Rules\Classes\ClassConstantRule

conf/config.neon

@@ -840,6 +840,11 @@ services:
 		tags:
 			- phpstan.broker.methodsClassReflectionExtension
 
+	-
+		class: PHPStan\Reflection\Php\EnumAllowedSubTypesClassReflectionExtension
+		tags:
+			- phpstan.broker.allowedSubTypesClassReflectionExtension
+
 	-
 		class: PHPStan\Reflection\Php\UniversalObjectCratesClassReflectionExtension
 		tags:

phpstan-baseline.neon

@@ -34,7 +34,7 @@ parameters:
 			path: src/Analyser/MutatingScope.php
 
 		-
-			message: "#^Parameter \\#10 \\$reflection of class PHPStan\\\\Reflection\\\\ClassReflection constructor expects PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionClass\\|PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum, object given\\.$#"
+			message: "#^Parameter \\#11 \\$reflection of class PHPStan\\\\Reflection\\\\ClassReflection constructor expects PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionClass\\|PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum, object given\\.$#"
 			count: 1
 			path: src/Analyser/NodeScopeResolver.php
 
@@ -192,7 +192,7 @@ parameters:
 			path: src/Reflection/BetterReflection/BetterReflectionProvider.php
 
 		-
-			message: "#^Parameter \\#10 \\$reflection of class PHPStan\\\\Reflection\\\\ClassReflection constructor expects PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionClass\\|PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum, object given\\.$#"
+			message: "#^Parameter \\#11 \\$reflection of class PHPStan\\\\Reflection\\\\ClassReflection constructor expects PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionClass\\|PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum, object given\\.$#"
 			count: 1
 			path: src/Reflection/BetterReflection/BetterReflectionProvider.php
 

src/Analyser/NodeScopeResolver.php

@@ -1524,6 +1524,7 @@ private function createAstClassReflection(Node\Stmt\ClassLike $stmt, string $cla
 			$this->phpVersion,
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getPropertiesClassReflectionExtensions(),
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getMethodsClassReflectionExtensions(),
+			$this->classReflectionExtensionRegistryProvider->getRegistry()->getAllowedSubTypesClassReflectionExtensions(),
 			$betterReflectionClass->getName(),
 			$betterReflectionClass instanceof ReflectionEnum && PHP_VERSION_ID >= 80000 ? new $enumAdapter($betterReflectionClass) : new ReflectionClass($betterReflectionClass),
 			null,

src/Broker/BrokerFactory.php

@@ -10,6 +10,7 @@ class BrokerFactory
 
 	public const PROPERTIES_CLASS_REFLECTION_EXTENSION_TAG = 'phpstan.broker.propertiesClassReflectionExtension';
 	public const METHODS_CLASS_REFLECTION_EXTENSION_TAG = 'phpstan.broker.methodsClassReflectionExtension';
+	public const ALLOWED_SUB_TYPES_CLASS_REFLECTION_EXTENSION_TAG = 'phpstan.broker.allowedSubTypesClassReflectionExtension';
 	public const DYNAMIC_METHOD_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicMethodReturnTypeExtension';
 	public const DYNAMIC_STATIC_METHOD_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicStaticMethodReturnTypeExtension';
 	public const DYNAMIC_FUNCTION_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicFunctionReturnTypeExtension';

src/DependencyInjection/Reflection/DirectClassReflectionExtensionRegistryProvider.php

@@ -3,6 +3,7 @@
 namespace PHPStan\DependencyInjection\Reflection;
 
 use PHPStan\Broker\Broker;
+use PHPStan\Reflection\AllowedSubTypesClassReflectionExtension;
 use PHPStan\Reflection\ClassReflectionExtensionRegistry;
 use PHPStan\Reflection\MethodsClassReflectionExtension;
 use PHPStan\Reflection\PropertiesClassReflectionExtension;
@@ -18,10 +19,12 @@ class DirectClassReflectionExtensionRegistryProvider implements ClassReflectionE
 	/**
 	 * @param PropertiesClassReflectionExtension[] $propertiesClassReflectionExtensions
 	 * @param MethodsClassReflectionExtension[] $methodsClassReflectionExtensions
+	 * @param AllowedSubTypesClassReflectionExtension[] $allowedSubTypesClassReflectionExtensions
 	 */
 	public function __construct(
 		private array $propertiesClassReflectionExtensions,
 		private array $methodsClassReflectionExtensions,
+		private array $allowedSubTypesClassReflectionExtensions,
 	)
 	{
 	}
@@ -41,12 +44,18 @@ public function addMethodsClassReflectionExtension(MethodsClassReflectionExtensi
 		$this->methodsClassReflectionExtensions[] = $extension;
 	}
 
+	public function addAllowedSubTypesClassReflectionExtension(AllowedSubTypesClassReflectionExtension $extension): void
+	{
+		$this->allowedSubTypesClassReflectionExtensions[] = $extension;
+	}
+
 	public function getRegistry(): ClassReflectionExtensionRegistry
 	{
 		return new ClassReflectionExtensionRegistry(
 			$this->broker,
 			$this->propertiesClassReflectionExtensions,
 			$this->methodsClassReflectionExtensions,
+			$this->allowedSubTypesClassReflectionExtensions,
 		);
 	}
 

src/DependencyInjection/Reflection/LazyClassReflectionExtensionRegistryProvider.php

@@ -31,6 +31,7 @@ public function getRegistry(): ClassReflectionExtensionRegistry
 				$this->container->getByType(Broker::class),
 				array_merge([$phpClassReflectionExtension], $this->container->getServicesByTag(BrokerFactory::PROPERTIES_CLASS_REFLECTION_EXTENSION_TAG), [$annotationsPropertiesClassReflectionExtension]),
 				array_merge([$phpClassReflectionExtension], $this->container->getServicesByTag(BrokerFactory::METHODS_CLASS_REFLECTION_EXTENSION_TAG), [$annotationsMethodsClassReflectionExtension]),
+				$this->container->getServicesByTag(BrokerFactory::ALLOWED_SUB_TYPES_CLASS_REFLECTION_EXTENSION_TAG),
 			);
 		}
 

src/Reflection/AllowedSubTypesClassReflectionExtension.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Reflection;
+
+use PHPStan\Type\Type;
+
+/** @api */
+interface AllowedSubTypesClassReflectionExtension
+{
+
+	public function supports(ClassReflection $classReflection): bool;
+
+	/**
+	 * @return array<Type>
+	 */
+	public function getAllowedSubTypes(ClassReflection $classReflection): array;
+
+}

src/Reflection/BetterReflection/BetterReflectionProvider.php

@@ -136,6 +136,7 @@ public function getClass(string $className): ClassReflection
 			$this->phpVersion,
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getPropertiesClassReflectionExtensions(),
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getMethodsClassReflectionExtensions(),
+			$this->classReflectionExtensionRegistryProvider->getRegistry()->getAllowedSubTypesClassReflectionExtensions(),
 			$reflectionClass->getName(),
 			$reflectionClass instanceof ReflectionEnum && PHP_VERSION_ID >= 80000 ? new $enumAdapter($reflectionClass) : new ReflectionClass($reflectionClass),
 			null,
@@ -211,6 +212,7 @@ public function getAnonymousClassReflection(Node\Stmt\Class_ $classNode, Scope $
 			$this->phpVersion,
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getPropertiesClassReflectionExtensions(),
 			$this->classReflectionExtensionRegistryProvider->getRegistry()->getMethodsClassReflectionExtensions(),
+			$this->classReflectionExtensionRegistryProvider->getRegistry()->getAllowedSubTypesClassReflectionExtensions(),
 			sprintf('class@anonymous/%s:%s', $filename, $classNode->getLine()),
 			new ReflectionClass($reflectionClass),
 			$scopeFile,

src/Reflection/ClassReflection.php

@@ -120,6 +120,7 @@ class ClassReflection
 	/**
 	 * @param PropertiesClassReflectionExtension[] $propertiesClassReflectionExtensions
 	 * @param MethodsClassReflectionExtension[] $methodsClassReflectionExtensions
+	 * @param AllowedSubTypesClassReflectionExtension[] $allowedSubTypesClassReflectionExtensions
 	 */
 	public function __construct(
 		private ReflectionProvider $reflectionProvider,
@@ -130,6 +131,7 @@ public function __construct(
 		private PhpVersion $phpVersion,
 		private array $propertiesClassReflectionExtensions,
 		private array $methodsClassReflectionExtensions,
+		private array $allowedSubTypesClassReflectionExtensions,
 		private string $displayName,
 		private ReflectionClass|ReflectionEnum $reflection,
 		private ?string $anonymousFilename,
@@ -1292,6 +1294,7 @@ public function withTypes(array $types): self
 			$this->phpVersion,
 			$this->propertiesClassReflectionExtensions,
 			$this->methodsClassReflectionExtensions,
+			$this->allowedSubTypesClassReflectionExtensions,
 			$this->displayName,
 			$this->reflection,
 			$this->anonymousFilename,
@@ -1491,4 +1494,18 @@ public function getResolvedMixinTypes(): array
 		return $types;
 	}
 
+	/**
+	 * @return array<Type>|null
+	 */
+	public function getAllowedSubTypes(): ?array
+	{
+		foreach ($this->allowedSubTypesClassReflectionExtensions as $allowedSubTypesClassReflectionExtension) {
+			if ($allowedSubTypesClassReflectionExtension->supports($this)) {
+				return $allowedSubTypesClassReflectionExtension->getAllowedSubTypes($this);
+			}
+		}
+
+		return null;
+	}
+
 }

src/Reflection/ClassReflectionExtensionRegistry.php

@@ -11,14 +11,16 @@ class ClassReflectionExtensionRegistry
 	/**
 	 * @param PropertiesClassReflectionExtension[] $propertiesClassReflectionExtensions
 	 * @param MethodsClassReflectionExtension[] $methodsClassReflectionExtensions
+	 * @param AllowedSubTypesClassReflectionExtension[] $allowedSubTypesClassReflectionExtensions
 	 */
 	public function __construct(
 		Broker $broker,
 		private array $propertiesClassReflectionExtensions,
 		private array $methodsClassReflectionExtensions,
+		private array $allowedSubTypesClassReflectionExtensions,
 	)
 	{
-		foreach (array_merge($propertiesClassReflectionExtensions, $methodsClassReflectionExtensions) as $extension) {
+		foreach (array_merge($propertiesClassReflectionExtensions, $methodsClassReflectionExtensions, $allowedSubTypesClassReflectionExtensions) as $extension) {
 			if (!($extension instanceof BrokerAwareExtension)) {
 				continue;
 			}
@@ -43,4 +45,12 @@ public function getMethodsClassReflectionExtensions(): array
 		return $this->methodsClassReflectionExtensions;
 	}
 
+	/**
+	 * @return AllowedSubTypesClassReflectionExtension[]
+	 */
+	public function getAllowedSubTypesClassReflectionExtensions(): array
+	{
+		return $this->allowedSubTypesClassReflectionExtensions;
+	}
+
 }

src/Reflection/Php/EnumAllowedSubTypesClassReflectionExtension.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Reflection\Php;
+
+use PHPStan\Reflection\AllowedSubTypesClassReflectionExtension;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Type\Enum\EnumCaseObjectType;
+use function array_keys;
+
+class EnumAllowedSubTypesClassReflectionExtension implements AllowedSubTypesClassReflectionExtension
+{
+
+	public function supports(ClassReflection $classReflection): bool
+	{
+		return $classReflection->isEnum();
+	}
+
+	public function getAllowedSubTypes(ClassReflection $classReflection): array
+	{
+		$cases = [];
+		foreach (array_keys($classReflection->getEnumCases()) as $name) {
+			$cases[] = new EnumCaseObjectType($classReflection->getName(), $name);
+		}
+
+		return $cases;
+	}
+
+}

src/Rules/Classes/AllowedSubTypesRule.php

@@ -0,0 +1,67 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Classes;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+use function array_values;
+use function sprintf;
+
+/**
+ * @implements Rule<InClassNode>
+ */
+class AllowedSubTypesRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return InClassNode::class;
+	}
+
+	/**
+	 * @param InClassNode $node
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$classReflection = $node->getClassReflection();
+		$className = $classReflection->getName();
+
+		$parents = array_values($classReflection->getImmediateInterfaces());
+		$parentClass = $classReflection->getParentClass();
+		if ($parentClass !== null) {
+			$parents[] = $parentClass;
+		}
+
+		$messages = [];
+
+		foreach ($parents as $parentReflection) {
+			$allowedSubTypes = $parentReflection->getAllowedSubTypes();
+			if ($allowedSubTypes === null) {
+				continue;
+			}
+
+			foreach ($allowedSubTypes as $allowedSubType) {
+				if (!$allowedSubType instanceof ObjectType) {
+					continue;
+				}
+
+				if ($className === $allowedSubType->getClassName()) {
+					continue 2;
+				}
+			}
+
+			$messages[] = RuleErrorBuilder::message(sprintf(
+				'Type %s is not allowed to be a subtype of %s.',
+				$className,
+				$parentReflection->getName(),
+			))->build();
+		}
+
+		return $messages;
+	}
+
+}