Merge pull request #9755 from greg0ire/mandatory-class-name-arg

Require new argument to joinColumnName()
doctrine · May 20, 2022 · 9384ca8 · 9384ca8
2 parents bb1fdcf + 5e536ed
commit 9384ca8
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 22 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,42 @@
 # Upgrade to 3.0
 
+## BC BREAK: New argument to `NamingStrategy::joinColumnName()`
+
+### Before
+
+```php
+<?php
+class MyStrategy implements NamingStrategy
+{
+    /**
+     * @param string $propertyName A property name.
+     */
+    public function joinColumnName($propertyName): string
+    {
+        // …
+    }
+}
+```
+
+### After
+
+The `class-string` type for `$className` can be inherited from the signature of
+the interface.
+
+```php
+<?php
+class MyStrategy implements NamingStrategy
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function joinColumnName(string $propertyName, string $className): string
+    {
+        // …
+    }
+}
+```
+
 ## BC BREAK: Remove StaticPHPDriver
 
 Use `Doctrine\Persistence\Mapping\Driver\StaticPHPDriver` from

diff --git a/lib/Doctrine/ORM/Mapping/DefaultNamingStrategy.php b/lib/Doctrine/ORM/Mapping/DefaultNamingStrategy.php
@@ -44,12 +44,7 @@ public function referenceColumnName(): string
         return 'id';
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @param class-string $className
-     */
-    public function joinColumnName(string $propertyName, ?string $className = null): string
+    public function joinColumnName(string $propertyName, string $className): string
     {
         return $propertyName . '_' . $this->referenceColumnName();
     }

diff --git a/lib/Doctrine/ORM/Mapping/NamingStrategy.php b/lib/Doctrine/ORM/Mapping/NamingStrategy.php
@@ -45,8 +45,10 @@ public function referenceColumnName(): string;
 
     /**
      * Returns a join column name for a property.
+     *
+     * @param class-string $className
      */
-    public function joinColumnName(string $propertyName/*, string $className */): string;
+    public function joinColumnName(string $propertyName, string $className): string;
 
     /**
      * Returns a join table name.

diff --git a/lib/Doctrine/ORM/Mapping/UnderscoreNamingStrategy.php b/lib/Doctrine/ORM/Mapping/UnderscoreNamingStrategy.php
@@ -79,12 +79,7 @@ public function referenceColumnName(): string
         return $this->case === CASE_UPPER ?  'ID' : 'id';
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @param class-string $className
-     */
-    public function joinColumnName(string $propertyName, ?string $className = null): string
+    public function joinColumnName(string $propertyName, string $className): string
     {
         return $this->underscore($propertyName) . '_' . $this->referenceColumnName();
     }

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -140,11 +140,6 @@ parameters:
 			count: 1
 			path: lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php
 
-		-
-			message: "#^Method Doctrine\\\\ORM\\\\Mapping\\\\NamingStrategy\\:\\:joinColumnName\\(\\) invoked with 2 parameters, 1 required\\.$#"
-			count: 2
-			path: lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php
-
 		-
 			message: "#^Negated boolean expression is always false\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -488,10 +488,6 @@
     <RedundantFunctionCall occurrences="1">
       <code>array_values</code>
     </RedundantFunctionCall>
-    <TooManyArguments occurrences="2">
-      <code>joinColumnName</code>
-      <code>joinColumnName</code>
-    </TooManyArguments>
   </file>
   <file src="lib/Doctrine/ORM/Mapping/ColumnResult.php">
     <MissingConstructor occurrences="1">