Set class and method reflection in the MethodReturnStatementNode.

phpstan · Jul 7, 2023 · 4ee3018 · 4ee3018
1 parent dabbd59
commit 4ee3018
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 36 deletions.
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -593,12 +593,25 @@ private function processStmtNode(
 
 					$gatheredReturnStatements[] = new ReturnStatement($scope, $node);
 				}, StatementContext::createTopLevel());
+
+				$classReflection = $methodScope->getClassReflection();
+				if ($classReflection === null) {
+					throw new ShouldNotHappenException();
+				}
+
+				$methodReflection = $methodScope->getFunction();
+				if ($methodReflection === null) {
+					throw new ShouldNotHappenException();
+				}
+
 				$nodeCallback(new MethodReturnStatementsNode(
 					$stmt,
 					$gatheredReturnStatements,
 					$gatheredYieldStatements,
 					$statementResult,
 					$executionEnds,
+					$classReflection,
+					$methodReflection,
 				), $methodScope);
 			}
 		} elseif ($stmt instanceof Echo_) {

diff --git a/src/Node/MethodReturnStatementsNode.php b/src/Node/MethodReturnStatementsNode.php
@@ -7,6 +7,9 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\NodeAbstract;
 use PHPStan\Analyser\StatementResult;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\MethodReflection;
+
 use function count;
 
 /** @api */
@@ -26,6 +29,8 @@ public function __construct(
 		private array $yieldStatements,
 		private StatementResult $statementResult,
 		private array $executionEnds,
+		private ClassReflection $classReflection,
+		private MethodReflection $methodReflection,
 	)
 	{
 		parent::__construct($method->getAttributes());
@@ -67,6 +72,16 @@ public function getYieldStatements(): array
 		return $this->yieldStatements;
 	}
 
+	public function getClassReflection(): ClassReflection
+	{
+		return $this->classReflection;
+	}
+
+	public function getMethodReflection(): MethodReflection
+	{
+		return $this->methodReflection;
+	}
+
 	public function isGenerator(): bool
 	{
 		return count($this->yieldStatements) > 0;

diff --git a/src/Rules/Exceptions/MissingCheckedExceptionInMethodThrowsRule.php b/src/Rules/Exceptions/MissingCheckedExceptionInMethodThrowsRule.php
@@ -5,10 +5,8 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\MethodReturnStatementsNode;
-use PHPStan\Reflection\MethodReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\ShouldNotHappenException;
 use function sprintf;
 
 /**
@@ -29,10 +27,7 @@ public function getNodeType(): string
 	public function processNode(Node $node, Scope $scope): array
 	{
 		$statementResult = $node->getStatementResult();
-		$methodReflection = $scope->getFunction();
-		if (!$methodReflection instanceof MethodReflection) {
-			throw new ShouldNotHappenException();
-		}
+		$methodReflection = $node->getMethodReflection();
 
 		$errors = [];
 		foreach ($this->check->check($methodReflection->getThrowType(), $statementResult->getThrowPoints()) as [$className, $throwPointNode]) {

diff --git a/src/Rules/Exceptions/ThrowsVoidMethodWithExplicitThrowPointRule.php b/src/Rules/Exceptions/ThrowsVoidMethodWithExplicitThrowPointRule.php
@@ -5,10 +5,8 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\MethodReturnStatementsNode;
-use PHPStan\Reflection\MethodReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\TypeUtils;
 use PHPStan\Type\VerbosityLevel;
@@ -35,10 +33,7 @@ public function getNodeType(): string
 	public function processNode(Node $node, Scope $scope): array
 	{
 		$statementResult = $node->getStatementResult();
-		$methodReflection = $scope->getFunction();
-		if (!$methodReflection instanceof MethodReflection) {
-			throw new ShouldNotHappenException();
-		}
+		$methodReflection = $node->getMethodReflection();
 
 		if ($methodReflection->getThrowType() === null || !$methodReflection->getThrowType()->isVoid()->yes()) {
 			return [];

diff --git a/src/Rules/Exceptions/TooWideMethodThrowTypeRule.php b/src/Rules/Exceptions/TooWideMethodThrowTypeRule.php
@@ -5,10 +5,8 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\MethodReturnStatementsNode;
-use PHPStan\Reflection\MethodReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\FileTypeMapper;
 use function sprintf;
 
@@ -29,21 +27,14 @@ public function getNodeType(): string
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		$statementResult = $node->getStatementResult();
-		$methodReflection = $scope->getFunction();
-		if (!$methodReflection instanceof MethodReflection) {
-			throw new ShouldNotHappenException();
-		}
-		if (!$scope->isInClass()) {
-			throw new ShouldNotHappenException();
-		}
-
 		$docComment = $node->getDocComment();
 		if ($docComment === null) {
 			return [];
 		}
 
-		$classReflection = $scope->getClassReflection();
+		$statementResult = $node->getStatementResult();
+		$methodReflection = $node->getMethodReflection();
+		$classReflection = $node->getClassReflection();
 		$resolvedPhpDoc = $this->fileTypeMapper->getResolvedPhpDoc(
 			$scope->getFile(),
 			$classReflection->getName(),

diff --git a/src/Rules/Playground/MethodNeverRule.php b/src/Rules/Playground/MethodNeverRule.php
@@ -5,11 +5,9 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\MethodReturnStatementsNode;
-use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\ShouldNotHappenException;
 use function count;
 use function sprintf;
 
@@ -34,10 +32,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		$method = $scope->getFunction();
-		if (!$method instanceof MethodReflection) {
-			throw new ShouldNotHappenException();
-		}
+		$method = $node->getMethodReflection();
 
 		$returnType = ParametersAcceptorSelector::selectSingle($method->getVariants())->getReturnType();
 		$helperResult = $this->helper->shouldReturnNever($node, $returnType);

diff --git a/src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php
@@ -5,11 +5,9 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\MethodReturnStatementsNode;
-use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
@@ -34,10 +32,7 @@ public function getNodeType(): string
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		$method = $scope->getFunction();
-		if (!$method instanceof MethodReflection) {
-			throw new ShouldNotHappenException();
-		}
+		$method = $node->getMethodReflection();
 		$isFirstDeclaration = $method->getPrototype()->getDeclaringClass() === $method->getDeclaringClass();
 		if (!$method->isPrivate()) {
 			if (!$this->checkProtectedAndPublicMethods) {