Support for infering the result type of queries in EntityManager::createQuery()

extension.neon

@@ -15,6 +15,8 @@ parameters:
 			- Doctrine\ORM\Mapping\ClassMetadata
 			- Doctrine\ORM\Mapping\ClassMetadataInfo
 			- Doctrine\Persistence\Mapping\ClassMetadata
+			- Doctrine\ORM\AbstractQuery
+			- Doctrine\ORM\Query
 	stubFiles:
 		- stubs/Criteria.stub
 		- stubs/DocumentManager.stub
@@ -38,6 +40,7 @@ parameters:
 		- stubs/ORM/AbstractQuery.stub
 		- stubs/ORM/Mapping/ClassMetadata.stub
 		- stubs/ORM/Mapping/ClassMetadataInfo.stub
+		- stubs/ORM/Query.stub
 		- stubs/Persistence/Mapping/ClassMetadata.stub
 		- stubs/ServiceDocumentRepository.stub
 
@@ -120,6 +123,16 @@ services:
 		class: PHPStan\Type\Doctrine\Query\QueryGetDqlDynamicReturnTypeExtension
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
+	-
+		class: PHPStan\Type\Doctrine\CreateQueryDynamicReturnTypeExtension
+		arguments:
+			objectMetadataResolver: @PHPStan\Type\Doctrine\ObjectMetadataResolver
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension
+	-
+		class: PHPStan\Type\Doctrine\Query\QueryResultDynamicReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
 		class: PHPStan\Type\Doctrine\QueryBuilder\Expr\ExpressionBuilderDynamicReturnTypeExtension
 		arguments:

src/Type/Doctrine/CreateQueryDynamicReturnTypeExtension.php

@@ -0,0 +1,101 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine;
+
+use Doctrine\Common\CommonException;
+use Doctrine\DBAL\DBALException;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\ORMException;
+use Doctrine\ORM\Query;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\Constant\ConstantStringType;
+use PHPStan\Type\Doctrine\Query\QueryResultTypeBuilder;
+use PHPStan\Type\Doctrine\Query\QueryResultTypeWalker;
+use PHPStan\Type\Doctrine\Query\QueryType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Generic\GenericObjectType;
+use PHPStan\Type\IntersectionType;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeTraverser;
+use PHPStan\Type\UnionType;
+
+/**
+ * Infers TResult in Query<TResult> on EntityManagerInterface::createQuery()
+ */
+final class CreateQueryDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/** @var ObjectMetadataResolver */
+	private $objectMetadataResolver;
+
+	/** @var DescriptorRegistry */
+	private $descriptorRegistry;
+
+	public function __construct(ObjectMetadataResolver $objectMetadataResolver, DescriptorRegistry $descriptorRegistry)
+	{
+		$this->objectMetadataResolver = $objectMetadataResolver;
+		$this->descriptorRegistry = $descriptorRegistry;
+	}
+
+	public function getClass(): string
+	{
+		return EntityManagerInterface::class;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'createQuery';
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type
+	{
+		$queryStringArgIndex = 0;
+		$args = $methodCall->getArgs();
+
+		if (!isset($args[$queryStringArgIndex])) {
+			return new GenericObjectType(
+				Query::class,
+				[new MixedType()]
+			);
+		}
+
+		$argType = $scope->getType($args[$queryStringArgIndex]->value);
+
+		return TypeTraverser::map($argType, function (Type $type, callable $traverse): Type {
+			if ($type instanceof UnionType || $type instanceof IntersectionType) {
+				return $traverse($type);
+			}
+			if ($type instanceof ConstantStringType) {
+				$queryString = $type->getValue();
+
+				$em = $this->objectMetadataResolver->getObjectManager();
+				if (!$em instanceof EntityManagerInterface) {
+					return new QueryType($queryString, null);
+				}
+
+				$typeBuilder = new QueryResultTypeBuilder();
+
+				try {
+					$query = $em->createQuery($queryString);
+					QueryResultTypeWalker::walk($query, $typeBuilder, $this->descriptorRegistry);
+				} catch (ORMException | DBALException | CommonException $e) {
+					return new QueryType($queryString, null);
+				}
+
+				return new QueryType($queryString, $typeBuilder->getResultType());
+			}
+			return new GenericObjectType(
+				Query::class,
+				[new MixedType()]
+			);
+		});
+	}
+
+}

src/Type/Doctrine/Descriptors/ArrayType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ArrayType(new MixedType(), new MixedType());
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/BigIntType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return TypeCombinator::union(new \PHPStan\Type\StringType(), new \PHPStan\Type\IntegerType());
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\IntegerType();
+	}
+
 }

src/Type/Doctrine/Descriptors/BinaryType.php

@@ -4,6 +4,7 @@
 
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ResourceType;
+use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
 
 class BinaryType implements DoctrineTypeDescriptor
@@ -24,4 +25,9 @@ public function getWritableToDatabaseType(): Type
 		return new MixedType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/BlobType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new MixedType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new MixedType();
+	}
+
 }

src/Type/Doctrine/Descriptors/BooleanType.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Type\Doctrine\Descriptors;
 
 use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
 
 class BooleanType implements DoctrineTypeDescriptor
 {
@@ -22,4 +23,12 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\BooleanType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return TypeCombinator::union(
+			new \PHPStan\Type\Constant\ConstantIntegerType(0),
+			new \PHPStan\Type\Constant\ConstantIntegerType(1)
+		);
+	}
+
 }

src/Type/Doctrine/Descriptors/DateImmutableType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new ObjectType(DateTimeImmutable::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DateIntervalType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new ObjectType(DateInterval::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DateTimeImmutableType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new ObjectType(DateTimeImmutable::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DateTimeType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ObjectType(DateTimeInterface::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DateTimeTzImmutableType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new ObjectType(DateTimeImmutable::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DateTimeTzType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ObjectType(DateTimeInterface::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DateType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ObjectType(DateTimeInterface::class);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/DecimalType.php

@@ -24,4 +24,9 @@ public function getWritableToDatabaseType(): Type
 		return TypeCombinator::union(new \PHPStan\Type\StringType(), new \PHPStan\Type\FloatType(), new \PHPStan\Type\IntegerType());
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return TypeCombinator::union(new \PHPStan\Type\FloatType(), new \PHPStan\Type\IntegerType());
+	}
+
 }

src/Type/Doctrine/Descriptors/DoctrineTypeDescriptor.php

@@ -16,4 +16,6 @@ public function getWritableToPropertyType(): Type;
 
 	public function getWritableToDatabaseType(): Type;
 
+	public function getDatabaseInternalType(): Type;
+
 }

src/Type/Doctrine/Descriptors/FloatType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return TypeCombinator::union(new \PHPStan\Type\FloatType(), new \PHPStan\Type\IntegerType());
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return TypeCombinator::union(new \PHPStan\Type\FloatType(), new \PHPStan\Type\IntegerType());
+	}
+
 }

src/Type/Doctrine/Descriptors/GuidType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return new StringType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/IntegerType.php

@@ -22,4 +22,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\IntegerType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\IntegerType();
+	}
+
 }

src/Type/Doctrine/Descriptors/JsonArrayType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ArrayType(new MixedType(), new MixedType());
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/JsonType.php

@@ -49,4 +49,9 @@ public function getWritableToDatabaseType(): Type
 		return self::getJsonType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/ObjectType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return new ObjectWithoutClassType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/Ramsey/UuidTypeDescriptor.php

@@ -54,4 +54,9 @@ public function getWritableToDatabaseType(): Type
 		);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/ReflectionDescriptor.php

@@ -45,4 +45,9 @@ public function getWritableToDatabaseType(): Type
 		return TypeCombinator::removeNull($type);
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\MixedType();
+	}
+
 }

src/Type/Doctrine/Descriptors/SimpleArrayType.php

@@ -23,4 +23,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ArrayType(new MixedType(), new MixedType());
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\StringType();
+	}
+
 }

src/Type/Doctrine/Descriptors/SmallIntType.php

@@ -22,4 +22,9 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\IntegerType();
 	}
 
+	public function getDatabaseInternalType(): Type
+	{
+		return new \PHPStan\Type\IntegerType();
+	}
+
 }