Fix PHPDoc syntax in @param, @return and @throws docblocks

Author: phansys

src/Loggable/Document/Repository/LogEntryRepository.php

@@ -133,7 +133,7 @@ protected function fillDocument($document, array $data)
     /**
      * Get the currently used LoggableListener
      *
-     * @throws \Gedmo\Exception\RuntimeException - if listener is not found
+     * @throws \Gedmo\Exception\RuntimeException if listener is not found
      *
      * @return LoggableListener
      */

src/Loggable/Entity/Repository/LogEntryRepository.php

@@ -134,7 +134,7 @@ protected function mapValue(ClassMetadata $objectMeta, $field, &$value)
     /**
      * Get the currently used LoggableListener
      *
-     * @throws \Gedmo\Exception\RuntimeException - if listener is not found
+     * @throws \Gedmo\Exception\RuntimeException if listener is not found
      *
      * @return LoggableListener
      */

src/Mapping/Driver/AbstractAnnotationDriver.php

@@ -90,10 +90,10 @@ public function validateFullMetadata(ClassMetadata $meta, array $config)
     /**
      * Try to find out related class name out of mapping
      *
-     * @param ClassMetadata $metadata - the mapped class metadata
-     * @param $name - the related object class name
+     * @param ClassMetadata $metadata the mapped class metadata
+     * @param string        $name     the related object class name
      *
-     * @return string - related class name or empty string if does not exist
+     * @return string related class name or empty string if does not exist
      */
     protected function getRelatedClassName($metadata, $name)
     {

src/Mapping/Driver/AnnotationDriverInterface.php

@@ -22,7 +22,7 @@ interface AnnotationDriverInterface extends Driver
      *     getPropertyAnnotations([reflectionProperty])
      *     getPropertyAnnotation([reflectionProperty], [name])
      *
-     * @param object $reader - annotation reader class
+     * @param object $reader annotation reader class
      */
     public function setAnnotationReader($reader);
 }

src/Mapping/Driver/Chain.php

@@ -90,10 +90,6 @@ public function readExtendedMetadata($meta, array &$config)
 
     /**
      * Passes in the mapping read by original driver
-     *
-     * @param $driver
-     *
-     * @return void
      */
     public function setOriginalDriver($driver)
     {

src/Mapping/Driver/File.php

@@ -2,6 +2,7 @@
 
 namespace Gedmo\Mapping\Driver;
 
+use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\Mapping\Driver\FileDriver;
 use Doctrine\Persistence\Mapping\Driver\FileLocator;
 use Gedmo\Mapping\Driver;
@@ -123,10 +124,10 @@ public function setOriginalDriver($driver)
     /**
      * Try to find out related class name out of mapping
      *
-     * @param $metadata - the mapped class metadata
-     * @param $name - the related object class name
+     * @param ClassMetadata $metadata the mapped class metadata
+     * @param string        $name     the related object class name
      *
-     * @return string - related class name or empty string if does not exist
+     * @return string related class name or empty string if does not exist
      */
     protected function getRelatedClassName($metadata, $name)
     {

src/Mapping/ExtensionMetadataFactory.php

@@ -71,7 +71,7 @@ public function __construct(ObjectManager $objectManager, $extensionNamespace, $
      *
      * @param object $meta
      *
-     * @return array - the metatada configuration
+     * @return array the metatada configuration
      */
     public function getExtensionMetadata($meta)
     {

src/Mapping/MappedEventSubscriber.php

@@ -85,7 +85,7 @@ public function __construct()
      * Get an event adapter to handle event specific
      * methods
      *
-     * @throws \Gedmo\Exception\InvalidArgumentException - if event is not recognized
+     * @throws \Gedmo\Exception\InvalidArgumentException if event is not recognized
      *
      * @return \Gedmo\Mapping\Event\AdapterInterface
      */
@@ -179,7 +179,7 @@ public function getExtensionMetadataFactory(ObjectManager $objectManager)
      *     getPropertyAnnotations([reflectionProperty])
      *     getPropertyAnnotation([reflectionProperty], [name])
      *
-     * @param Reader $reader - annotation reader class
+     * @param Reader $reader annotation reader class
      */
     public function setAnnotationReader($reader)
     {

src/References/Mapping/Driver/Annotation.php

@@ -91,10 +91,6 @@ public function readExtendedMetadata($meta, array &$config)
 
     /**
      * Passes in the mapping read by original driver
-     *
-     * @param $driver
-     *
-     * @return void
      */
     public function setOriginalDriver($driver)
     {

src/Sluggable/Mapping/Driver/Annotation.php

@@ -2,6 +2,7 @@
 
 namespace Gedmo\Sluggable\Mapping\Driver;
 
+use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Exception\InvalidMappingException;
 use Gedmo\Mapping\Annotation\Slug;
 use Gedmo\Mapping\Annotation\SlugHandler;
@@ -64,7 +65,7 @@ public function readExtendedMetadata($meta, array &$config)
             ) {
                 continue;
             }
-            $config = $this->retrieveSlug($meta, $config, $property, '');
+            $config = $this->retrieveSlug($meta, $config, $property);
         }
 
         // Embedded entity
@@ -81,15 +82,11 @@ public function readExtendedMetadata($meta, array &$config)
     }
 
     /**
-     * @param $meta
-     * @param $property
-     * @param $fieldNamePrefix
-     *
-     * @return array
+     * @return array<string, array<string, mixed>>
      */
-    private function retrieveSlug($meta, array &$config, $property, $fieldNamePrefix)
+    private function retrieveSlug(ClassMetadata $meta, array &$config, \ReflectionProperty $property, ?string $fieldNamePrefix = null): array
     {
-        $fieldName = $fieldNamePrefix ? ($fieldNamePrefix.'.'.$property->getName()) : $property->getName();
+        $fieldName = null !== $fieldNamePrefix ? ($fieldNamePrefix.'.'.$property->getName()) : $property->getName();
         // slug property
         if ($slug = $this->reader->getPropertyAnnotation($property, self::SLUG)) {
             if (!$meta->hasField($fieldName)) {
@@ -127,7 +124,7 @@ private function retrieveSlug($meta, array &$config, $property, $fieldNamePrefix
                 throw new InvalidMappingException("Slug must contain at least one field for slug generation in class - {$meta->name}");
             }
             foreach ($slug->fields as $slugField) {
-                $slugFieldWithPrefix = $fieldNamePrefix ? ($fieldNamePrefix.'.'.$slugField) : $slugField;
+                $slugFieldWithPrefix = null !== $fieldNamePrefix ? ($fieldNamePrefix.'.'.$slugField) : $slugField;
                 if (!$meta->hasField($slugFieldWithPrefix)) {
                     throw new InvalidMappingException("Unable to find slug [{$slugFieldWithPrefix}] as mapped property in entity - {$meta->name}");
                 }
@@ -152,7 +149,7 @@ private function retrieveSlug($meta, array &$config, $property, $fieldNamePrefix
             }
             $sluggableFields = [];
             foreach ($slug->fields as $field) {
-                $sluggableFields[] = $fieldNamePrefix ? ($fieldNamePrefix.'.'.$field) : $field;
+                $sluggableFields[] = null !== $fieldNamePrefix ? ($fieldNamePrefix.'.'.$field) : $field;
             }
 
             // set all options