Fix Psalm issues

Author: hlecorche

.github/workflows/tests.yml

@@ -20,10 +20,17 @@ jobs:
                     -   php-version: '7.4'
                     -   php-version: '8.0'
                     -   php-version: '8.1'
+
+                    #CS
                     -   php-version: '8.1'
                         description: 'with Coding Standards'
                         coding-standards: true
 
+                    #Static Analysis (min PHP version)
+                    -   php-version: '7.2'
+                        description: 'with Static Analysis'
+                        static-analysis: true
+
         name: PHP ${{ matrix.php-version }} ${{ matrix.description }}
 
         runs-on: 'ubuntu-latest'
@@ -61,7 +68,7 @@ jobs:
                 run: composer update --no-interaction --no-progress ${{ matrix.composer-flags }}
 
             -   name: Run PHPUnit
-                if: matrix.coding-standards != true
+                if: matrix.coding-standards != true && matrix.static-analysis != true
                 run: php vendor/phpunit/phpunit/phpunit
 
             -   name: Run PHP CS Fixer
@@ -77,3 +84,7 @@ jobs:
             -   name: Check license year
                 if: matrix.coding-standards
                 run: cat LICENSE |grep -E "\(c\) ([0-9]+\-)*`date +%G`"
+
+            -   name: Run Psalm
+                if: matrix.static-analysis
+                run: php vendor/bin/psalm --stats --output-format=github

.php-cs-fixer.dist.php

@@ -34,6 +34,7 @@
         'ordered_imports' => true,
         'phpdoc_order' => true,
         'protected_to_private' => false,
+        'phpdoc_to_comment' => ['ignored_tags' => ['psalm-suppress']],
     ])
     ->setFinder($finder)
 ;

composer.json

@@ -28,7 +28,8 @@
         "fakerphp/faker": "^1.9",
         "friendsofphp/php-cs-fixer": "^3.0",
         "phpunit/phpunit": "^8.4",
-        "symfony/cache": "*"
+        "symfony/cache": "*",
+        "vimeo/psalm": "^4.23"
     },
     "extra": {
         "branch-alias": {

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="2"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src"/>
+        <ignoreFiles>
+            <directory name="vendor"/>
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Exception/EntityNotFoundException.php

@@ -15,7 +15,7 @@
 
 class EntityNotFoundException extends \Exception implements ExceptionInterface
 {
-    public static function fromClassNameAndIdentifier($className, array $id)
+    public static function fromClassNameAndIdentifier(string $className, array $id): self
     {
         $ids = [];
 

src/RefetchManager.php

@@ -54,7 +54,10 @@ public function getObject(object $object): object
         return $newObject;
     }
 
-    public function getCollectionFromCriteria(Criteria $criteria, $class): Collection
+    /**
+     * @psalm-param class-string $class
+     */
+    public function getCollectionFromCriteria(Criteria $criteria, string $class): Collection
     {
         return $this->entityManager->getRepository($class)->matching($criteria);
     }
@@ -71,6 +74,7 @@ protected function getObjectMetadata(object $object): ClassMetadata
 
     protected function getIdentifierFlattener(): IdentifierFlattener
     {
+        /** @psalm-suppress InvalidArgument */
         return new IdentifierFlattener($this->entityManager->getUnitOfWork(), $this->entityManager->getMetadataFactory());
     }
 }

src/SnapshotManager.php

@@ -23,6 +23,9 @@ final class SnapshotManager
      */
     private $entityManager;
 
+    /**
+     * @var array|null
+     */
     private $snapshot;
 
     public static function create(EntityManagerInterface $entityManager): self
@@ -53,6 +56,7 @@ public function clear(): void
 
         $identityMap = $this->entityManager->getUnitOfWork()->getIdentityMap();
         foreach ($identityMap as $class => $objects) {
+            /** @var object $object */
             foreach ($objects as $id => $object) {
                 if (!\array_key_exists($class, $this->snapshot) || !\array_key_exists($id, $this->snapshot[$class])) {
                     $this->entityManager->detach($object);