Implement dynamic return type extension for EntityRepository::createQueryBuilder() (#140)

Author: xificurk

extension.neon

@@ -64,6 +64,10 @@ services:
 			fasterVersion: %doctrine.queryBuilderFastAlgorithm%
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
+	-
+		class: PHPStan\Type\Doctrine\QueryBuilder\EntityRepositoryCreateQueryBuilderDynamicReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
 		class: PHPStan\Type\Doctrine\DoctrineSelectableDynamicReturnTypeExtension
 		tags:

src/Type/Doctrine/QueryBuilder/EntityRepositoryCreateQueryBuilderDynamicReturnTypeExtension.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\QueryBuilder;
+
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Generic\GenericClassStringType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeWithClassName;
+
+class EntityRepositoryCreateQueryBuilderDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	public function getClass(): string
+	{
+		return 'Doctrine\ORM\EntityRepository';
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'createQueryBuilder';
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type
+	{
+		$entityNameExpr = new MethodCall($methodCall->var, new Identifier('getEntityName'));
+
+		$entityNameExprType = $scope->getType($entityNameExpr);
+		if ($entityNameExprType instanceof GenericClassStringType && $entityNameExprType->getGenericType() instanceof TypeWithClassName) {
+			$entityNameExpr = new String_($entityNameExprType->getGenericType()->getClassName());
+		}
+
+		$fromArgs = $methodCall->args;
+		array_unshift($fromArgs, new Arg($entityNameExpr));
+
+		$callStack = new MethodCall($methodCall->var, new Identifier('getEntityManager'));
+		$callStack = new MethodCall($callStack, new Identifier('createQueryBuilder'));
+		$callStack = new MethodCall($callStack, new Identifier('select'), [$methodCall->args[0]]);
+		$callStack = new MethodCall($callStack, new Identifier('from'), $fromArgs);
+
+		return $scope->getType($callStack);
+	}
+
+}

tests/DoctrineIntegration/ORM/data/queryBuilder-0.json

@@ -0,0 +1,7 @@
+[
+    {
+        "message": "Could not analyse QueryBuilder with dynamic arguments.",
+        "line": 54,
+        "ignorable": true
+    }
+]

tests/DoctrineIntegration/ORM/data/queryBuilder-4.json

@@ -8,5 +8,15 @@
         "message": "Strict comparison using === between 'SELECT e FROM…' and 'aaa' will always evaluate to false.",
         "line": 30,
         "ignorable": true
+    },
+    {
+        "message": "Strict comparison using === between 'SELECT e FROM…' and 'bbb' will always evaluate to false.",
+        "line": 41,
+        "ignorable": true
+    },
+    {
+        "message": "Strict comparison using === between 'SELECT e FROM…' and 'bbb' will always evaluate to false.",
+        "line": 42,
+        "ignorable": true
     }
 ]

tests/DoctrineIntegration/ORM/data/queryBuilder.php

@@ -32,4 +32,26 @@ public function doFoo(): Query
 		return $query;
 	}
 
+	public function doBar(): Query
+	{
+		$entityRepository = $this->entityManager->getRepository(MyEntity::class);
+		$queryBuilder = $entityRepository->createQueryBuilder('e');
+		$query = $queryBuilder->getQuery();
+
+		$query->getDQL() === 'bbb';
+		$queryBuilder->getDQL() === 'bbb';
+
+		return $query;
+	}
+
+	/**
+	 * @phpstan-param class-string $entityClass
+	 */
+	public function dynamicQueryBuilder(string $entityClass): Query
+	{
+		$entityRepository = $this->entityManager->getRepository($entityClass);
+		$queryBuilder = $entityRepository->createQueryBuilder('e');
+		return $queryBuilder->getQuery();
+	}
+
 }

tests/DoctrineIntegration/ORM/phpstan.neon

@@ -6,3 +6,4 @@ includes:
 parameters:
 	doctrine:
 		objectManagerLoader: entity-manager.php
+		reportDynamicQueryBuilders: true