Raise Psalm level to 3 and add generics to ClassMetadata

lib/Doctrine/Persistence/AbstractManagerRegistry.php

@@ -29,7 +29,10 @@ abstract class AbstractManagerRegistry implements ManagerRegistry
     /** @var string */
     private $defaultManager;
 
-    /** @var string */
+    /**
+     * @var string
+     * @psalm-var class-string
+     */
     private $proxyInterfaceName;
 
     /**
@@ -39,6 +42,8 @@ abstract class AbstractManagerRegistry implements ManagerRegistry
      * @param string   $defaultConnection
      * @param string   $defaultManager
      * @param string   $proxyInterfaceName
+     *
+     * @psalm-param class-string $proxyInterfaceName
      */
     public function __construct($name, array $connections, array $managers, $defaultConnection, $defaultManager, $proxyInterfaceName)
     {
@@ -158,13 +163,9 @@ public function getManager($name = null)
      */
     public function getManagerForClass($class)
     {
-        // Check for namespace alias
-        if (strpos($class, ':') !== false) {
-            [$namespaceAlias, $simpleClassName] = explode(':', $class, 2);
-            $class                              = $this->getAliasNamespace($namespaceAlias) . '\\' . $simpleClassName;
-        }
+        $className = $this->getRealClassName($class);
 
-        $proxyClass = new ReflectionClass($class);
+        $proxyClass = new ReflectionClass($className);
 
         if ($proxyClass->implementsInterface($this->proxyInterfaceName)) {
             $parentClass = $proxyClass->getParentClass();
@@ -173,20 +174,39 @@ public function getManagerForClass($class)
                 return null;
             }
 
-            $class = $parentClass->getName();
+            $className = $parentClass->getName();
         }
 
         foreach ($this->managers as $id) {
             $manager = $this->getService($id);
 
-            if (! $manager->getMetadataFactory()->isTransient($class)) {
+            if (! $manager->getMetadataFactory()->isTransient($className)) {
                 return $manager;
             }
         }
 
         return null;
     }
 
+    /**
+     * @param string $className
+     *
+     * @psalm-return class-string
+     */
+    private function getRealClassName($className): string
+    {
+        // Check for namespace alias
+        if (strpos($className, ':') !== false) {
+            [$namespaceAlias, $simpleClassName] = explode(':', $className, 2);
+
+            /** @psalm-var class-string */
+            return $this->getAliasNamespace($namespaceAlias) . '\\' . $simpleClassName;
+        }
+
+        /** @psalm-var class-string */
+        return $className;
+    }
+
     /**
      * {@inheritdoc}
      */

lib/Doctrine/Persistence/Mapping/AbstractClassMetadataFactory.php

@@ -17,6 +17,7 @@
 use function array_map;
 use function array_reverse;
 use function array_unshift;
+use function assert;
 use function explode;
 use function sprintf;
 use function str_replace;
@@ -163,6 +164,8 @@ abstract protected function initialize();
      * @param string $simpleClassName
      *
      * @return string
+     *
+     * @psalm-return class-string
      */
     abstract protected function getFqcnFromAlias($namespaceAlias, $simpleClassName);
 
@@ -218,6 +221,7 @@ public function getMetadataFor($className)
 
             $realClassName = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName);
         } else {
+            /** @psalm-var class-string $className */
             $realClassName = $this->getRealClass($className);
         }
 
@@ -307,6 +311,8 @@ public function setMetadataFor($className, $class)
      * @param string $name
      *
      * @return string[]
+     *
+     * @psalm-param class-string $name
      */
     protected function getParentClasses($name)
     {
@@ -337,6 +343,8 @@ protected function getParentClasses($name)
      * @param string $name The name of the class for which the metadata should get loaded.
      *
      * @return string[]
+     *
+     * @psalm-param class-string $name
      */
     protected function loadMetadata($name)
     {
@@ -483,6 +491,8 @@ private function getRealClass(string $class): string
             $this->createDefaultProxyClassNameResolver();
         }
 
+        assert($this->proxyClassNameResolver !== null);
+
         return $this->proxyClassNameResolver->resolveClassName($class);
     }
 

lib/Doctrine/Persistence/Mapping/ClassMetadata.php

@@ -6,13 +6,17 @@
 
 /**
  * Contract for a Doctrine persistence layer ClassMetadata class to implement.
+ *
+ * @template T of object
  */
 interface ClassMetadata
 {
     /**
      * Gets the fully-qualified class name of this persistent class.
      *
      * @return string
+     *
+     * @psalm-return class-string<T>
      */
     public function getName();
 
@@ -28,7 +32,7 @@ public function getIdentifier();
     /**
      * Gets the ReflectionClass instance for this mapped class.
      *
-     * @return ReflectionClass
+     * @return ReflectionClass<T>
      */
     public function getReflectionClass();
 

lib/Doctrine/Persistence/Mapping/ClassMetadataFactory.php

@@ -48,6 +48,8 @@ public function setMetadataFor($className, $class);
      * @param string $className
      *
      * @return bool
+     *
+     * @psalm-param class-string $className
      */
     public function isTransient($className);
 }

lib/Doctrine/Persistence/Mapping/Driver/AnnotationDriver.php

@@ -66,7 +66,7 @@ abstract class AnnotationDriver implements MappingDriver
     /**
      * Name of the entity annotations as keys.
      *
-     * @var string[]
+     * @var array<class-string, bool|int>
      */
     protected $entityAnnotationClasses = [];
 
@@ -170,9 +170,7 @@ public function setFileExtension($fileExtension)
      * A class is non-transient if it is annotated with an annotation
      * from the {@see AnnotationDriver::entityAnnotationClasses}.
      *
-     * @param string $className
-     *
-     * @return bool
+     * {@inheritDoc}
      */
     public function isTransient($className)
     {

lib/Doctrine/Persistence/Mapping/Driver/MappingDriver.php

@@ -32,6 +32,8 @@ public function getAllClassNames();
      * @param string $className
      *
      * @return bool
+     *
+     * @psalm-param class-string $className
      */
     public function isTransient($className);
 }

lib/Doctrine/Persistence/Mapping/Driver/SymfonyFileLocator.php

@@ -227,6 +227,6 @@ public function findMappingFile($className)
             }
         }
 
-        throw MappingException::mappingFileNotFound($className, substr($className, strrpos($className, '\\') + 1) . $this->fileExtension);
+        throw MappingException::mappingFileNotFound($className, substr($className, (int) strrpos($className, '\\') + 1) . $this->fileExtension);
     }
 }

lib/Doctrine/Persistence/Mapping/MappingException.php

@@ -49,8 +49,8 @@ public static function fileMappingDriversRequireConfiguredDirectoryPath($path =
 
         return new self(sprintf(
             'File mapping drivers must have a valid directory path, ' .
-            'however the given path %s seems to be incorrect!',
-            $path
+            'however the given path "%s" seems to be incorrect!',
+            (string) $path
         ));
     }
 

lib/Doctrine/Persistence/Mapping/ReflectionService.php

@@ -21,6 +21,9 @@ interface ReflectionService
      * @return string[]
      *
      * @throws MappingException
+     *
+     * @psalm-param class-string $class
+     * @psalm-return class-string[]
      */
     public function getParentClasses($class);
 
@@ -30,13 +33,17 @@ public function getParentClasses($class);
      * @param string $class
      *
      * @return string
+     *
+     * @psalm-param class-string $class
      */
     public function getClassShortName($class);
 
     /**
      * @param string $class
      *
      * @return string
+     *
+     * @psalm-param class-string $class
      */
     public function getClassNamespace($class);
 
@@ -46,6 +53,8 @@ public function getClassNamespace($class);
      * @param string $class
      *
      * @return ReflectionClass|null
+     *
+     * @psalm-param class-string $class
      */
     public function getClass($class);
 
@@ -56,6 +65,8 @@ public function getClass($class);
      * @param string $property
      *
      * @return ReflectionProperty|null
+     *
+     * @psalm-param class-string $class
      */
     public function getAccessibleProperty($class, $property);
 
@@ -66,6 +77,8 @@ public function getAccessibleProperty($class, $property);
      * @param mixed $method
      *
      * @return bool
+     *
+     * @psalm-param class-string $class
      */
     public function hasPublicMethod($class, $method);
 }

lib/Doctrine/Persistence/Mapping/RuntimeReflectionService.php

@@ -62,6 +62,8 @@ public function getClassNamespace($class)
 
     /**
      * {@inheritDoc}
+     *
+     * @return ReflectionClass
      */
     public function getClass($class)
     {

lib/Doctrine/Persistence/Mapping/StaticReflectionService.php

@@ -25,8 +25,10 @@ public function getParentClasses($class)
      */
     public function getClassShortName($className)
     {
-        if (strpos($className, '\\') !== false) {
-            $className = substr($className, strrpos($className, '\\') + 1);
+        $nsSeparatorPosition = strrpos($className, '\\');
+
+        if ($nsSeparatorPosition !== false) {
+            $className = substr($className, $nsSeparatorPosition + 1);
         }
 
         return $className;
@@ -39,7 +41,7 @@ public function getClassNamespace($className)
     {
         $namespace = '';
         if (strpos($className, '\\') !== false) {
-            $namespace = strrev(substr(strrev($className), strpos(strrev($className), '\\') + 1));
+            $namespace = strrev(substr(strrev($className), (int) strpos(strrev($className), '\\') + 1));
         }
 
         return $namespace;

lib/Doctrine/Persistence/Reflection/TypedNoDefaultReflectionProperty.php

@@ -2,8 +2,11 @@
 
 namespace Doctrine\Persistence\Reflection;
 
+use Closure;
 use ReflectionProperty;
 
+use function assert;
+
 /**
  * PHP Typed No Default Reflection Property - special override for typed properties without a default value.
  */
@@ -38,6 +41,9 @@ public function setValue($object, $value = null)
                 unset($this->$propertyName);
             };
             $unsetter = $unsetter->bindTo($object, $this->getDeclaringClass()->getName());
+
+            assert($unsetter instanceof Closure);
+
             $unsetter();
 
             return;

phpstan-baseline.neon

@@ -12,3 +12,8 @@ parameters:
             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
+
+        -
+            message: "#^Parameter \\#1 \\$class of method Doctrine\\\\Persistence\\\\Mapping\\\\RuntimeReflectionService\\:\\:getParentClasses\\(\\) expects class-string, string given.$#"
+            count: 1
+            path: tests/Doctrine/Tests/Persistence/Mapping/RuntimeReflectionServiceTest.php

psalm.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <psalm
     totallyTyped="false"
-    errorLevel="4"
+    errorLevel="3"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
@@ -39,5 +39,25 @@
                 <file name="tests/Doctrine/Tests/Persistence/Mapping/SymfonyFileLocatorTest.php"/>
             </errorLevel>
         </NullArgument>
+        <PossiblyNullReference>
+            <errorLevel type="suppress">
+                <!-- ReflectionProperty::getType() can return null, but there is ReflectionProperty::hasType()
+                check before -->
+                <file name="lib/Doctrine/Persistence/Reflection/TypedNoDefaultReflectionProperty.php"/>
+            </errorLevel>
+        </PossiblyNullReference>
+        <ArgumentTypeCoercion>
+            <errorLevel type="suppress">
+                <!-- On purpose to use a non existing class for tests -->
+                <referencedFunction name="RuntimeReflectionServiceTest::testGetParentClassesForAbsentClass"/>
+                <file name="tests/Doctrine/Tests/Persistence/Mapping/RuntimeReflectionServiceTest.php"/>
+            </errorLevel>
+        </ArgumentTypeCoercion>
+        <MoreSpecificReturnType>
+            <errorLevel type="suppress">
+                <!-- FileDriver::loadMappingFile() in tests could have a more specific return, but is not needed -->
+                <file name="tests/Doctrine/Tests/Persistence/Mapping/FileDriverTest.php"/>
+            </errorLevel>
+        </MoreSpecificReturnType>
     </issueHandlers>
 </psalm>

tests/Doctrine/Tests/Persistence/Mapping/AnnotationDriverTest.php

@@ -24,7 +24,7 @@ public function testGetAllClassNames(): void
 
 class SimpleAnnotationDriver extends AnnotationDriver
 {
-    /** @var bool[] */
+    /** @var array<class-string, bool|int> */
     protected $entityAnnotationClasses = [Entity::class => true];
 
     /**