Read PHPDocs for built-in method even if the method has multiple vari…

…ants
phpstan · Apr 23, 2021 · b48fd77 · b48fd77
1 parent ce5f316
commit b48fd77
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 28 deletions.
diff --git a/src/Reflection/Php/PhpClassReflectionExtension.php b/src/Reflection/Php/PhpClassReflectionExtension.php
@@ -482,6 +482,7 @@ private function createMethod(
 				$stubPhpDocParameterVariadicity = [];
 				$phpDocParameterTypes = [];
 				$phpDocReturnType = null;
+				$stubPhpDocPair = null;
 				if (count($variantNumbers) === 1) {
 					$stubPhpDocPair = $this->findMethodPhpDocIncludingAncestors($declaringClass, $methodReflection->getName(), array_map(static function (ParameterSignature $parameterSignature): string {
 						return $parameterSignature->getName();
@@ -505,36 +506,37 @@ private function createMethod(
 							);
 							$stubPhpDocParameterVariadicity[$name] = $paramTag->isVariadic();
 						}
-					} elseif ($reflectionMethod !== null && $reflectionMethod->getDocComment() !== false) {
-						$filename = $reflectionMethod->getFileName();
-						if ($filename !== false) {
-							$phpDocBlock = $this->fileTypeMapper->getResolvedPhpDoc(
-								$filename,
-								$declaringClassName,
-								null,
-								$reflectionMethod->getName(),
-								$reflectionMethod->getDocComment()
-							);
-							$throwsTag = $phpDocBlock->getThrowsTag();
-							if ($throwsTag !== null) {
-								$throwType = $throwsTag->getType();
-							}
-							$returnTag = $phpDocBlock->getReturnTag();
-							if ($returnTag !== null) {
-								$phpDocReturnType = $returnTag->getType();
-							}
-							foreach ($phpDocBlock->getParamTags() as $name => $paramTag) {
-								$phpDocParameterTypes[$name] = $paramTag->getType();
-							}
-
-							$signatureParameters = $methodSignature->getParameters();
-							foreach ($reflectionMethod->getParameters() as $paramI => $reflectionParameter) {
-								if (!array_key_exists($paramI, $signatureParameters)) {
-									continue;
-								}
+					}
+				}
+				if ($stubPhpDocPair === null && $reflectionMethod !== null && $reflectionMethod->getDocComment() !== false) {
+					$filename = $reflectionMethod->getFileName();
+					if ($filename !== false) {
+						$phpDocBlock = $this->fileTypeMapper->getResolvedPhpDoc(
+							$filename,
+							$declaringClassName,
+							null,
+							$reflectionMethod->getName(),
+							$reflectionMethod->getDocComment()
+						);
+						$throwsTag = $phpDocBlock->getThrowsTag();
+						if ($throwsTag !== null) {
+							$throwType = $throwsTag->getType();
+						}
+						$returnTag = $phpDocBlock->getReturnTag();
+						if ($returnTag !== null) {
+							$phpDocReturnType = $returnTag->getType();
+						}
+						foreach ($phpDocBlock->getParamTags() as $name => $paramTag) {
+							$phpDocParameterTypes[$name] = $paramTag->getType();
+						}
 
-								$phpDocParameterNameMapping[$signatureParameters[$paramI]->getName()] = $reflectionParameter->getName();
+						$signatureParameters = $methodSignature->getParameters();
+						foreach ($reflectionMethod->getParameters() as $paramI => $reflectionParameter) {
+							if (!array_key_exists($paramI, $signatureParameters)) {
+								continue;
 							}
+
+							$phpDocParameterNameMapping[$signatureParameters[$paramI]->getName()] = $reflectionParameter->getName();
 						}
 					}
 				}

diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -383,6 +383,7 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-2906.php');
 
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/DateTimeDynamicReturnTypes.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-4821.php');
 	}
 
 	/**

diff --git a/tests/PHPStan/Analyser/data/bug-4821.php b/tests/PHPStan/Analyser/data/bug-4821.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Bug4821;
+
+use PHPStan\TrinaryLogic;
+use function PHPStan\Testing\assertVariableCertainty;
+
+class HelloWorld
+{
+	public function sayHello(): void
+	{
+		try {
+			$object = new HelloWorld();
+			$method = new \ReflectionMethod($object, 'nonExisting');
+			$method->invoke($object);
+			return;
+		} catch (\ReflectionException $e) {
+			assertVariableCertainty(TrinaryLogic::createYes(), $object);
+			assertVariableCertainty(TrinaryLogic::createMaybe(), $method);
+		}
+	}
+}