Deprecate passing null to some ClassMetadata methods

It can easily be avoided by callers.
doctrine · Feb 24, 2024 · fec57c1 · fec57c1
1 parent 859e6af
commit fec57c1
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 6 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,12 @@
 # Upgrade to 3.1
 
+## Deprecate passing null to several `ClassMetadata` methods
+
+Passing `null` to the following methods is deprecated and will no longer be possible in 4.0:
+
+- `Doctrine\ORM\ClassMetadata::fullyQualifiedClassName()`
+- `Doctrine\ORM\ClassMetadata::setCustomRepositoryClass()`
+
 ## Deprecate array access
 
 Using array access on instances of the following classes is deprecated:

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -489,7 +489,7 @@
     <ArgumentTypeCoercion>
       <code>$mapping</code>
       <code><![CDATA[(string) $xmlRoot['repository-class']]]></code>
-      <code><![CDATA[isset($xmlRoot['repository-class']) ? (string) $xmlRoot['repository-class'] : null]]></code>
+      <code><![CDATA[(string) $xmlRoot['repository-class']]]></code>
     </ArgumentTypeCoercion>
     <InvalidArgument>
       <code>$columnDef</code>

diff --git a/src/Mapping/ClassMetadata.php b/src/Mapping/ClassMetadata.php
@@ -7,6 +7,7 @@
 use BackedEnum;
 use BadMethodCallException;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\Instantiator\Instantiator;
 use Doctrine\Instantiator\InstantiatorInterface;
 use Doctrine\ORM\Cache\Exception\NonCacheableEntityAssociation;
@@ -2003,6 +2004,17 @@ protected function _storeAssociationMapping(AssociationMapping $assocMapping): v
      */
     public function setCustomRepositoryClass(string|null $repositoryClassName): void
     {
+        if ($repositoryClassName === null) {
+            Deprecation::trigger(
+                'doctrine/orm',
+                'https://github.com/doctrine/orm/pull/11294',
+                'Passing null to %s is deprecated and will not be supported in Doctrine ORM 4.0',
+                __METHOD__,
+            );
+
+            $this->customRepositoryClassName = null;
+        }
+
         $this->customRepositoryClassName = $this->fullyQualifiedClassName($repositoryClassName);
     }
 
@@ -2475,6 +2487,13 @@ public function getAssociationMappedByTargetField(string $assocName): string
     public function fullyQualifiedClassName(string|null $className): string|null
     {
         if ($className === null) {
+            Deprecation::trigger(
+                'doctrine/orm',
+                'https://github.com/doctrine/orm/pull/11294',
+                'Passing null to %s is deprecated and will not be supported in Doctrine ORM 4.0',
+                __METHOD__,
+            );
+
             return null;
         }
 

diff --git a/src/Mapping/ClassMetadataFactory.php b/src/Mapping/ClassMetadataFactory.php
@@ -153,7 +153,7 @@ protected function doLoadMetadata(
                 $class->setCustomGeneratorDefinition($parent->customGeneratorDefinition);
             }
 
-            if ($parent->isMappedSuperclass) {
+            if ($parent->isMappedSuperclass && $parent->customRepositoryClassName !== null) {
                 $class->setCustomRepositoryClass($parent->customRepositoryClassName);
             }
         }

diff --git a/src/Mapping/Driver/AttributeDriver.php b/src/Mapping/Driver/AttributeDriver.php
@@ -96,7 +96,10 @@ public function loadMetadataForClass(string $className, PersistenceClassMetadata
         } elseif (isset($classAttributes[Mapping\MappedSuperclass::class])) {
             $mappedSuperclassAttribute = $classAttributes[Mapping\MappedSuperclass::class];
 
-            $metadata->setCustomRepositoryClass($mappedSuperclassAttribute->repositoryClass);
+            if ($mappedSuperclassAttribute->repositoryClass !== null) {
+                $metadata->setCustomRepositoryClass($mappedSuperclassAttribute->repositoryClass);
+            }
+
             $metadata->isMappedSuperclass = true;
         } elseif (isset($classAttributes[Mapping\Embeddable::class])) {
             $metadata->isEmbeddedClass = true;

diff --git a/src/Mapping/Driver/XmlDriver.php b/src/Mapping/Driver/XmlDriver.php
@@ -87,9 +87,10 @@ public function loadMetadataForClass($className, PersistenceClassMetadata $metad
                 $metadata->markReadOnly();
             }
         } elseif ($xmlRoot->getName() === 'mapped-superclass') {
-            $metadata->setCustomRepositoryClass(
-                isset($xmlRoot['repository-class']) ? (string) $xmlRoot['repository-class'] : null,
-            );
+            if (isset($xmlRoot['repository-class'])) {
+                $metadata->setCustomRepositoryClass((string) $xmlRoot['repository-class']);
+            }
+
             $metadata->isMappedSuperclass = true;
         } elseif ($xmlRoot->getName() === 'embeddable') {
             $metadata->isEmbeddedClass = true;

diff --git a/tests/Tests/ORM/Mapping/ClassMetadataTest.php b/tests/Tests/ORM/Mapping/ClassMetadataTest.php
@@ -6,6 +6,7 @@
 
 use ArrayObject;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use Doctrine\ORM\Events;
 use Doctrine\ORM\Mapping\ChainTypedFieldMapper;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -66,6 +67,8 @@
 
 class ClassMetadataTest extends OrmTestCase
 {
+    use VerifyDeprecations;
+
     public function testClassMetadataInstanceSerialization(): void
     {
         $cm = new ClassMetadata(CmsUser::class);
@@ -1052,6 +1055,24 @@ public function testItAddingLifecycleCallbackOnEmbeddedClassIsIllegal(): void
 
         $metadata->addLifecycleCallback('foo', 'bar');
     }
+
+    public function testSettingANullRepositoryClassIsDeprecated(): void
+    {
+        $metadata = new ClassMetadata(self::class);
+
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/pull/11294');
+
+        $metadata->setCustomRepositoryClass(null);
+    }
+
+    public function testGettingAnFQCNForNullIsDeprecated(): void
+    {
+        $metadata = new ClassMetadata(self::class);
+
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/pull/11294');
+
+        $metadata->fullyQualifiedClassName(null);
+    }
 }
 
 #[MappedSuperclass]