Avoid $annotation as a parameter name

doctrine · Nov 6, 2022 · 8ea7827 · 8ea7827
1 parent 218e6ad
commit 8ea7827
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 12 deletions.
diff --git a/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php b/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php
@@ -660,6 +660,8 @@ private function loadRelationShipMapping(
     /**
      * Attempts to resolve the fetch mode.
      *
+     * @param class-string $className
+     *
      * @psalm-return ClassMetadata::FETCH_* The fetch mode as defined in ClassMetadata.
      *
      * @throws MappingException If the fetch mode is not valid.

diff --git a/lib/Doctrine/ORM/Mapping/Driver/AttributeDriver.php b/lib/Doctrine/ORM/Mapping/Driver/AttributeDriver.php
@@ -566,8 +566,8 @@ public function loadMetadataForClass($className, PersistenceClassMetadata $metad
     /**
      * Attempts to resolve the fetch mode.
      *
-     * @param string $className The class name.
-     * @param string $fetchMode The fetch mode.
+     * @param class-string $className The class name.
+     * @param string       $fetchMode The fetch mode.
      *
      * @return ClassMetadata::FETCH_* The fetch mode as defined in ClassMetadata.
      *

diff --git a/lib/Doctrine/ORM/Mapping/MappingException.php b/lib/Doctrine/ORM/Mapping/MappingException.php
@@ -813,20 +813,15 @@ public static function duplicateEntityListener($listenerName, $methodName, $clas
         return new self(sprintf('Entity Listener "%s#%s()" in "%s" was already declared, but it must be declared only once.', $listenerName, $methodName, $className));
     }
 
-    /**
-     * @param string $className
-     * @param string $annotation
-     *
-     * @return MappingException
-     */
-    public static function invalidFetchMode($className, $annotation)
+    /** @param class-string $className */
+    public static function invalidFetchMode(string $className, string $fetchMode): self
     {
-        return new self("Entity '" . $className . "' has a mapping with invalid fetch mode '" . $annotation . "'");
+        return new self("Entity '" . $className . "' has a mapping with invalid fetch mode '" . $fetchMode . "'");
     }
 
-    public static function invalidGeneratedMode(string $annotation): MappingException
+    public static function invalidGeneratedMode(string $generatedMode): self
     {
-        return new self("Invalid generated mode '" . $annotation . "'");
+        return new self("Invalid generated mode '" . $generatedMode . "'");
     }
 
     /**