Merge pull request #164 from franmomu/proxy_generic

Define `Proxy` as generic
doctrine · Apr 5, 2021 · 210e9f5 · 210e9f5
2 parents 12a05f8 + f6575c2
commit 210e9f5
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/lib/Doctrine/Persistence/Mapping/AbstractClassMetadataFactory.php b/lib/Doctrine/Persistence/Mapping/AbstractClassMetadataFactory.php
@@ -472,6 +472,10 @@ protected function getCacheKey(string $realClassName): string
 
     /**
      * Gets the real class name of a class name that could be a proxy.
+     *
+     * @template T of object
+     * @psalm-param class-string<Proxy<T>>|class-string<T> $class
+     * @psalm-return class-string<T>
      */
     private function getRealClass(string $class): string
     {
@@ -485,14 +489,21 @@ private function getRealClass(string $class): string
     private function createDefaultProxyClassNameResolver(): void
     {
         $this->proxyClassNameResolver = new class implements ProxyClassNameResolver {
+            /**
+             * @template T of object
+             * @psalm-param class-string<Proxy<T>>|class-string<T> $className
+             * @psalm-return class-string<T>
+             */
             public function resolveClassName(string $className): string
             {
                 $pos = strrpos($className, '\\' . Proxy::MARKER . '\\');
 
                 if ($pos === false) {
+                    /** @psalm-var class-string<T> */
                     return $className;
                 }
 
+                /** @psalm-var class-string<T> */
                 return substr($className, $pos + Proxy::MARKER_LENGTH + 2);
             }
         };

diff --git a/lib/Doctrine/Persistence/Mapping/ProxyClassNameResolver.php b/lib/Doctrine/Persistence/Mapping/ProxyClassNameResolver.php
@@ -2,11 +2,14 @@
 
 namespace Doctrine\Persistence\Mapping;
 
+use Doctrine\Persistence\Proxy;
+
 interface ProxyClassNameResolver
 {
     /**
-     * @psalm-param class-string $className
-     * @psalm-return class-string
+     * @template T of object
+     * @psalm-param class-string<Proxy<T>>|class-string<T> $className
+     * @psalm-return class-string<T>
      */
     public function resolveClassName(string $className): string;
 }
diff --git a/lib/Doctrine/Persistence/Proxy.php b/lib/Doctrine/Persistence/Proxy.php
@@ -4,6 +4,8 @@
 
 /**
  * Interface for proxy classes.
+ *
+ * @template T of object
  */
 interface Proxy
 {

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -6,3 +6,9 @@ parameters:
             message: "#^Parameter \\#3 \\$nsSeparator of class Doctrine\\\\Persistence\\\\Mapping\\\\Driver\\\\SymfonyFileLocator constructor expects string, null given\\.$#"
             count: 1
             path: tests/Doctrine/Tests/Persistence/Mapping/SymfonyFileLocatorTest.php
+
+        -
+            # Remove it when https://github.com/phpstan/phpstan/issues/4803 is solved
+            message: "#^Method Doctrine\\\\Persistence\\\\Mapping\\\\AbstractClassMetadataFactory\\:\\:getRealClass\\(\\) should return class\\-string\\<T of object\\> but returns class\\-string\\<Doctrine\\\\Persistence\\\\Proxy\\<T of object\\>\\|T of object\\>\\.$#"
+            count: 1
+            path: lib/Doctrine/Persistence/Mapping/AbstractClassMetadataFactory.php
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ @@
     /**
      * Interface for proxy classes.
+     *
+     * @template T of object
      */
     interface Proxy
     {
@@ Expand Down @@