Support multiple tags and improve interface handling in @phpstan-require-extends

Author: zonuexe

src/Rules/PhpDoc/RequireExtendsCheck.php

@@ -9,6 +9,8 @@
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\VerbosityLevel;
+use function array_column;
+use function array_map;
 use function array_merge;
 use function count;
 use function sprintf;
@@ -47,32 +49,39 @@ public function checkExtendsTags(Node $node, array $extendsTags): array
 				continue;
 			}
 
-			$class = $type->getObjectClassNames()[0];
-			$referencedClassReflection = $type->getObjectClassReflections()[0] ?? null;
+			$referencedClassReflections = array_map(static fn ($reflection) => [$reflection, $reflection->getName()], $type->getObjectClassReflections());
+			$referencedClassReflectionsMap = array_column($referencedClassReflections, 0, 1);
+			foreach ($type->getObjectClassNames() as $class) {
+				$referencedClassReflection = $referencedClassReflectionsMap[$class] ?? null;
+				if ($referencedClassReflection === null) {
+					$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends contains unknown class %s.', $class))
+						->discoveringSymbolsTip()
+						->identifier('class.notFound')
+						->build();
+					continue;
+				}
 
-			if ($referencedClassReflection === null) {
-				$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends contains unknown class %s.', $class))
-					->discoveringSymbolsTip()
-					->identifier('class.notFound')
-					->build();
-				continue;
-			}
-
-			if (!$referencedClassReflection->isClass()) {
-				$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends cannot contain non-class type %s.', $class))
-					->identifier(sprintf('requireExtends.%s', strtolower($referencedClassReflection->getClassTypeDescription())))
-					->build();
-			} elseif ($referencedClassReflection->isFinal()) {
-				$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends cannot contain final class %s.', $class))
-					->identifier('requireExtends.finalClass')
-					->build();
-			} else {
-				$errors = array_merge(
-					$errors,
-					$this->classCheck->checkClassNames([
-						new ClassNameNodePair($class, $node),
-					], $this->checkClassCaseSensitivity),
-				);
+				if ($referencedClassReflection->isInterface()) {
+					$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends cannot contain an interface %s, expected a class.', $class))
+						->tip('If you meant an interface, use @phpstan-require-implements instead.')
+						->identifier('requireExtends.interface')
+						->build();
+				} elseif (!$referencedClassReflection->isClass()) {
+					$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends cannot contain non-class type %s.', $class))
+						->identifier(sprintf('requireExtends.%s', strtolower($referencedClassReflection->getClassTypeDescription())))
+						->build();
+				} elseif ($referencedClassReflection->isFinal()) {
+					$errors[] = RuleErrorBuilder::message(sprintf('PHPDoc tag @phpstan-require-extends cannot contain final class %s.', $class))
+						->identifier('requireExtends.finalClass')
+						->build();
+				} else {
+					$errors = array_merge(
+						$errors,
+						$this->classCheck->checkClassNames([
+							new ClassNameNodePair($class, $node),
+						], $this->checkClassCaseSensitivity),
+					);
+				}
 			}
 		}
 

tests/PHPStan/Rules/PhpDoc/RequireExtendsDefinitionClassRuleTest.php

@@ -45,8 +45,9 @@ public function testRule(): void
 				8,
 			],
 			[
-				'PHPDoc tag @phpstan-require-extends cannot contain non-class type IncompatibleRequireExtends\SomeInterface.',
+				'PHPDoc tag @phpstan-require-extends cannot contain an interface IncompatibleRequireExtends\SomeInterface, expected a class.',
 				13,
+				'If you meant an interface, use @phpstan-require-implements instead.',
 			],
 			[
 				$enumError,
@@ -75,8 +76,9 @@ public function testRule(): void
 				121,
 			],
 			[
-				'PHPDoc tag @phpstan-require-extends contains non-object type IncompatibleRequireExtends\UnresolvableExtendsInterface&stdClass.',
+				'PHPDoc tag @phpstan-require-extends cannot contain an interface IncompatibleRequireExtends\UnresolvableExtendsInterface, expected a class.',
 				135,
+				'If you meant an interface, use @phpstan-require-implements instead.',
 			],
 			[
 				'PHPDoc tag @phpstan-require-extends can only be used once.',