Merge pull request #180 from greg0ire/phpstan-lvl-7

Phpstan lvl 7

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Circular dependency
+
+This package has a development dependency on `doctrine/common`, which has a
+regular dependency on this package (`^2.0` at the time of writing).
+
+To be able to use Composer, one has to let it understand that this is version 2
+(even when developing on 3.0.x), as follows:
+
+```shell
+COMPOSER_ROOT_VERSION=2.0 composer update -v
+```

lib/Doctrine/Common/Persistence/PersistentObject.php

@@ -51,7 +51,10 @@ abstract class PersistentObject implements ObjectManagerAware
     /** @var ObjectManager|null */
     private static $objectManager = null;
 
-    /** @var ClassMetadata|null */
+    /**
+     * @var ClassMetadata<object>|null
+     * @psalm-var ClassMetadata<object>|null
+     */
     private $cm = null;
 
     /**
@@ -141,6 +144,7 @@ private function get($field)
      * @param string $field
      * @param string $targetClass
      * @param object $targetObject
+     * @psalm-param class-string $targetClass
      *
      * @return void
      */

lib/Doctrine/Persistence/AbstractManagerRegistry.php

@@ -238,6 +238,9 @@ public function resetManager($name = null)
         return $this->getManager($name);
     }
 
+    /**
+     * @psalm-param class-string $persistentObjectName
+     */
     private function selectManager(string $persistentObjectName, ?string $persistentManagerName = null): ObjectManager
     {
         if ($persistentManagerName !== null) {

lib/Doctrine/Persistence/Event/LoadClassMetadataEventArgs.php

@@ -11,12 +11,18 @@
  */
 class LoadClassMetadataEventArgs extends EventArgs
 {
-    /** @var ClassMetadata */
+    /**
+     * @var ClassMetadata
+     * @psalm-var ClassMetadata<object>
+     */
     private $classMetadata;
 
     /** @var ObjectManager */
     private $objectManager;
 
+    /**
+     * @psalm-param ClassMetadata<object> $classMetadata
+     */
     public function __construct(ClassMetadata $classMetadata, ObjectManager $objectManager)
     {
         $this->classMetadata = $classMetadata;
@@ -27,6 +33,7 @@ public function __construct(ClassMetadata $classMetadata, ObjectManager $objectM
      * Retrieves the associated ClassMetadata.
      *
      * @return ClassMetadata
+     * @psalm-return ClassMetadata<object>
      */
     public function getClassMetadata()
     {

lib/Doctrine/Persistence/Mapping/AbstractClassMetadataFactory.php

@@ -19,6 +19,7 @@
 use function array_unshift;
 use function assert;
 use function explode;
+use function is_array;
 use function sprintf;
 use function str_replace;
 use function strpos;
@@ -251,6 +252,7 @@ public function getMetadataFor($className)
                         array_map([$this, 'getCacheKey'], $loadedMetadata),
                         $loadedMetadata
                     );
+                    assert(is_array($classNames));
 
                     foreach ($this->cache->getItems(array_keys($classNames)) as $item) {
                         if (! isset($classNames[$item->getKey()])) {

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

@@ -13,6 +13,7 @@
 
 use function array_merge;
 use function array_unique;
+use function assert;
 use function get_class;
 use function get_declared_classes;
 use function in_array;
@@ -223,7 +224,9 @@ public function getAllClassNames()
                 }
 
                 foreach ($this->excludePaths as $excludePath) {
-                    $exclude = str_replace('\\', '/', realpath($excludePath));
+                    $realExcludePath = realpath($excludePath);
+                    assert($realExcludePath !== false);
+                    $exclude = str_replace('\\', '/', $realExcludePath);
                     $current = str_replace('\\', '/', $sourceFile);
 
                     if (strpos($current, $exclude) !== false) {

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

@@ -24,7 +24,10 @@ abstract class FileDriver implements MappingDriver
     /** @var FileLocator */
     protected $locator;
 
-    /** @var ClassMetadata[]|null */
+    /**
+     * @var ClassMetadata[]|null
+     * @psalm-var ClassMetadata<object>[]|null
+     */
     protected $classCache;
 
     /** @var string|null */
@@ -76,6 +79,7 @@ public function getGlobalBasename()
      * @param string $className
      *
      * @return ClassMetadata The element of schema meta data.
+     * @psalm-return ClassMetadata<object>
      *
      * @throws MappingException
      */
@@ -141,7 +145,7 @@ public function getAllClassNames()
      * @param string $file The mapping file to load.
      *
      * @return ClassMetadata[]
-     * @psalm-return array<class-string, ClassMetadata>
+     * @psalm-return array<class-string, ClassMetadata<object>>
      */
     abstract protected function loadMappingFile($file);
 

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

@@ -13,6 +13,7 @@ interface MappingDriver
      * Loads the metadata for the specified class into the provided container.
      *
      * @param string $className
+     * @psalm-param ClassMetadata<object> $metadata
      *
      * @return void
      */

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

@@ -10,7 +10,10 @@
  */
 class PHPDriver extends FileDriver
 {
-    /** @var ClassMetadata */
+    /**
+     * @var ClassMetadata
+     * @psalm-var ClassMetadata<object>
+     */
     protected $metadata;
 
     /**

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

@@ -9,6 +9,7 @@
 
 use function array_keys;
 use function array_merge;
+use function assert;
 use function is_dir;
 use function is_file;
 use function realpath;
@@ -183,8 +184,12 @@ public function getAllClassNames($globalBasename = null)
                     // NOTE: All files found here means classes are not transient!
                     if (isset($this->prefixes[$path])) {
                         // Calculate namespace suffix for given prefix as a relative path from basepath to file path
+                        $basepath = realpath($path);
+                        $filepath = realpath($file->getPath());
+                        assert($basepath !== false);
+                        assert($filepath !== false);
                         $nsSuffix = strtr(
-                            substr(realpath($file->getPath()), strlen(realpath($path))),
+                            substr($filepath, strlen($basepath)),
                             $this->nsSeparator,
                             '\\'
                         );

lib/Doctrine/Persistence/Mapping/ReflectionService.php

@@ -48,9 +48,12 @@ public function getClassNamespace($class);
      * Returns a reflection class instance or null.
      *
      * @param string $class
-     * @psalm-param class-string $class
+     * @psalm-param class-string<T> $class
      *
      * @return ReflectionClass|null
+     * @psalm-return ReflectionClass<T>|null
+     *
+     * @template T of object
      */
     public function getClass($class);
 

lib/Doctrine/Persistence/Mapping/RuntimeReflectionService.php

@@ -10,6 +10,7 @@
 use ReflectionProperty;
 
 use function array_key_exists;
+use function assert;
 use function class_exists;
 use function class_parents;
 use function phpversion;
@@ -37,7 +38,11 @@ public function getParentClasses($class)
             throw MappingException::nonExistingClass($class);
         }
 
-        return class_parents($class);
+        $parents = class_parents($class);
+
+        assert($parents !== false);
+
+        return $parents;
     }
 
     /**
@@ -62,9 +67,12 @@ public function getClassNamespace($class)
 
     /**
      * @param string $class
-     * @psalm-param class-string $class
+     * @psalm-param class-string<T> $class
      *
      * @return ReflectionClass
+     * @psalm-return ReflectionClass<T>
+     *
+     * @template T of object
      */
     public function getClass($class)
     {

lib/Doctrine/Persistence/Mapping/StaticReflectionService.php

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

lib/Doctrine/Persistence/ObjectManager.php

@@ -144,6 +144,7 @@ public function getClassMetadata($className);
      * Gets the metadata factory used to gather the metadata of classes.
      *
      * @return ClassMetadataFactory
+     * @psalm-return ClassMetadataFactory<ClassMetadata<object>>
      */
     public function getMetadataFactory();
 

lib/Doctrine/Persistence/ObjectManagerAware.php

@@ -23,6 +23,8 @@ interface ObjectManagerAware
     /**
      * Injects responsible ObjectManager and the ClassMetadata into this persistent object.
      *
+     * @psalm-param ClassMetadata<object> $classMetadata
+     *
      * @return void
      */
     public function injectObjectManager(ObjectManager $objectManager, ClassMetadata $classMetadata);

lib/Doctrine/Persistence/Reflection/RuntimePublicReflectionProperty.php

@@ -40,6 +40,9 @@ public function getValue($object = null)
      * is a {@see \Doctrine\Common\Proxy\Proxy}.
      *
      * @link https://bugs.php.net/bug.php?id=63463
+     *
+     * @param object $object
+     * @param mixed  $value
      */
     public function setValue($object, $value = null)
     {

lib/Doctrine/Persistence/Reflection/TypedNoDefaultReflectionProperty.php

@@ -18,6 +18,8 @@ class TypedNoDefaultReflectionProperty extends ReflectionProperty
      * Checks that a typed property is initialized before accessing its value.
      * This is necessary to avoid PHP error "Error: Typed property must not be accessed before initialization".
      * Should be used only for reflecting typed properties without a default value.
+     *
+     * @param object $object
      */
     public function getValue($object = null)
     {
@@ -31,6 +33,8 @@ public function getValue($object = null)
      * NULL which is not supported, instead unset() to uninitialize.
      *
      * @link https://github.com/doctrine/orm/issues/7999
+     *
+     * @param object $object
      */
     public function setValue($object, $value = null)
     {

phpstan-baseline.neon

@@ -13,3 +13,10 @@ parameters:
             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
+
+        -
+            message: '#Method Doctrine\\Persistence\\AbstractManagerRegistry\:\:getRealClassName\(\) should return class\-string but returns string\.#'
+            path: 'lib/Doctrine/Persistence/AbstractManagerRegistry.php'
+        -
+            message: '#Method Doctrine\\Tests\\Persistence\\Mapping\\TestClassMetadataFactory\:\:getFqcnFromAlias\(\) should return class\-string but returns string\.#'
+            path: 'tests/Doctrine/Tests/Persistence/Mapping/TestClassMetadataFactory.php'

phpstan.neon

@@ -2,11 +2,11 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 7
 
     paths:
         - lib
         - tests
 
     excludes_analyse:
-        - %currentWorkingDirectory%/tests/Doctrine/Tests/Persistence/Mapping/_files/TestEntity.php
+        - tests/Doctrine/Tests/Persistence/Mapping/_files/TestEntity.php

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

@@ -24,12 +24,17 @@
  */
 class ClassMetadataFactoryTest extends DoctrineTestCase
 {
-    /** @var TestClassMetadataFactory */
+    /**
+     * @var TestClassMetadataFactory
+     * @psalm-var TestClassMetadataFactory<ClassMetadata<object>>
+     */
     private $cmf;
 
     protected function setUp(): void
     {
-        $driver    = $this->createMock(MappingDriver::class);
+        $driver = $this->createMock(MappingDriver::class);
+
+        /** @psalm-var ClassMetadata<object> */
         $metadata  = $this->createMock(ClassMetadata::class);
         $this->cmf = new TestClassMetadataFactory($driver, $metadata);
     }
@@ -242,6 +247,9 @@ public function testWillNotCacheFallbackMetadata(): void
         self::assertSame($metadata, $this->cmf->getMetadataFor('Foo'));
     }
 
+    /**
+     * @psalm-param AbstractClassMetadataFactory<ClassMetadata<object>> $classMetadataFactory
+     */
     private static function getCache(AbstractClassMetadataFactory $classMetadataFactory): ?CacheItemPoolInterface
     {
         $method = new ReflectionMethod($classMetadataFactory, 'getCache');

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

@@ -6,7 +6,6 @@
 use Doctrine\Persistence\Mapping\RuntimeReflectionService;
 use Doctrine\Persistence\Reflection\RuntimePublicReflectionProperty;
 use PHPUnit\Framework\TestCase;
-use ReflectionClass;
 use ReflectionProperty;
 
 use function count;
@@ -49,12 +48,6 @@ public function testGetParentClassesForAbsentClass(): void
         $this->reflectionService->getParentClasses(__NAMESPACE__ . '\AbsentClass');
     }
 
-    public function testGetReflectionClass(): void
-    {
-        $class = $this->reflectionService->getClass(self::class);
-        self::assertInstanceOf(ReflectionClass::class, $class);
-    }
-
     public function testGetMethods(): void
     {
         self::assertTrue($this->reflectionService->hasPublicMethod(self::class, 'testGetMethods'));

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

@@ -28,6 +28,9 @@ public function testGetAllClassNames(): void
 
 class TestEntity
 {
+    /**
+     * @psalm-param ClassMetadata<object> $metadata
+     */
     public static function loadMetadata(ClassMetadata $metadata): void
     {
         $metadata->getFieldNames();