Fix some findings reported by PHPStan level 6

doctrine-extensions · Sep 3, 2023 · b4433e8 · b4433e8
1 parent 5502bae
commit b4433e8
Show file tree

Hide file tree

Showing 44 changed files with 218 additions and 175 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -66,7 +66,7 @@ parameters:
 			path: src/Loggable/LoggableListener.php
 
 		-
-			message: "#^Method Gedmo\\\\Tool\\\\WrapperInterface\\<Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\>\\:\\:getIdentifier\\(\\) invoked with 2 parameters, 0-1 required\\.#"
+			message: "#^Method Gedmo\\\\Tool\\\\WrapperInterface\\<Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\>\\:\\:getIdentifier\\(\\) invoked with 2 parameters, 0\\-1 required\\.$#"
 			count: 2
 			path: src/Loggable/LoggableListener.php
 
@@ -360,21 +360,11 @@ parameters:
 			count: 1
 			path: src/Timestampable/Mapping/Driver/Yaml.php
 
-		-
-			message: "#^PHPDoc tag \\@param references unknown parameter\\: \\$flatten$#"
-			count: 1
-			path: src/Tool/WrapperInterface.php
-
 		-
 			message: "#^Call to an undefined method Doctrine\\\\Persistence\\\\ObjectManager\\:\\:getUnitOfWork\\(\\)\\.$#"
 			count: 1
 			path: src/Tool/Wrapper/EntityWrapper.php
 
-		-
-			message: "#^Method Gedmo\\\\Tool\\\\Wrapper\\\\EntityWrapper\\:\\:getIdentifier\\(\\) has parameter \\$flatten with no type specified\\.$#"
-			count: 1
-			path: src/Tool/Wrapper/EntityWrapper.php
-
 		-
 			message: "#^Parameter \\#2 \\$em of class Gedmo\\\\Tool\\\\Wrapper\\\\EntityWrapper constructor expects Doctrine\\\\ORM\\\\EntityManagerInterface, Doctrine\\\\Persistence\\\\ObjectManager given\\.$#"
 			count: 1
@@ -390,11 +380,6 @@ parameters:
 			count: 2
 			path: src/Tool/Wrapper/MongoDocumentWrapper.php
 
-		-
-			message: "#^Method Gedmo\\\\Tool\\\\Wrapper\\\\MongoDocumentWrapper\\:\\:getIdentifier\\(\\) has parameter \\$flatten with no type specified\\.$#"
-			count: 1
-			path: src/Tool/Wrapper/MongoDocumentWrapper.php
-
 		-
 			message: "#^Access to offset 'association' on an unknown class Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\FieldMapping\\.$#"
 			count: 2

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -4,7 +4,7 @@ includes:
     - vendor/phpstan/phpstan-phpunit/extension.neon
 
 parameters:
-    level: 5
+    level: 6
     paths:
         - src
         - tests
@@ -13,10 +13,15 @@ parameters:
     treatPhpDocTypesAsCertain: false
     checkMissingVarTagTypehint: true
     checkMissingTypehints: true
+    # @todo: Remove the "checkGenericClassInNonGenericObjectType" definition.
+    checkGenericClassInNonGenericObjectType: false
     ignoreErrors:
         - '#^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\.$#'
+        # @todo: Remove the following ignored error when the parameters are correctly declared.
+        - '#^Method Gedmo\\[^:]+::[^\(]+\(\) has parameter \$\w+ with no value type specified in iterable type array\.$#'
+
 rules:
     - PHPStan\Rules\Constants\MissingClassConstantTypehintRule
     - PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule

diff --git a/src/Loggable/Entity/MappedSuperclass/AbstractLogEntry.php b/src/Loggable/Entity/MappedSuperclass/AbstractLogEntry.php
@@ -81,7 +81,7 @@ abstract class AbstractLogEntry implements LogEntryInterface
     protected $version;
 
     /**
-     * @var array|null
+     * @var array<string, mixed>|null
      *
      * @ORM\Column(type="array", nullable=true)
      */
@@ -108,8 +108,6 @@ public function getId()
 
     /**
      * Get action
-     *
-     * @return string|null
      */
     public function getAction()
     {
@@ -118,10 +116,6 @@ public function getAction()
 
     /**
      * Set action
-     *
-     * @param string $action
-     *
-     * @return void
      */
     public function setAction($action)
     {
@@ -130,8 +124,6 @@ public function setAction($action)
 
     /**
      * Get object class
-     *
-     * @return string|null
      */
     public function getObjectClass()
     {
@@ -140,10 +132,6 @@ public function getObjectClass()
 
     /**
      * Set object class
-     *
-     * @param string $objectClass
-     *
-     * @return void
      */
     public function setObjectClass($objectClass)
     {
@@ -152,8 +140,6 @@ public function setObjectClass($objectClass)
 
     /**
      * Get object id
-     *
-     * @return string|null
      */
     public function getObjectId()
     {
@@ -164,8 +150,6 @@ public function getObjectId()
      * Set object id
      *
      * @param string $objectId
-     *
-     * @return void
      */
     public function setObjectId($objectId)
     {
@@ -174,8 +158,6 @@ public function setObjectId($objectId)
 
     /**
      * Get username
-     *
-     * @return string|null
      */
     public function getUsername()
     {
@@ -186,8 +168,6 @@ public function getUsername()
      * Set username
      *
      * @param string $username
-     *
-     * @return void
      */
     public function setUsername($username)
     {
@@ -196,8 +176,6 @@ public function setUsername($username)
 
     /**
      * Get loggedAt
-     *
-     * @return \DateTime|null
      */
     public function getLoggedAt()
     {
@@ -206,8 +184,6 @@ public function getLoggedAt()
 
     /**
      * Set loggedAt to "now"
-     *
-     * @return void
      */
     public function setLoggedAt()
     {
@@ -216,8 +192,6 @@ public function setLoggedAt()
 
     /**
      * Get data
-     *
-     * @return array|null
      */
     public function getData()
     {
@@ -226,10 +200,6 @@ public function getData()
 
     /**
      * Set data
-     *
-     * @param array $data
-     *
-     * @return void
      */
     public function setData($data)
     {
@@ -240,8 +210,6 @@ public function setData($data)
      * Set current version
      *
      * @param int $version
-     *
-     * @return void
      */
     public function setVersion($version)
     {
@@ -250,8 +218,6 @@ public function setVersion($version)
 
     /**
      * Get current version
-     *
-     * @return int|null
      */
     public function getVersion()
     {

diff --git a/src/Mapping/Driver.php b/src/Mapping/Driver.php
@@ -27,6 +27,7 @@ interface Driver
      * Read the extended metadata configuration for a single mapped class.
      *
      * @param ClassMetadata&(OdmClassMetadata|OrmClassMetadata) $meta
+     * @param array<string, mixed> $config
      *
      * @return void
      *

diff --git a/src/Mapping/Driver/AbstractAnnotationDriver.php b/src/Mapping/Driver/AbstractAnnotationDriver.php
@@ -116,6 +116,10 @@ protected function isValidField($meta, $field)
      * @param string        $name     the related object class name
      *
      * @return string related class name or empty string if does not exist
+     *
+     * @phpstan-param class-string|string $name
+     *
+     * @phpstan-return class-string|''
      */
     protected function getRelatedClassName($metadata, $name)
     {

diff --git a/src/Mapping/Driver/File.php b/src/Mapping/Driver/File.php
@@ -103,7 +103,9 @@ public function setOriginalDriver($driver)
      *
      * @param string $file the mapping file to load
      *
-     * @return array
+     * @return array<string, array<string, mixed>|object|null>
+     *
+     * @phpstan-return array<class-string, array<string, mixed>|object|null>
      */
     abstract protected function _loadMappingFile($file);
 
@@ -112,7 +114,9 @@ abstract protected function _loadMappingFile($file);
      *
      * @param string $className
      *
-     * @return array|object|null
+     * @return array<string, mixed>|object|null
+     *
+     * @phpstan-param class-string $className
      */
     protected function _getMapping($className)
     {
@@ -140,6 +144,10 @@ protected function _getMapping($className)
      * @param string        $name     the related object class name
      *
      * @return string related class name or empty string if does not exist
+     *
+     * @phpstan-param class-string|string $name
+     *
+     * @phpstan-return class-string|''
      */
     protected function getRelatedClassName($metadata, $name)
     {

diff --git a/src/Mapping/Event/AdapterInterface.php b/src/Mapping/Event/AdapterInterface.php
@@ -92,7 +92,9 @@ public function getObjectState($uow, $object);
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow    The UnitOfWork as provided by the object manager
      * @param object                          $object
      *
-     * @return array
+     * @return array<string, array<int, mixed>|object>
+     *
+     * @phpstan-return array<string, array{0: mixed, 1: mixed}|object>
      */
     public function getObjectChangeSet($uow, $object);
 
@@ -123,7 +125,7 @@ public function recomputeSingleObjectChangeSet($uow, $meta, $object);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectUpdates($uow);
 
@@ -132,7 +134,7 @@ public function getScheduledObjectUpdates($uow);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectInsertions($uow);
 
@@ -141,7 +143,7 @@ public function getScheduledObjectInsertions($uow);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectDeletions($uow);
 

diff --git a/src/Mapping/ExtensionMetadataFactory.php b/src/Mapping/ExtensionMetadataFactory.php
@@ -100,7 +100,7 @@ public function __construct(ObjectManager $objectManager, string $extensionNames
      *
      * @param ClassMetadata&(DocumentClassMetadata|EntityClassMetadata) $meta
      *
-     * @return array the metatada configuration
+     * @return array<string, mixed> the metatada configuration
      */
     public function getExtensionMetadata($meta)
     {

diff --git a/src/ReferenceIntegrity/Mapping/Validator.php b/src/ReferenceIntegrity/Mapping/Validator.php
@@ -38,7 +38,9 @@ class Validator
     /**
      * Returns a list of available integrity actions
      *
-     * @return array
+     * @return string[]
+     *
+     * @phpstan-return array<int, self::NULLIFY|self::PULL|self::RESTRICT>
      */
     public function getIntegrityActions()
     {

diff --git a/src/References/Mapping/Event/ReferencesAdapter.php b/src/References/Mapping/Event/ReferencesAdapter.php
@@ -28,7 +28,7 @@ interface ReferencesAdapter extends AdapterInterface
      * @param object        $object
      * @param bool          $single
      *
-     * @return array|string|int|null array or single identifier
+     * @return array<int|string, mixed>|string|int|null array or single identifier
      */
     public function getIdentifier($om, $object, $single = true);
 
@@ -52,7 +52,7 @@ public function getSingleReference($om, $class, $identifier);
      * @param object        $object
      * @param bool          $single
      *
-     * @return array|string|int|null array or single identifier
+     * @return array<int|string, mixed>|string|int|null array or single identifier
      */
     public function extractIdentifier($om, $object, $single = true);
 }
diff --git a/src/Sluggable/Mapping/Event/SluggableAdapter.php b/src/Sluggable/Mapping/Event/SluggableAdapter.php
@@ -30,7 +30,7 @@ interface SluggableAdapter extends AdapterInterface
      * @param string        $slug
      * @phpstan-param SluggableConfiguration $config
      *
-     * @return array
+     * @return array<int, array<string, mixed>>
      */
     public function getSimilarSlugs($object, $meta, array $config, $slug);
 

diff --git a/src/SoftDeleteable/Filter/ODM/SoftDeleteableFilter.php b/src/SoftDeleteable/Filter/ODM/SoftDeleteableFilter.php
@@ -39,7 +39,9 @@ class SoftDeleteableFilter extends BsonFilter
     /**
      * Gets the criteria part to add to a query.
      *
-     * @return array The criteria array, if there is available, empty array otherwise
+     * @return array<string, array<int, array<string, array<string, \DateTime>|null>>|null> The criteria array, if there is available, empty array otherwise
+     *
+     * @phpstan-return array<string, array<int, array<string, array{'$gt': \DateTime}|null>>|null>
      */
     public function addFilterCriteria(ClassMetadata $targetEntity): array
     {
@@ -96,7 +98,7 @@ public function enableForDocument($class)
     }
 
     /**
-     * @return SoftDeleteableListener|null
+     * @return SoftDeleteableListener
      */
     protected function getListener()
     {

diff --git a/src/Sortable/Entity/Repository/SortableRepository.php b/src/Sortable/Entity/Repository/SortableRepository.php
@@ -101,7 +101,7 @@ public function getBySortableGroupsQueryBuilder(array $groupValues = [])
     }
 
     /**
-     * @return array
+     * @return array<int, object>
      */
     public function getBySortableGroups(array $groupValues = [])
     {

diff --git a/src/Sortable/Mapping/Driver/Yaml.php b/src/Sortable/Mapping/Driver/Yaml.php
@@ -98,6 +98,9 @@ protected function isValidField($meta, $field)
         return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
     }
 
+    /**
+     * @param iterable<string, array<string, mixed>> $mapping
+     */
     private function readSortableGroups(iterable $mapping, array &$config): void
     {
         foreach ($mapping as $field => $fieldMapping) {

diff --git a/src/Sortable/Mapping/Event/Adapter/ORM.php b/src/Sortable/Mapping/Event/Adapter/ORM.php
@@ -112,6 +112,9 @@ public function updatePositions($relocation, $delta, $config)
         $q->getSingleScalarResult();
     }
 
+    /**
+     * @param iterable<string, mixed> $groups
+     */
     private function addGroupWhere(QueryBuilder $qb, ClassMetadata $metadata, iterable $groups): void
     {
         $i = 1;
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         /**
-         * @return array
+         * @return array<int, object>
          */
         public function getBySortableGroups(array $groupValues = [])
         {
@@ Expand Down @@