Use ParentMethodHelper and separate error identifiers

Author: kubawerlos

src/Rules/PhpDoc/InvalidInheritDocTagRule.php

@@ -9,7 +9,7 @@
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\PhpDocParser\Parser\TokenIterator;
-use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\Methods\ParentMethodHelper;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use function preg_match;
@@ -27,6 +27,7 @@ final class InvalidInheritDocTagRule implements Rule
 	public function __construct(
 		private Lexer $phpDocLexer,
 		private PhpDocParser $phpDocParser,
+		private ParentMethodHelper $parentMethodHelper,
 	)
 	{
 	}
@@ -78,8 +79,23 @@ public function processNode(Node $node, Scope $scope): array
 		$inheritanceClass = $scope->isInTrait() ? $scope->getTraitReflection() : $node->getClassReflection();
 		$methodName = $node->getMethodReflection()->getName();
 
-		if ($this->hasInheritablePhpDoc($inheritanceClass, $methodName)) {
-			return [];
+		$parentMethods = $this->parentMethodHelper->collectParentMethods($methodName, $inheritanceClass);
+
+		if ($parentMethods === []) {
+			return [
+				RuleErrorBuilder::message(sprintf(
+					'PHPDoc tag %s on method %s::%s() does not override or implement any other method.',
+					$inheritDocTagName,
+					$inheritanceClass->getDisplayName(),
+					$methodName,
+				))->identifier('inheritDoc.noParent')->build(),
+			];
+		}
+
+		foreach ($parentMethods as [$parentMethod]) {
+			if ($parentMethod->getResolvedPhpDoc() !== null) {
+				return [];
+			}
 		}
 
 		return [
@@ -88,44 +104,8 @@ public function processNode(Node $node, Scope $scope): array
 				$inheritDocTagName,
 				$inheritanceClass->getDisplayName(),
 				$methodName,
-			))->identifier('phpDoc.invalidInheritDoc')->build(),
+			))->identifier('inheritDoc.parentWithoutPhpDoc')->build(),
 		];
 	}
 
-	private function hasInheritablePhpDoc(ClassReflection $classReflection, string $methodName): bool
-	{
-		$parent = $classReflection->getParentClass();
-		if ($parent !== null && $this->parentHasPhpDocForMethod($parent, $methodName)) {
-			return true;
-		}
-
-		foreach ($classReflection->getImmediateInterfaces() as $interface) {
-			if ($this->parentHasPhpDocForMethod($interface, $methodName)) {
-				return true;
-			}
-		}
-
-		foreach ($classReflection->getTraits() as $trait) {
-			if ($this->parentHasPhpDocForMethod($trait, $methodName)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	private function parentHasPhpDocForMethod(ClassReflection $parent, string $methodName): bool
-	{
-		if (!$parent->hasNativeMethod($methodName)) {
-			return false;
-		}
-
-		$parentMethod = $parent->getNativeMethod($methodName);
-		if ($parentMethod->isPrivate()) {
-			return false;
-		}
-
-		return $parentMethod->getResolvedPhpDoc() !== null;
-	}
-
 }

tests/PHPStan/Rules/PhpDoc/InvalidInheritDocTagRuleTest.php

@@ -4,6 +4,7 @@
 
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
+use PHPStan\Rules\Methods\ParentMethodHelper;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
@@ -18,6 +19,7 @@ protected function getRule(): Rule
 		return new InvalidInheritDocTagRule(
 			self::getContainer()->getByType(Lexer::class),
 			self::getContainer()->getByType(PhpDocParser::class),
+			self::getContainer()->getByType(ParentMethodHelper::class),
 		);
 	}
 
@@ -33,31 +35,35 @@ public function testRule(): void
 				52,
 			],
 			[
-				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\ClassWithoutParent::orphanedInheritDoc() refers to a parent method that does not have a PHPDoc.',
+				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\ClassWithoutParent::orphanedInheritDoc() does not override or implement any other method.',
 				73,
 			],
 			[
-				'PHPDoc tag @inheritdoc on method InvalidInheritDocTag\ClassWithoutParent::orphanedBlockInheritDoc() refers to a parent method that does not have a PHPDoc.',
+				'PHPDoc tag @inheritdoc on method InvalidInheritDocTag\ClassWithoutParent::orphanedBlockInheritDoc() does not override or implement any other method.',
 				81,
 			],
 			[
 				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\ImplementsInterface::interfaceMethodWithoutPhpDoc() refers to a parent method that does not have a PHPDoc.',
 				106,
 			],
 			[
-				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\UsesTraitWithoutPhpDoc::traitMethodWithoutPhpDoc() refers to a parent method that does not have a PHPDoc.',
+				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\UsesTraitWithoutPhpDoc::traitMethodWithoutPhpDoc() does not override or implement any other method.',
 				216,
 			],
+			[
+				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\UsesTraitWithPhpDoc::traitMethodWithPhpDoc() does not override or implement any other method.',
+				231,
+			],
 			[
 				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\IssueExampleChild::f() refers to a parent method that does not have a PHPDoc.',
 				254,
 			],
 			[
-				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\ChildOfPrivateParentMethod::privateMethod() refers to a parent method that does not have a PHPDoc.',
+				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\ChildOfPrivateParentMethod::privateMethod() does not override or implement any other method.',
 				280,
 			],
 			[
-				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\OrphanedInheritDocTrait::orphaned() refers to a parent method that does not have a PHPDoc.',
+				'PHPDoc tag {@inheritdoc} on method InvalidInheritDocTag\OrphanedInheritDocTrait::orphaned() does not override or implement any other method.',
 				293,
 			],
 		]);