Introduce default hydration mode

Author: VincentLanglet

src/Type/Doctrine/HydrationModeReturnTypeResolver.php

@@ -3,7 +3,6 @@
 namespace PHPStan\Type\Doctrine;
 
 use Doctrine\ORM\AbstractQuery;
-use Doctrine\Persistence\ObjectManager;
 use PHPStan\Type\Accessory\AccessoryArrayListType;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\BenevolentUnionType;
@@ -25,7 +24,7 @@ public function getMethodReturnTypeForHydrationMode(
 		Type $hydrationMode,
 		Type $queryKeyType,
 		Type $queryResultType,
-		?ObjectManager $objectManager
+		?Type $defaultHydrationModeType = null
 	): ?Type
 	{
 		$isVoidType = (new VoidType())->isSuperTypeOf($queryResultType);
@@ -42,6 +41,10 @@ public function getMethodReturnTypeForHydrationMode(
 			return null;
 		}
 
+		if ($defaultHydrationModeType !== null && $hydrationMode->isNull()->yes()) {
+			$hydrationMode = $defaultHydrationModeType;
+		}
+
 		if (!$hydrationMode instanceof ConstantIntegerType) {
 			return null;
 		}

src/Type/Doctrine/Query/QueryResultDynamicReturnTypeExtension.php

@@ -9,7 +9,6 @@
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Doctrine\HydrationModeReturnTypeResolver;
-use PHPStan\Type\Doctrine\ObjectMetadataResolver;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
 use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
@@ -27,16 +26,12 @@ final class QueryResultDynamicReturnTypeExtension implements DynamicMethodReturn
 		'getSingleResult' => 0,
 	];
 
-	private ObjectMetadataResolver $objectMetadataResolver;
-
 	private HydrationModeReturnTypeResolver $hydrationModeReturnTypeResolver;
 
 	public function __construct(
-		ObjectMetadataResolver $objectMetadataResolver,
 		HydrationModeReturnTypeResolver $hydrationModeReturnTypeResolver
 	)
 	{
-		$this->objectMetadataResolver = $objectMetadataResolver;
 		$this->hydrationModeReturnTypeResolver = $hydrationModeReturnTypeResolver;
 	}
 
@@ -84,7 +79,7 @@ public function getTypeFromMethodCall(
 			$hydrationMode,
 			$queryType->getTemplateType(AbstractQuery::class, 'TKey'),
 			$queryType->getTemplateType(AbstractQuery::class, 'TResult'),
-			$this->objectMetadataResolver->getObjectManager(),
+			$queryType->getTemplateType(AbstractQuery::class, 'THydrationMode'),
 		);
 	}
 

src/Type/Doctrine/Query/QueryType.php

@@ -15,16 +15,25 @@ class QueryType extends GenericObjectType
 
 	private Type $resultType;
 
+	private Type $defaultHydrationModeType;
+
 	private string $dql;
 
-	public function __construct(string $dql, ?Type $indexType = null, ?Type $resultType = null, ?Type $subtractedType = null)
-	{
+	public function __construct(
+		string $dql,
+		?Type $indexType = null,
+		?Type $resultType = null,
+		?Type $subtractedType = null,
+		?Type $defaultHydrationModeType = null
+	) {
 		$this->indexType = $indexType ?? new MixedType();
 		$this->resultType = $resultType ?? new MixedType();
+		$this->defaultHydrationModeType = $defaultHydrationModeType ?? new MixedType();
 
 		parent::__construct('Doctrine\ORM\Query', [
 			$this->indexType,
 			$this->resultType,
+			$this->defaultHydrationModeType,
 		], $subtractedType);
 
 		$this->dql = $dql;
@@ -41,7 +50,7 @@ public function equals(Type $type): bool
 
 	public function changeSubtractedType(?Type $subtractedType): Type
 	{
-		return new self('Doctrine\ORM\Query', $this->indexType, $this->resultType, $subtractedType);
+		return new self('Doctrine\ORM\Query', $this->indexType, $this->resultType, $subtractedType, $this->defaultHydrationModeType);
 	}
 
 	public function isSuperTypeOf(Type $type): IsSuperTypeOfResult

stubs/ORM/AbstractQuery.stub

@@ -9,6 +9,7 @@ use Doctrine\ORM\NoResultException;
 /**
  * @template-covariant TKey The type of column used in indexBy
  * @template-covariant TResult The type of results returned by this query in HYDRATE_OBJECT mode
+ * @template-covariant THydrationMode = AbstractQuery::HYDRATE_OBJECT The default hydration mode when none is provided
  */
 abstract class AbstractQuery
 {
@@ -84,4 +85,13 @@ abstract class AbstractQuery
     {
     }
 
+    /**
+     * @template TNewHydrationMode of string|AbstractQuery::HYDRATE_*
+     * @param TNewHydrationMode $hydrationMode
+     * @phpstan-self-out self<TKey, TResult, TNewHydrationMode>
+     */
+    public function setHydrationMode(string|int $hydrationMode): static
+    {
+    }
+
 }

stubs/ORM/Query.stub

@@ -5,8 +5,9 @@ namespace Doctrine\ORM;
 /**
  * @template-covariant TKey The type of column used in indexBy
  * @template-covariant TResult The type of results returned by this query in HYDRATE_OBJECT mode
+ * @template-covariant THydrationMode = AbstractQuery::HYDRATE_OBJECT The default hydration mode when none is provided
  *
- * @extends AbstractQuery<TKey, TResult>
+ * @extends AbstractQuery<TKey, TResult, THydrationMode>
  */
 final class Query extends AbstractQuery
 {

tests/Type/Doctrine/Query/QueryResultTypeWalkerHydrationModeTest.php

@@ -91,7 +91,6 @@ public function test(Type $expectedType, string $dql, string $methodName, ?int $
 			new ConstantIntegerType($this->getRealHydrationMode($methodName, $hydrationMode)),
 			$typeBuilder->getIndexType(),
 			$typeBuilder->getResultType(),
-			$entityManager,
 		) ?? new MixedType();
 
 		self::assertSame(