Improve phpdoc by using a more specific types

franmomu · web-flow · commit ca2849656df9 · 2022-01-06T12:56:42.000-03:00
diff --git a/src/Loggable/LoggableListener.php b/src/Loggable/LoggableListener.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Loggable;
 
 use Doctrine\Common\EventArgs;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Gedmo\Loggable\Mapping\Event\LoggableAdapter;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
@@ -100,6 +101,8 @@ public function getSubscribedEvents()
     /**
      * Maps additional metadata
      *
+     * @param LoadClassMetadataEventArgs $eventArgs
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $eventArgs)
diff --git a/src/Loggable/Mapping/Event/Adapter/ORM.php b/src/Loggable/Mapping/Event/Adapter/ORM.php
@@ -9,6 +9,7 @@
 
 namespace Gedmo\Loggable\Mapping\Event\Adapter;
 
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Loggable\Entity\LogEntry;
 use Gedmo\Loggable\Mapping\Event\LoggableAdapter;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
@@ -26,6 +27,9 @@ public function getDefaultLogEntryClass()
         return LogEntry::class;
     }
 
+    /**
+     * @param ClassMetadata $meta
+     */
     public function isPostInsertGenerator($meta)
     {
         return $meta->idGenerator->isPostInsertGenerator();
diff --git a/src/Mapping/Event/Adapter/ODM.php b/src/Mapping/Event/Adapter/ODM.php
@@ -12,6 +12,7 @@
 use Doctrine\Common\EventArgs;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Exception\RuntimeException;
 use Gedmo\Mapping\Event\AdapterInterface;
 
@@ -58,6 +59,9 @@ public function getManagerName()
         return 'ODM';
     }
 
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getRootObjectClass($meta)
     {
         return $meta->rootDocumentName;
diff --git a/src/Mapping/Event/Adapter/ORM.php b/src/Mapping/Event/Adapter/ORM.php
@@ -12,6 +12,7 @@
 use Doctrine\Common\EventArgs;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Event\LifecycleEventArgs;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Exception\RuntimeException;
 use Gedmo\Mapping\Event\AdapterInterface;
 
@@ -58,6 +59,9 @@ public function getManagerName()
         return 'ORM';
     }
 
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getRootObjectClass($meta)
     {
         return $meta->rootEntityName;
@@ -95,6 +99,9 @@ public function getObjectChangeSet($uow, $object)
         return $uow->getEntityChangeSet($object);
     }
 
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getSingleIdentifierFieldName($meta)
     {
         return $meta->getSingleIdentifierFieldName();
diff --git a/src/ReferenceIntegrity/ReferenceIntegrityListener.php b/src/ReferenceIntegrity/ReferenceIntegrityListener.php
@@ -10,6 +10,7 @@
 namespace Gedmo\ReferenceIntegrity;
 
 use Doctrine\Common\EventArgs;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Gedmo\Exception\InvalidMappingException;
 use Gedmo\Exception\ReferenceIntegrityStrictException;
 use Gedmo\Mapping\MappedEventSubscriber;
@@ -36,6 +37,8 @@ public function getSubscribedEvents()
     /**
      * Maps additional metadata for the Document
      *
+     * @param LoadClassMetadataEventArgs $eventArgs
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $eventArgs)
diff --git a/src/References/ReferencesListener.php b/src/References/ReferencesListener.php
@@ -11,6 +11,7 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\EventArgs;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\MappedEventSubscriber;
 
@@ -39,6 +40,8 @@ public function __construct(array $managers = [])
     }
 
     /**
+     * @param LoadClassMetadataEventArgs $eventArgs
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $eventArgs)
diff --git a/src/Sluggable/SluggableListener.php b/src/Sluggable/SluggableListener.php
@@ -10,6 +10,7 @@
 namespace Gedmo\Sluggable;
 
 use Doctrine\Common\EventArgs;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Sluggable\Handler\SlugHandlerInterface;
@@ -172,6 +173,8 @@ public function removeManagedFilter($name)
     /**
      * Mapps additional metadata
      *
+     * @param LoadClassMetadataEventArgs $eventArgs
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $eventArgs)
diff --git a/src/SoftDeleteable/Mapping/Event/Adapter/ODM.php b/src/SoftDeleteable/Mapping/Event/Adapter/ODM.php
@@ -9,6 +9,7 @@
 
 namespace Gedmo\SoftDeleteable\Mapping\Event\Adapter;
 
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
 use Gedmo\SoftDeleteable\Mapping\Event\SoftDeleteableAdapter;
 
@@ -20,6 +21,9 @@
  */
 final class ODM extends BaseAdapterODM implements SoftDeleteableAdapter
 {
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getDateValue($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
diff --git a/src/SoftDeleteable/Mapping/Event/Adapter/ORM.php b/src/SoftDeleteable/Mapping/Event/Adapter/ORM.php
@@ -11,6 +11,7 @@
 
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
 use Gedmo\SoftDeleteable\Mapping\Event\SoftDeleteableAdapter;
 
@@ -22,6 +23,9 @@
  */
 final class ORM extends BaseAdapterORM implements SoftDeleteableAdapter
 {
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getDateValue($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
diff --git a/src/SoftDeleteable/SoftDeleteableListener.php b/src/SoftDeleteable/SoftDeleteableListener.php
@@ -11,6 +11,7 @@
 
 use Doctrine\Common\EventArgs;
 use Doctrine\ODM\MongoDB\UnitOfWork as MongoDBUnitOfWork;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Gedmo\Mapping\MappedEventSubscriber;
 
 /**
@@ -102,6 +103,8 @@ public function onFlush(EventArgs $args)
     /**
      * Maps additional metadata
      *
+     * @param LoadClassMetadataEventArgs $eventArgs
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $eventArgs)
diff --git a/src/Sortable/Mapping/Event/Adapter/ODM.php b/src/Sortable/Mapping/Event/Adapter/ODM.php
@@ -10,7 +10,7 @@
 namespace Gedmo\Sortable\Mapping\Event\Adapter;
 
 use Doctrine\Common\Util\ClassUtils;
-use Doctrine\Persistence\Mapping\ClassMetadata;
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
 use Gedmo\Sortable\Mapping\Event\SortableAdapter;
 
diff --git a/src/Sortable/SortableListener.php b/src/Sortable/SortableListener.php
@@ -12,6 +12,7 @@
 use Doctrine\Common\Comparable;
 use Doctrine\Common\EventArgs;
 use Doctrine\Common\Util\ClassUtils;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Sortable\Mapping\Event\SortableAdapter;
@@ -60,6 +61,8 @@ public function getSubscribedEvents()
     /**
      * Maps additional metadata
      *
+     * @param LoadClassMetadataEventArgs $args
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $args)
diff --git a/src/Timestampable/Mapping/Event/Adapter/ODM.php b/src/Timestampable/Mapping/Event/Adapter/ODM.php
@@ -9,6 +9,7 @@
 
 namespace Gedmo\Timestampable\Mapping\Event\Adapter;
 
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
 use Gedmo\Timestampable\Mapping\Event\TimestampableAdapter;
 
@@ -20,6 +21,9 @@
  */
 final class ODM extends BaseAdapterODM implements TimestampableAdapter
 {
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getDateValue($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
diff --git a/src/Timestampable/Mapping/Event/Adapter/ORM.php b/src/Timestampable/Mapping/Event/Adapter/ORM.php
@@ -11,6 +11,7 @@
 
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
 use Gedmo\Timestampable\Mapping\Event\TimestampableAdapter;
 
@@ -22,6 +23,9 @@
  */
 final class ORM extends BaseAdapterORM implements TimestampableAdapter
 {
+    /**
+     * @param ClassMetadata $meta
+     */
     public function getDateValue($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
diff --git a/src/Translatable/TranslatableListener.php b/src/Translatable/TranslatableListener.php
@@ -12,6 +12,7 @@
 use Doctrine\Common\EventArgs;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ORM\ORMInvalidArgumentException;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
@@ -191,6 +192,8 @@ public function addPendingTranslationInsert($oid, $translation)
     /**
      * Maps additional metadata
      *
+     * @param LoadClassMetadataEventArgs $eventArgs
+     *
      * @return void
      */
     public function loadClassMetadata(EventArgs $eventArgs)
diff --git a/src/Tree/Strategy/ODM/MongoDB/MaterializedPath.php b/src/Tree/Strategy/ODM/MongoDB/MaterializedPath.php
@@ -9,6 +9,7 @@
 
 namespace Gedmo\Tree\Strategy\ODM\MongoDB;
 
+use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\Event\AdapterInterface;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
@@ -24,6 +25,9 @@
  */
 class MaterializedPath extends AbstractMaterializedPath
 {
+    /**
+     * @param DocumentManager $om
+     */
     public function removeNode($om, $meta, $config, $node)
     {
         $uow = $om->getUnitOfWork();
@@ -41,6 +45,9 @@ public function removeNode($om, $meta, $config, $node)
         }
     }
 
+    /**
+     * @param DocumentManager $om
+     */
     public function getChildren($om, $meta, $config, $originalPath)
     {
         return $om->createQueryBuilder()
@@ -51,6 +58,9 @@ public function getChildren($om, $meta, $config, $originalPath)
             ->execute();
     }
 
+    /**
+     * @param DocumentManager $om
+     */
     protected function lockTrees(ObjectManager $om, AdapterInterface $ea)
     {
         $uow = $om->getUnitOfWork();
@@ -70,6 +80,9 @@ protected function lockTrees(ObjectManager $om, AdapterInterface $ea)
         }
     }
 
+    /**
+     * @param DocumentManager $om
+     */
     protected function releaseTreeLocks(ObjectManager $om, AdapterInterface $ea)
     {
         $uow = $om->getUnitOfWork();
diff --git a/src/Tree/Strategy/ORM/Closure.php b/src/Tree/Strategy/ORM/Closure.php
@@ -12,6 +12,7 @@
 use Doctrine\Common\Cache\Cache;
 use Doctrine\DBAL\Connection;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Mapping\ClassMetadata as ORMClassMetadata;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\ObjectManager;
@@ -73,11 +74,15 @@ public function getName()
         return Strategy::CLOSURE;
     }
 
+    /**
+     * @param EntityManagerInterface $em
+     */
     public function processMetadataLoad($em, $meta)
     {
         // TODO: Remove the body of this method in the next major version.
         $config = $this->listener->getConfiguration($em, $meta->getName());
         $closureMetadata = $em->getClassMetadata($config['closure']);
+
         $cmf = $em->getMetadataFactory();
 
         $hasTheUserExplicitlyDefinedMapping = true;
@@ -238,6 +243,9 @@ public function processPostRemove($em, $entity, AdapterInterface $ea)
     {
     }
 
+    /**
+     * @param EntityManagerInterface $em
+     */
     public function processPostPersist($em, $entity, AdapterInterface $ea)
     {
         $uow = $em->getUnitOfWork();
@@ -313,6 +321,9 @@ public function processPostPersist($em, $entity, AdapterInterface $ea)
         $this->setLevelFieldOnPendingNodes($em);
     }
 
+    /**
+     * @param EntityManagerInterface $em
+     */
     public function processScheduledUpdate($em, $node, AdapterInterface $ea)
     {
         $meta = $em->getClassMetadata(get_class($node));
@@ -421,6 +432,8 @@ protected function getJoinColumnFieldName($association)
     /**
      * Process pending entities to set their "level" value
      *
+     * @param EntityManagerInterface $em
+     *
      * @return void
      */
     protected function setLevelFieldOnPendingNodes(ObjectManager $em)
@@ -482,6 +495,9 @@ protected function setLevelFieldOnPendingNodes(ObjectManager $em)
         }
     }
 
+    /**
+     * @param ORMClassMetadata $closureMetadata
+     */
     private function hasClosureTableUniqueConstraint(ClassMetadata $closureMetadata): bool
     {
         if (!isset($closureMetadata->table['uniqueConstraints'])) {
@@ -497,6 +513,9 @@ private function hasClosureTableUniqueConstraint(ClassMetadata $closureMetadata)
         return false;
     }
 
+    /**
+     * @param ORMClassMetadata $closureMetadata
+     */
     private function hasClosureTableDepthIndex(ClassMetadata $closureMetadata): bool
     {
         if (!isset($closureMetadata->table['indexes'])) {
diff --git a/src/Tree/Strategy/ORM/MaterializedPath.php b/src/Tree/Strategy/ORM/MaterializedPath.php
diff --git a/src/Tree/Strategy/ORM/Nested.php b/src/Tree/Strategy/ORM/Nested.php
diff --git a/src/Tree/TreeListener.php b/src/Tree/TreeListener.php
diff --git a/src/Uploadable/UploadableListener.php b/src/Uploadable/UploadableListener.php
diff --git a/tests/Gedmo/Mapping/Mock/Extension/Encoder/EncoderListener.php b/tests/Gedmo/Mapping/Mock/Extension/Encoder/EncoderListener.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`namespace Gedmo\Loggable\Mapping\Event\Adapter;`
`11`	`11`
	`12`	`+use Doctrine\ORM\Mapping\ClassMetadata;`
`12`	`13`	`use Gedmo\Loggable\Entity\LogEntry;`
`13`	`14`	`use Gedmo\Loggable\Mapping\Event\LoggableAdapter;`
`14`	`15`	`use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;`
`@@ -26,6 +27,9 @@ public function getDefaultLogEntryClass()`
`26`	`27`	`return LogEntry::class;`
`27`	`28`	`}`
`28`	`29`
	`30`	`+ /**`
	`31`	`+ * @param ClassMetadata $meta`
	`32`	`+ */`
`29`	`33`	`public function isPostInsertGenerator($meta)`
`30`	`34`	`{`
`31`	`35`	`return $meta->idGenerator->isPostInsertGenerator();`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`use Doctrine\Common\EventArgs;`
`13`	`13`	`use Doctrine\ORM\EntityManagerInterface;`
`14`	`14`	`use Doctrine\ORM\Event\LifecycleEventArgs;`
	`15`	`+use Doctrine\ORM\Mapping\ClassMetadata;`
`15`	`16`	`use Gedmo\Exception\RuntimeException;`
`16`	`17`	`use Gedmo\Mapping\Event\AdapterInterface;`
`17`	`18`
`@@ -58,6 +59,9 @@ public function getManagerName()`
`58`	`59`	`return 'ORM';`
`59`	`60`	`}`
`60`	`61`
	`62`	`+ /**`
	`63`	`+ * @param ClassMetadata $meta`
	`64`	`+ */`
`61`	`65`	`public function getRootObjectClass($meta)`
`62`	`66`	`{`
`63`	`67`	`return $meta->rootEntityName;`
`@@ -95,6 +99,9 @@ public function getObjectChangeSet($uow, $object)`
`95`	`99`	`return $uow->getEntityChangeSet($object);`
`96`	`100`	`}`
`97`	`101`
	`102`	`+ /**`
	`103`	`+ * @param ClassMetadata $meta`
	`104`	`+ */`
`98`	`105`	`public function getSingleIdentifierFieldName($meta)`
`99`	`106`	`{`
`100`	`107`	`return $meta->getSingleIdentifierFieldName();`