Bleeding edge - check existing classes in @phpstan-self-out

Author: ondrejmirtes

src/Rules/FunctionDefinitionCheck.php

@@ -246,7 +246,7 @@ public function checkClassMethod(
 		/** @var ParametersAcceptorWithPhpDocs $parametersAcceptor */
 		$parametersAcceptor = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants());
 
-		return $this->checkParametersAcceptor(
+		$errors = $this->checkParametersAcceptor(
 			$parametersAcceptor,
 			$methodNode,
 			$parameterMessage,
@@ -256,6 +256,39 @@ public function checkClassMethod(
 			$unresolvableParameterTypeMessage,
 			$unresolvableReturnTypeMessage,
 		);
+
+		$selfOutType = $methodReflection->getSelfOutType();
+		if ($selfOutType !== null && $this->absentTypeChecks) {
+			$selfOutTypeReferencedClasses = $selfOutType->getReferencedClasses();
+
+			foreach ($selfOutTypeReferencedClasses as $class) {
+				if (!$this->reflectionProvider->hasClass($class)) {
+					$errors[] = RuleErrorBuilder::message(sprintf($returnMessage, $class))
+						->line($methodNode->getStartLine())
+						->identifier('class.notFound')
+						->build();
+					continue;
+				}
+				if (!$this->reflectionProvider->getClass($class)->isTrait()) {
+					continue;
+				}
+
+				$errors[] = RuleErrorBuilder::message(sprintf($returnMessage, $class))
+					->line($methodNode->getStartLine())
+					->identifier('selfOut.trait')
+					->build();
+			}
+
+			$errors = array_merge(
+				$errors,
+				$this->classCheck->checkClassNames(
+					array_map(static fn (string $class): ClassNameNodePair => new ClassNameNodePair($class, $methodNode), $selfOutTypeReferencedClasses),
+					$this->checkClassCaseSensitivity,
+				),
+			);
+		}
+
+		return $errors;
 	}
 
 	/**

tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php

@@ -508,4 +508,22 @@ public function testParamClosureThisClasses(): void
 		]);
 	}
 
+	public function testSelfOut(): void
+	{
+		$this->analyse([__DIR__ . '/data/self-out.php'], [
+			[
+				'Method SelfOutClasses\Foo::doFoo() has invalid return type SelfOutClasses\Nonexistent.',
+				16,
+			],
+			[
+				'Method SelfOutClasses\Foo::doBar() has invalid return type SelfOutClasses\FooTrait.',
+				24,
+			],
+			[
+				'Class SelfOutClasses\Foo referenced with incorrect case: SelfOutClasses\fOO.',
+				32,
+			],
+		]);
+	}
+
 }

tests/PHPStan/Rules/Methods/data/self-out.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace SelfOutClasses;
+
+trait FooTrait
+{
+
+}
+
+class Foo
+{
+
+	/**
+	 * @phpstan-self-out Nonexistent
+	 */
+	public function doFoo(): void
+	{
+
+	}
+
+	/**
+	 * @phpstan-self-out FooTrait
+	 */
+	public function doBar(): void
+	{
+
+	}
+
+	/**
+	 * @phpstan-self-out fOO
+	 */
+	public function doBaz(): void
+	{
+
+	}
+
+}