Fix @phpstan-self-out error message

phpstan · Aug 23, 2024 · 04e5009 · 04e5009
1 parent 6838669
commit 04e5009
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/src/Rules/FunctionDefinitionCheck.php b/src/Rules/FunctionDefinitionCheck.php
@@ -241,6 +241,7 @@ public function checkClassMethod(
 		string $templateTypeMissingInParameterMessage,
 		string $unresolvableParameterTypeMessage,
 		string $unresolvableReturnTypeMessage,
+		string $selfOutMessage,
 	): array
 	{
 		/** @var ParametersAcceptorWithPhpDocs $parametersAcceptor */
@@ -263,7 +264,7 @@ public function checkClassMethod(
 
 			foreach ($selfOutTypeReferencedClasses as $class) {
 				if (!$this->reflectionProvider->hasClass($class)) {
-					$errors[] = RuleErrorBuilder::message(sprintf($returnMessage, $class))
+					$errors[] = RuleErrorBuilder::message(sprintf($selfOutMessage, $class))
 						->line($methodNode->getStartLine())
 						->identifier('class.notFound')
 						->build();
@@ -273,7 +274,7 @@ public function checkClassMethod(
 					continue;
 				}
 
-				$errors[] = RuleErrorBuilder::message(sprintf($returnMessage, $class))
+				$errors[] = RuleErrorBuilder::message(sprintf($selfOutMessage, $class))
 					->line($methodNode->getStartLine())
 					->identifier('selfOut.trait')
 					->build();

diff --git a/src/Rules/Methods/ExistingClassesInTypehintsRule.php b/src/Rules/Methods/ExistingClassesInTypehintsRule.php
@@ -56,6 +56,11 @@ public function processNode(Node $node, Scope $scope): array
 				$className,
 				$methodName,
 			),
+			sprintf(
+				'Method %s::%s() has invalid @phpstan-self-out type %%s.',
+				$className,
+				$methodName,
+			),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php
@@ -512,11 +512,11 @@ public function testSelfOut(): void
 	{
 		$this->analyse([__DIR__ . '/data/self-out.php'], [
 			[
-				'Method SelfOutClasses\Foo::doFoo() has invalid return type SelfOutClasses\Nonexistent.',
+				'Method SelfOutClasses\Foo::doFoo() has invalid @phpstan-self-out type SelfOutClasses\Nonexistent.',
 				16,
 			],
 			[
-				'Method SelfOutClasses\Foo::doBar() has invalid return type SelfOutClasses\FooTrait.',
+				'Method SelfOutClasses\Foo::doBar() has invalid @phpstan-self-out type SelfOutClasses\FooTrait.',
 				24,
 			],
 			[