Support for $qb->expr()

Author: ondrejmirtes

extension.neon

@@ -77,6 +77,12 @@ services:
 		class: PHPStan\PhpDoc\Doctrine\EntityRepositoryTypeNodeResolverExtension
 		tags:
 			- phpstan.phpDoc.typeNodeResolverExtension
+	-
+		class: PHPStan\Type\Doctrine\QueryBuilder\Expr\ExpressionBuilderDynamicReturnTypeExtension
+		arguments:
+			argumentsProcessor: @argumentsProcessor
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension
 
 	argumentsProcessor:
 		class: PHPStan\Type\Doctrine\ArgumentsProcessor

phpstan.neon

@@ -14,3 +14,6 @@ parameters:
 		-
 			message: '~^Variable method call on Doctrine\\ORM\\QueryBuilder\.$~'
 			path: */src/Type/Doctrine/QueryBuilder/QueryBuilderGetQueryDynamicReturnTypeExtension.php
+		-
+			message: '~^Variable method call on Doctrine\\ORM\\Query\\Expr\.$~'
+			path: */src/Type/Doctrine/QueryBuilder/Expr/ExpressionBuilderDynamicReturnTypeExtension.php

src/Type/Doctrine/ArgumentsProcessor.php

@@ -33,7 +33,6 @@ public function processArgs(
 				$args[] = $value->getExprObject();
 				continue;
 			}
-			// todo $qb->expr() support
 			if ($value instanceof ConstantArrayType) {
 				$array = [];
 				foreach ($value->getKeyTypes() as $i => $keyType) {

src/Type/Doctrine/QueryBuilder/Expr/ExpressionBuilderDynamicReturnTypeExtension.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\QueryBuilder\Expr;
+
+use Doctrine\ORM\Query\Expr;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Rules\Doctrine\ORM\DynamicQueryBuilderArgumentException;
+use PHPStan\Type\Doctrine\ArgumentsProcessor;
+use PHPStan\Type\Doctrine\ObjectMetadataResolver;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Type;
+
+class ExpressionBuilderDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/** @var ObjectMetadataResolver */
+	private $objectMetadataResolver;
+
+	/** @var \PHPStan\Type\Doctrine\ArgumentsProcessor */
+	private $argumentsProcessor;
+
+	public function __construct(
+		ObjectMetadataResolver $objectMetadataResolver,
+		ArgumentsProcessor $argumentsProcessor
+	)
+	{
+		$this->objectMetadataResolver = $objectMetadataResolver;
+		$this->argumentsProcessor = $argumentsProcessor;
+	}
+
+	public function getClass(): string
+	{
+		return Expr::class;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return true;
+	}
+
+	public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+	{
+		$defaultReturnType = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+
+		$objectManager = $this->objectMetadataResolver->getObjectManager();
+		if ($objectManager === null) {
+			return $defaultReturnType;
+		}
+		$entityManagerInterface = 'Doctrine\ORM\EntityManagerInterface';
+		if (!$objectManager instanceof $entityManagerInterface) {
+			return $defaultReturnType;
+		}
+
+		/** @var \Doctrine\ORM\EntityManagerInterface $objectManager */
+		$objectManager = $objectManager;
+
+		$queryBuilder = $objectManager->createQueryBuilder();
+
+		try {
+			$args = $this->argumentsProcessor->processArgs($scope, $methodReflection->getName(), $methodCall->args);
+		} catch (DynamicQueryBuilderArgumentException $e) {
+			return $defaultReturnType;
+		}
+
+		$exprObject = $queryBuilder->expr()->{$methodReflection->getName()}(...$args);
+
+		return new ExprType(get_class($exprObject), $exprObject);
+	}
+
+}

tests/Rules/Doctrine/ORM/QueryBuilderDqlRuleTest.php

@@ -10,6 +10,7 @@
 use PHPStan\Type\Doctrine\ObjectMetadataResolver;
 use PHPStan\Type\Doctrine\Query\QueryGetDqlDynamicReturnTypeExtension;
 use PHPStan\Type\Doctrine\QueryBuilder\CreateQueryBuilderDynamicReturnTypeExtension;
+use PHPStan\Type\Doctrine\QueryBuilder\Expr\ExpressionBuilderDynamicReturnTypeExtension;
 use PHPStan\Type\Doctrine\QueryBuilder\Expr\NewExprDynamicReturnTypeExtension;
 use PHPStan\Type\Doctrine\QueryBuilder\QueryBuilderGetQueryDynamicReturnTypeExtension;
 use PHPStan\Type\Doctrine\QueryBuilder\QueryBuilderMethodDynamicReturnTypeExtension;
@@ -74,6 +75,10 @@ public function testRule(): void
 				'QueryBuilder: [Semantical Error] line 0, col 60 near \'transient = 1\': Error: Class PHPStan\Rules\Doctrine\ORM\MyEntity has no field or association named transient',
 				170,
 			],
+			[
+				'QueryBuilder: [Semantical Error] line 0, col 72 near \'nickname LIKE\': Error: Class PHPStan\Rules\Doctrine\ORM\MyEntity has no field or association named nickname',
+				194,
+			],
 		]);
 	}
 
@@ -82,11 +87,14 @@ public function testRule(): void
 	 */
 	public function getDynamicMethodReturnTypeExtensions(): array
 	{
+		$objectMetadataResolver = new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null);
+		$argumentsProcessor = new ArgumentsProcessor();
 		return [
 			new CreateQueryBuilderDynamicReturnTypeExtension(null),
 			new QueryBuilderMethodDynamicReturnTypeExtension(null),
-			new QueryBuilderGetQueryDynamicReturnTypeExtension(new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null), new ArgumentsProcessor(), null),
+			new QueryBuilderGetQueryDynamicReturnTypeExtension($objectMetadataResolver, $argumentsProcessor, null),
 			new QueryGetDqlDynamicReturnTypeExtension(),
+			new ExpressionBuilderDynamicReturnTypeExtension($objectMetadataResolver, $argumentsProcessor),
 		];
 	}
 

tests/Rules/Doctrine/ORM/data/query-builder-dql.php

@@ -188,4 +188,16 @@ public function addNewExprBaseCorrect(): void
 			->getQuery();
 	}
 
+	public function qbExpr(): void
+	{
+		$queryBuilder = $this->entityManager->createQueryBuilder();
+		$queryBuilder->select('e')
+			->from(MyEntity::class, 'e')
+			->add('where', $queryBuilder->expr()->orX(
+				$queryBuilder->expr()->eq('e.id', '1'),
+				$queryBuilder->expr()->like('e.nickname', '\'nick\'')
+			))
+			->getQuery();
+	}
+
 }