Upgrade to PHPStan 2.0

doctrine-extensions · Jan 14, 2025 · 9763aa2 · 9763aa2
1 parent ea6959d
commit 9763aa2
Show file tree

Hide file tree

Showing 83 changed files with 930 additions and 529 deletions.
diff --git a/composer.json b/composer.json
@@ -60,11 +60,11 @@
         "doctrine/orm": "^2.14.0 || ^3.0",
         "friendsofphp/php-cs-fixer": "^3.14.0",
         "nesbot/carbon": "^2.71 || ^3.0",
-        "phpstan/phpstan": "^1.11",
-        "phpstan/phpstan-doctrine": "^1.4",
-        "phpstan/phpstan-phpunit": "^1.4",
+        "phpstan/phpstan": "^2.1.1",
+        "phpstan/phpstan-doctrine": "^2.0.1",
+        "phpstan/phpstan-phpunit": "^2.0.3",
         "phpunit/phpunit": "^9.6",
-        "rector/rector": "^1.1",
+        "rector/rector": "^2.0.6",
         "symfony/console": "^5.4 || ^6.0 || ^7.0",
         "symfony/doctrine-bridge": "^5.4 || ^6.0 || ^7.0",
         "symfony/phpunit-bridge": "^6.0 || ^7.0",

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -12,12 +12,12 @@ parameters:
         - tests/bootstrap.php
     treatPhpDocTypesAsCertain: false
     ignoreErrors:
+        -
+            identifier: trait.unused
         - '#^Property Gedmo\\Tests\\.+\\Fixture\\[^:]+::\$\w+ is never written, only read\.$#'
         - '#^Property Gedmo\\Tests\\.+\\Fixture\\[^:]+::\$\w+ is never read, only written\.$#'
         - '#^Property Gedmo\\Tests\\.+\\Fixture\\[^:]+::\$\w+ is unused\.$#'
         - '#^Method Gedmo\\(?:[^\\]+\\)*Mapping\\Driver[^:]+::readExtendedMetadata\(\) with return type void returns [\w\|<>\s,]+ but should not return anything\.$#'
-        - '#^Method Gedmo\\Uploadable\\Mapping\\Validator::validateConfiguration\(\) with return type void returns array<string, mixed> but should not return anything\.$#'
-        - '#^Result of static method Gedmo\\Uploadable\\Mapping\\Validator::validateConfiguration\(\) \(void\) is used\.$#'
         - '#^Result of method Gedmo\\Mapping\\Driver::readExtendedMetadata\(\) \(void\) is used\.$#'
     excludePaths:
         # Deprecated and unused class, interface does not exist as of 4.0

diff --git a/src/AbstractTrackingListener.php b/src/AbstractTrackingListener.php
@@ -28,10 +28,10 @@
 /**
  * The AbstractTrackingListener provides generic functions for all listeners.
  *
- * @phpstan-template TConfig of array
- * @phpstan-template TEventAdapter of AdapterInterface
+ * @template TConfig of array
+ * @template TEventAdapter of AdapterInterface
  *
- * @phpstan-extends MappedEventSubscriber<TConfig, TEventAdapter>
+ * @template-extends MappedEventSubscriber<TConfig, TEventAdapter>
  *
  * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  */
@@ -207,9 +207,9 @@ public function prePersist(EventArgs $args)
     /**
      * Get the value for an updated field.
      *
-     * @param ClassMetadata    $meta
-     * @param string           $field
-     * @param AdapterInterface $eventAdapter
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
+     * @param TEventAdapter         $eventAdapter
      *
      * @return mixed
      */
@@ -218,10 +218,10 @@ abstract protected function getFieldValue($meta, $field, $eventAdapter);
     /**
      * Updates a field.
      *
-     * @param object           $object
-     * @param AdapterInterface $eventAdapter
-     * @param ClassMetadata    $meta
-     * @param string           $field
+     * @param object                $object
+     * @param TEventAdapter         $eventAdapter
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
      *
      * @return void
      */

diff --git a/src/Blameable/BlameableListener.php b/src/Blameable/BlameableListener.php
@@ -34,8 +34,9 @@ class BlameableListener extends AbstractTrackingListener
     /**
      * Get the user value to set on a blameable field
      *
-     * @param ClassMetadata $meta
-     * @param string        $field
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
+     * @param BlameableAdapter      $eventAdapter
      *
      * @return mixed
      */

diff --git a/src/Blameable/Mapping/Driver/Xml.php b/src/Blameable/Mapping/Driver/Xml.php
@@ -119,8 +119,8 @@ public function readExtendedMetadata($meta, array &$config)
     /**
      * Checks if $field type is valid
      *
-     * @param ClassMetadata $meta
-     * @param string        $field
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
      *
      * @return bool
      */

diff --git a/src/Blameable/Mapping/Driver/Yaml.php b/src/Blameable/Mapping/Driver/Yaml.php
@@ -125,8 +125,8 @@ protected function _loadMappingFile($file)
     /**
      * Checks if $field type is valid
      *
-     * @param ClassMetadata $meta
-     * @param string        $field
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
      *
      * @return bool
      */

diff --git a/src/IpTraceable/IpTraceableListener.php b/src/IpTraceable/IpTraceableListener.php
@@ -13,7 +13,6 @@
 use Gedmo\AbstractTrackingListener;
 use Gedmo\Exception\InvalidArgumentException;
 use Gedmo\IpTraceable\Mapping\Event\IpTraceableAdapter;
-use Gedmo\Mapping\Event\AdapterInterface;
 
 /**
  * The IpTraceable listener handles the update of
@@ -35,9 +34,9 @@ class IpTraceableListener extends AbstractTrackingListener
     /**
      * Get the ipValue value to set on a ip field
      *
-     * @param ClassMetadata    $meta
-     * @param string           $field
-     * @param AdapterInterface $eventAdapter
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
+     * @param IpTraceableAdapter    $eventAdapter
      *
      * @return string|null
      */

diff --git a/src/IpTraceable/Mapping/Driver/Xml.php b/src/IpTraceable/Mapping/Driver/Xml.php
@@ -121,8 +121,8 @@ public function readExtendedMetadata($meta, array &$config)
     /**
      * Checks if $field type is valid
      *
-     * @param ClassMetadata $meta
-     * @param string        $field
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
      *
      * @return bool
      */

diff --git a/src/IpTraceable/Mapping/Driver/Yaml.php b/src/IpTraceable/Mapping/Driver/Yaml.php
@@ -121,8 +121,8 @@ protected function _loadMappingFile($file)
     /**
      * Checks if $field type is valid
      *
-     * @param ClassMetadata $meta
-     * @param string        $field
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
      *
      * @return bool
      */

diff --git a/src/Loggable/Entity/Repository/LogEntryRepository.php b/src/Loggable/Entity/Repository/LogEntryRepository.php
@@ -25,29 +25,25 @@
  *
  * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  *
- * @phpstan-template T of Loggable|object
+ * @template T of Loggable|object
  *
- * @phpstan-extends EntityRepository<AbstractLogEntry<T>>
+ * @template-extends EntityRepository<AbstractLogEntry<T>>
  */
 class LogEntryRepository extends EntityRepository
 {
     /**
      * Currently used loggable listener
      *
-     * @phpstan-var LoggableListener<T>|null
+     * @var LoggableListener<T>|null
      */
     private ?LoggableListener $listener = null;
 
     /**
      * Loads all log entries for the given entity
      *
-     * @param object $entity
+     * @param T $entity
      *
-     * @return AbstractLogEntry[]
-     *
-     * @phpstan-param T $entity
-     *
-     * @phpstan-return array<array-key, AbstractLogEntry<T>>
+     * @return array<array-key, AbstractLogEntry<T>>
      */
     public function getLogEntries($entity)
     {
@@ -57,11 +53,9 @@ public function getLogEntries($entity)
     /**
      * Get the query for loading of log entries
      *
-     * @param object $entity
+     * @param T $entity
      *
      * @return Query
-     *
-     * @phpstan-param T $entity
      */
     public function getLogEntriesQuery($entity)
     {
@@ -89,14 +83,12 @@ public function getLogEntriesQuery($entity)
      * After this operation you will need to
      * persist and flush the $entity.
      *
-     * @param object $entity
-     * @param int    $version
+     * @param T   $entity
+     * @param int $version
      *
      * @throws UnexpectedValueException
      *
      * @return void
-     *
-     * @phpstan-param T $entity
      */
     public function revert($entity, $version = 1)
     {
@@ -151,12 +143,11 @@ public function revert($entity, $version = 1)
     }
 
     /**
-     * @param string $field
-     * @param mixed  $value
+     * @param ClassMetadata<T> $objectMeta
+     * @param string           $field
+     * @param mixed            $value
      *
      * @return void
-     *
-     * @phpstan-param ClassMetadata<T> $objectMeta
      */
     protected function mapValue(ClassMetadata $objectMeta, $field, &$value)
     {
@@ -173,7 +164,7 @@ protected function mapValue(ClassMetadata $objectMeta, $field, &$value)
      *
      * @throws RuntimeException if listener is not found
      *
-     * @phpstan-return LoggableListener<T>
+     * @return LoggableListener<T>
      */
     private function getLoggableListener(): LoggableListener
     {

diff --git a/src/Loggable/LoggableListener.php b/src/Loggable/LoggableListener.php
@@ -34,7 +34,7 @@
  *   versioned?: string[],
  * }
  *
- * @phpstan-template T of Loggable|object
+ * @template T of Loggable|object
  *
  * @phpstan-extends MappedEventSubscriber<LoggableConfiguration, LoggableAdapter>
  */

diff --git a/src/Loggable/Mapping/Driver/Attribute.php b/src/Loggable/Mapping/Driver/Attribute.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Loggable\Mapping\Driver;
 
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata as ClassMetadataODM;
+use Doctrine\ORM\Mapping\ClassMetadata as ClassMetadataORM;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Exception\InvalidMappingException;
 use Gedmo\Mapping\Annotation\Loggable;
@@ -38,7 +39,7 @@ class Attribute extends AbstractAnnotationDriver
 
     public function validateFullMetadata(ClassMetadata $meta, array $config)
     {
-        if ($config && $meta instanceof ClassMetadataODM && is_array($meta->getIdentifier()) && count($meta->getIdentifier()) > 1) {
+        if ($config && $meta instanceof ClassMetadataODM && count($meta->getIdentifier()) > 1) {
             throw new InvalidMappingException("Loggable does not support composite identifiers in class - {$meta->getName()}");
         }
 
@@ -94,7 +95,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (!$meta->isMappedSuperclass && $config) {
-            if ($meta instanceof ClassMetadataODM && is_array($meta->getIdentifier()) && count($meta->getIdentifier()) > 1) {
+            if ($meta instanceof ClassMetadataODM && count($meta->getIdentifier()) > 1) {
                 throw new InvalidMappingException("Loggable does not support composite identifiers in class - {$meta->getName()}");
             }
 
@@ -107,7 +108,8 @@ public function readExtendedMetadata($meta, array &$config)
     }
 
     /**
-     * @param string $field
+     * @param ClassMetadata<object> $meta
+     * @param string                $field
      *
      * @return bool
      */
@@ -117,7 +119,8 @@ protected function isMappingValid(ClassMetadata $meta, $field)
     }
 
     /**
-     * @param array<string, mixed> $config
+     * @param ClassMetadata<object> $meta
+     * @param array<string, mixed>  $config
      *
      * @return bool
      */
@@ -129,9 +132,10 @@ protected function isClassAnnotationInValid(ClassMetadata $meta, array &$config)
     /**
      * Searches properties of embedded objects for versioned fields
      *
-     * @param array<string, mixed> $config
+     * @param array<string, mixed>     $config
+     * @param ClassMetadataORM<object> $meta
      */
-    private function inspectEmbeddedForVersioned(string $field, array &$config, \Doctrine\ORM\Mapping\ClassMetadata $meta): void
+    private function inspectEmbeddedForVersioned(string $field, array &$config, ClassMetadataORM $meta): void
     {
         $class = new \ReflectionClass($meta->embeddedClasses[$field]['class']);
 

diff --git a/src/Loggable/Mapping/Driver/Xml.php b/src/Loggable/Mapping/Driver/Xml.php
@@ -41,7 +41,7 @@ public function readExtendedMetadata($meta, array &$config)
         if (in_array($xmlDoctrine->getName(), ['mapped-superclass', 'entity', 'document'], true)) {
             if (isset($xml->loggable)) {
                 /**
-                 * @var \SimpleXMLElement;
+                 * @var \SimpleXMLElement
                  */
                 $data = $xml->loggable;
                 $config['loggable'] = true;
@@ -75,7 +75,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (!$meta->isMappedSuperclass && $config) {
-            if ($meta instanceof ClassMetadataODM && is_array($meta->getIdentifier()) && count($meta->getIdentifier()) > 1) {
+            if ($meta instanceof ClassMetadataODM && count($meta->getIdentifier()) > 1) {
                 throw new InvalidMappingException("Loggable does not support composite identifiers in class - {$meta->getName()}");
             }
             if (isset($config['versioned']) && !isset($config['loggable'])) {
@@ -89,7 +89,8 @@ public function readExtendedMetadata($meta, array &$config)
     /**
      * Searches mappings on element for versioned fields
      *
-     * @param array<string, mixed> $config
+     * @param array<string, mixed>  $config
+     * @param ClassMetadata<object> $meta
      *
      * @return array<string, mixed>
      */

diff --git a/src/Loggable/Mapping/Driver/Yaml.php b/src/Loggable/Mapping/Driver/Yaml.php
@@ -125,7 +125,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (!$meta->isMappedSuperclass && $config) {
-            if ($meta instanceof ClassMetadata && is_array($meta->getIdentifier()) && count($meta->getIdentifier()) > 1) {
+            if ($meta instanceof ClassMetadata && count($meta->getIdentifier()) > 1) {
                 throw new InvalidMappingException("Loggable does not support composite identifiers in class - {$meta->getName()}");
             }
             if (isset($config['versioned']) && !isset($config['loggable'])) {

diff --git a/src/Loggable/Mapping/Event/Adapter/ODM.php b/src/Loggable/Mapping/Event/Adapter/ODM.php
@@ -9,6 +9,7 @@
 
 namespace Gedmo\Loggable\Mapping\Event\Adapter;
 
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Loggable\Document\LogEntry;
 use Gedmo\Loggable\Mapping\Event\LoggableAdapter;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
@@ -26,11 +27,17 @@ public function getDefaultLogEntryClass()
         return LogEntry::class;
     }
 
+    /**
+     * @param ClassMetadata<object> $meta
+     */
     public function isPostInsertGenerator($meta)
     {
         return false;
     }
 
+    /**
+     * @param ClassMetadata<object> $meta
+     */
     public function getNewVersion($meta, $object)
     {
         $dm = $this->getObjectManager();

diff --git a/src/Loggable/Mapping/Event/Adapter/ORM.php b/src/Loggable/Mapping/Event/Adapter/ORM.php
@@ -29,13 +29,16 @@ public function getDefaultLogEntryClass()
     }
 
     /**
-     * @param ClassMetadata $meta
+     * @param ClassMetadata<object> $meta
      */
     public function isPostInsertGenerator($meta)
     {
         return $meta->idGenerator->isPostInsertGenerator();
     }
 
+    /**
+     * @param ClassMetadata<object> $meta
+     */
     public function getNewVersion($meta, $object)
     {
         $em = $this->getObjectManager();