-
Notifications
You must be signed in to change notification settings - Fork 103
Infer QueryBuilderType for any method returning QueryBuilder: revive with cache #518
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ondrejmirtes
merged 2 commits into
phpstan:1.3.x
from
janedbal:infer-any-returned-qb-revive
Jan 17, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
src/Type/Doctrine/QueryBuilder/ReturnQueryBuilderExpressionTypeResolverExtension.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Doctrine\QueryBuilder; | ||
|
|
||
| use Doctrine\ORM\EntityManagerInterface; | ||
| use Doctrine\ORM\EntityRepository; | ||
| use Doctrine\ORM\QueryBuilder; | ||
| use PhpParser\Node\Expr; | ||
| use PhpParser\Node\Expr\CallLike; | ||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PhpParser\Node\Identifier; | ||
| use PhpParser\Node\Name; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\Reflection\MethodReflection; | ||
| use PHPStan\Reflection\ParametersAcceptorSelector; | ||
| use PHPStan\Type\ExpressionTypeResolverExtension; | ||
| use PHPStan\Type\ObjectType; | ||
| use PHPStan\Type\Type; | ||
| use PHPStan\Type\TypeCombinator; | ||
| use function count; | ||
|
|
||
| class ReturnQueryBuilderExpressionTypeResolverExtension implements ExpressionTypeResolverExtension | ||
| { | ||
|
|
||
| /** @var OtherMethodQueryBuilderParser */ | ||
| private $otherMethodQueryBuilderParser; | ||
|
|
||
| public function __construct( | ||
| OtherMethodQueryBuilderParser $otherMethodQueryBuilderParser | ||
| ) | ||
| { | ||
| $this->otherMethodQueryBuilderParser = $otherMethodQueryBuilderParser; | ||
| } | ||
|
|
||
| public function getType(Expr $expr, Scope $scope): ?Type | ||
| { | ||
| if (!$expr instanceof MethodCall && !$expr instanceof StaticCall) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($expr->isFirstClassCallable()) { | ||
| return null; | ||
| } | ||
|
|
||
| $methodReflection = $this->getMethodReflection($expr, $scope); | ||
|
|
||
| if ($methodReflection === null) { | ||
| return null; | ||
| } | ||
|
|
||
| $returnType = ParametersAcceptorSelector::selectFromArgs($scope, $expr->getArgs(), $methodReflection->getVariants())->getReturnType(); | ||
|
|
||
| $returnsQueryBuilder = (new ObjectType(QueryBuilder::class))->isSuperTypeOf($returnType)->yes(); | ||
|
|
||
| if (!$returnsQueryBuilder) { | ||
| return null; | ||
| } | ||
|
|
||
| $queryBuilderTypes = $this->otherMethodQueryBuilderParser->findQueryBuilderTypesInCalledMethod($scope, $methodReflection); | ||
| if (count($queryBuilderTypes) === 0) { | ||
| return null; | ||
| } | ||
|
|
||
| return TypeCombinator::union(...$queryBuilderTypes); | ||
| } | ||
|
|
||
| /** | ||
| * @param StaticCall|MethodCall $call | ||
| */ | ||
| private function getMethodReflection(CallLike $call, Scope $scope): ?MethodReflection | ||
| { | ||
| if (!$call->name instanceof Identifier) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($call instanceof MethodCall) { | ||
| $callerType = $scope->getType($call->var); | ||
| } else { | ||
| if (!$call->class instanceof Name) { | ||
| return null; | ||
| } | ||
| $callerType = $scope->resolveTypeByName($call->class); | ||
| } | ||
|
|
||
| $methodName = $call->name->name; | ||
|
|
||
| foreach ($callerType->getObjectClassReflections() as $callerClassReflection) { | ||
| if ($callerClassReflection->is(QueryBuilder::class)) { | ||
| return null; // covered by QueryBuilderMethodDynamicReturnTypeExtension | ||
| } | ||
| if ($callerClassReflection->is(EntityRepository::class) && $methodName === 'createQueryBuilder') { | ||
| return null; // covered by EntityRepositoryCreateQueryBuilderDynamicReturnTypeExtension | ||
| } | ||
| if ($callerClassReflection->is(EntityManagerInterface::class) && $methodName === 'createQueryBuilder') { | ||
| return null; // no need to dive there | ||
| } | ||
| } | ||
|
|
||
| return $scope->getMethodReflection($callerType, $methodName); | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: if this gets proven to help, we should improve the cache key to support multiple classes with the same method name in the same file.