From 399b69a309f98769724f3a395bb72fc39f2aa5b0 Mon Sep 17 00:00:00 2001
From: Simon Podlipsky <simon@podlipsky.net>
Date: Sat, 11 Sep 2021 13:53:20 +0200
Subject: [PATCH] Fix return type at
 `EntityManagerInterface::get(Partial)Reference()` (#8922)

---
 lib/Doctrine/ORM/EntityManagerInterface.php |  9 +++++++--
 phpstan-baseline.neon                       | 14 ++++++++++++--
 psalm-baseline.xml                          |  8 ++++++--
 3 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/lib/Doctrine/ORM/EntityManagerInterface.php b/lib/Doctrine/ORM/EntityManagerInterface.php
index fafa33abaf3..1358f435745 100644
--- a/lib/Doctrine/ORM/EntityManagerInterface.php
+++ b/lib/Doctrine/ORM/EntityManagerInterface.php
@@ -23,6 +23,7 @@
 use BadMethodCallException;
 use DateTimeInterface;
 use Doctrine\Common\EventManager;
+use Doctrine\Common\Proxy\Proxy;
 use Doctrine\DBAL\Connection;
 use Doctrine\ORM\Internal\Hydration\AbstractHydrator;
 use Doctrine\ORM\Proxy\ProxyFactory;
@@ -169,7 +170,7 @@ public function createQueryBuilder();
      * @psalm-param class-string<T> $entityName
      *
      * @return object|null The entity reference.
-     * @psalm-return ?T
+     * @psalm-return (T&Proxy)|null
      *
      * @throws ORMException
      *
@@ -194,8 +195,12 @@ public function getReference($entityName, $id);
      *
      * @param string $entityName The name of the entity type.
      * @param mixed  $identifier The entity identifier.
+     * @psalm-param class-string<T> $entityName
+     *
+     * @return object|null The (partial) entity reference
+     * @psalm-return (T&Proxy)|null
      *
-     * @return object|null The (partial) entity reference.
+     * @template T
      */
     public function getPartialReference($entityName, $identifier);
 
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
index 05c22cfdcbc..f54e5aba1ff 100644
--- a/phpstan-baseline.neon
+++ b/phpstan-baseline.neon
@@ -161,12 +161,22 @@ parameters:
 			path: lib/Doctrine/ORM/EntityManager.php
 
 		-
-			message: "#^Method Doctrine\\\\ORM\\\\EntityManager\\:\\:getReference\\(\\) should return T\\|null but returns Doctrine\\\\Common\\\\Proxy\\\\Proxy\\.$#"
+			message: "#^Method Doctrine\\\\ORM\\\\EntityManager\\:\\:getPartialReference\\(\\) should return \\(Doctrine\\\\Common\\\\Proxy\\\\Proxy&T\\)\\|null but returns object\\.$#"
 			count: 1
 			path: lib/Doctrine/ORM/EntityManager.php
 
 		-
-			message: "#^Method Doctrine\\\\ORM\\\\EntityManager\\:\\:getReference\\(\\) should return T\\|null but returns object\\|null\\.$#"
+			message: "#^Method Doctrine\\\\ORM\\\\EntityManager\\:\\:getPartialReference\\(\\) should return \\(Doctrine\\\\Common\\\\Proxy\\\\Proxy&T\\)\\|null but returns object\\|null\\.$#"
+			count: 1
+			path: lib/Doctrine/ORM/EntityManager.php
+
+		-
+			message: "#^Method Doctrine\\\\ORM\\\\EntityManager\\:\\:getReference\\(\\) should return \\(Doctrine\\\\Common\\\\Proxy\\\\Proxy&T\\)\\|null but returns Doctrine\\\\Common\\\\Proxy\\\\Proxy\\.$#"
+			count: 1
+			path: lib/Doctrine/ORM/EntityManager.php
+
+		-
+			message: "#^Method Doctrine\\\\ORM\\\\EntityManager\\:\\:getReference\\(\\) should return \\(Doctrine\\\\Common\\\\Proxy\\\\Proxy&T\\)\\|null but returns object\\|null\\.$#"
 			count: 1
 			path: lib/Doctrine/ORM/EntityManager.php
 
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
index 3a0372a450b..6354a33983b 100644
--- a/psalm-baseline.xml
+++ b/psalm-baseline.xml
@@ -487,18 +487,22 @@
       <code>is_object($entity)</code>
       <code>is_object($entity)</code>
     </DocblockTypeContradiction>
-    <InvalidReturnStatement occurrences="7">
+    <InvalidReturnStatement occurrences="10">
       <code>$entity</code>
       <code>$entity</code>
       <code>$entity</code>
+      <code>$entity</code>
+      <code>$entity instanceof $class-&gt;name ? $entity : null</code>
       <code>$entity instanceof $class-&gt;name ? $entity : null</code>
       <code>$persister-&gt;load($sortedId, null, null, [], $lockMode)</code>
       <code>$persister-&gt;loadById($sortedId)</code>
+      <code>$this-&gt;find($entityName, $sortedId)</code>
       <code>$this-&gt;metadataFactory-&gt;getMetadataFor($className)</code>
     </InvalidReturnStatement>
-    <InvalidReturnType occurrences="3">
+    <InvalidReturnType occurrences="4">
       <code>?T</code>
       <code>getClassMetadata</code>
+      <code>getPartialReference</code>
       <code>getReference</code>
     </InvalidReturnType>
     <InvalidScalarArgument occurrences="2">