Psalmify QueryBuilder, Query and EntityRepository.

phpstan-baseline.neon

@@ -201,7 +201,7 @@ parameters:
 			path: src/Proxy/ProxyFactory.php
 
 		-
-			message: "#^Parameter \\#2 \\$sqlParams of method Doctrine\\\\ORM\\\\Query\\:\\:evictResultSetCache\\(\\) expects array\\<string, mixed\\>, array\\<int, mixed\\> given\\.$#"
+			message: "#^Parameter \\#2 \\$sqlParams of method Doctrine\\\\ORM\\\\Query<T>\\:\\:evictResultSetCache\\(\\) expects array\\<string, mixed\\>, array\\<int, mixed\\> given\\.$#"
 			count: 1
 			path: src/Query.php
 
@@ -271,7 +271,7 @@ parameters:
 			path: src/Query/SqlWalker.php
 
 		-
-			message: "#^Parameter \\#2 \\$dqlPart of method Doctrine\\\\ORM\\\\QueryBuilder\\:\\:add\\(\\) expects array\\<'join'\\|int, array\\<int\\|string, object\\>\\|string\\>\\|object\\|string, non\\-empty\\-array\\<string, Doctrine\\\\ORM\\\\Query\\\\Expr\\\\Join\\> given\\.$#"
+			message: "#^Parameter \\#2 \\$dqlPart of method Doctrine\\\\ORM\\\\QueryBuilder<T>\\:\\:add\\(\\) expects array\\<'join'\\|int, array\\<int\\|string, object\\>\\|string\\>\\|object\\|string, non\\-empty\\-array\\<string, Doctrine\\\\ORM\\\\Query\\\\Expr\\\\Join\\> given\\.$#"
 			count: 2
 			path: src/QueryBuilder.php
 

src/AbstractQuery.php

@@ -44,6 +44,8 @@
  * Base contract for ORM queries. Base class for Query and NativeQuery.
  *
  * @link    www.doctrine-project.org
+ *
+ * @template T
  */
 abstract class AbstractQuery
 {
@@ -683,6 +685,12 @@ public function getHydrationMode(): string|int
      * Alias for execute(null, $hydrationMode = HYDRATE_OBJECT).
      *
      * @psalm-param string|AbstractQuery::HYDRATE_* $hydrationMode
+     *
+     * @psalm-return (
+     *    $hydrationMode is self::HYDRATE_OBJECT|null
+     *    ? array<array-key, T>
+     *    : mixed
+     * )
      */
     public function getResult(string|int $hydrationMode = self::HYDRATE_OBJECT): mixed
     {
@@ -730,6 +738,12 @@ public function getScalarResult(): array
      *
      * @psalm-param string|AbstractQuery::HYDRATE_*|null $hydrationMode
      *
+     * @psalm-return (
+     *    $hydrationMode is self::HYDRATE_OBJECT|null
+     *    ? T|null
+     *    : mixed
+     * )
+     *
      * @throws NonUniqueResultException
      */
     public function getOneOrNullResult(string|int|null $hydrationMode = null): mixed
@@ -765,6 +779,12 @@ public function getOneOrNullResult(string|int|null $hydrationMode = null): mixed
      *
      * @psalm-param string|AbstractQuery::HYDRATE_*|null $hydrationMode
      *
+     * @psalm-return (
+     *    $hydrationMode is self::HYDRATE_OBJECT|null
+     *    ? T
+     *    : mixed
+     * )
+     *
      * @throws NonUniqueResultException If the query result is not unique.
      * @throws NoResultException        If the query returned no result.
      */

src/EntityRepository.php

@@ -49,6 +49,8 @@ public function __construct(
 
     /**
      * Creates a new QueryBuilder instance that is prepopulated for this entity name.
+     *
+     * @return QueryBuilder<T>
      */
     public function createQueryBuilder(string $alias, string|null $indexBy = null): QueryBuilder
     {

src/NativeQuery.php

@@ -16,6 +16,7 @@
  * Represents a native SQL query.
  *
  * @final
+ * @extends AbstractQuery<mixed>
  */
 class NativeQuery extends AbstractQuery
 {

src/Query.php

@@ -37,6 +37,8 @@
 /**
  * A Query object represents a DQL query.
  *
+ * @template T
+ * @extends AbstractQuery<T>
  * @final
  */
 class Query extends AbstractQuery

src/QueryBuilder.php

@@ -38,6 +38,8 @@
 /**
  * This class is responsible for building DQL query strings via an object oriented
  * PHP interface.
+ *
+ * @template T
  */
 class QueryBuilder implements Stringable
 {
@@ -251,6 +253,8 @@ public function getDQL(): string
      *     $q = $qb->getQuery();
      *     $results = $q->execute();
      * </code>
+     *
+     * @psalm-return Query<T>
      */
     public function getQuery(): Query
     {
@@ -613,6 +617,11 @@ public function add(string $dqlPartName, string|object|array $dqlPart, bool $app
      * </code>
      *
      * @return $this
+     * @psalm-return static<mixed>
+     * @phpstan-return $this<mixed>
+     *
+     * @psalm-this-out static<mixed>
+     * @phpstan-this-out $this<mixed>
      */
     public function select(mixed ...$select): static
     {

tests/StaticAnalysis/query-builder.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM;
+
+class Cat
+{
+}
+
+/** @extends EntityRepository<Cat> */
+class CatRepository extends EntityRepository
+{
+}
+
+/** @return array<array-key, Cat> */
+function getResultAsEntities(CatRepository $catRepository): array
+{
+    return $catRepository->createQueryBuilder('c')->getQuery()->getResult();
+}
+
+function getOneOrNullEntity(CatRepository $catRepository): Cat|null
+{
+    return $catRepository->createQueryBuilder('c')->getQuery()->getOneOrNullResult();
+}
+
+function getSingleEntity(CatRepository $catRepository): Cat
+{
+    return $catRepository->createQueryBuilder('c')->getQuery()->getSingleResult();
+}
+
+/**
+ * Once QueryBuilder::select is called, all results will be mixed. User must manually assert returned type.
+ *
+ * @see QueryBuilder::select()
+ */
+function getMixedResults(CatRepository $catRepository): mixed
+{
+    return $catRepository->createQueryBuilder('c')
+        ->select('c.id')
+        ->getQuery()->getResult();
+}
+
+function getMixedOrNullResult(CatRepository $catRepository): mixed
+{
+    return $catRepository->createQueryBuilder('c')
+        ->select('c.id')
+        ->getQuery()->getOneOrNullResult();
+}
+
+function getMixedResult(CatRepository $catRepository): mixed
+{
+    return $catRepository->createQueryBuilder('c')
+        ->select('c.id')
+        ->getQuery()->getSingleResult();
+}