Implement compatibility with Persistence 4

composer.json

@@ -30,7 +30,7 @@
         "doctrine/inflector": "^1.4 || ^2.0",
         "doctrine/instantiator": "^1.3 || ^2",
         "doctrine/lexer": "^3",
-        "doctrine/persistence": "^3.3.1",
+        "doctrine/persistence": "4.0.x-dev",
         "psr/cache": "^1 || ^2 || ^3",
         "symfony/console": "^5.4 || ^6.0 || ^7.0",
         "symfony/var-exporter": "^6.3.9 || ^7.0"

phpcs.xml.dist

@@ -48,6 +48,8 @@
     </rule>
 
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+        <exclude-pattern>src/Mapping/Driver/LoadMappingFileImplementation.php</exclude-pattern>
+        <exclude-pattern>src/Mapping/GetReflectionClassImplementation.php</exclude-pattern>
         <exclude-pattern>tests/*</exclude-pattern>
     </rule>
 

phpstan-baseline.neon

@@ -120,11 +120,21 @@ parameters:
 			count: 1
 			path: src/EntityRepository.php
 
+		-
+			message: "#^If condition is always true\\.$#"
+			count: 1
+			path: src/Mapping/ClassMetadata.php
+
 		-
 			message: "#^If condition is always true\\.$#"
 			count: 1
 			path: src/Mapping/ClassMetadataFactory.php
 
+		-
+			message: "#^Method Doctrine\\\\ORM\\\\Mapping\\\\Driver\\\\XmlDriver\\:\\:doLoadMappingFile\\(\\) is unused\\.$#"
+			count: 1
+			path: src/Mapping/Driver/XmlDriver.php
+
 		-
 			message: "#^Method Doctrine\\\\ORM\\\\Mapping\\\\ToOneOwningSideMapping\\:\\:fromMappingArray\\(\\) should return static\\(Doctrine\\\\ORM\\\\Mapping\\\\ToOneOwningSideMapping\\) but returns Doctrine\\\\ORM\\\\Mapping\\\\ManyToOneAssociationMapping\\|Doctrine\\\\ORM\\\\Mapping\\\\OneToOneOwningSideMapping\\.$#"
 			count: 1

phpstan.neon

@@ -3,6 +3,9 @@ includes:
     - phpstan-params.neon
 
 parameters:
+    excludePaths:
+        - src/Mapping/Driver/LoadMappingFileImplementation.php
+        - src/Mapping/GetReflectionClassImplementation.php
     ignoreErrors:
         # Symfony cache supports passing a key prefix to the clear method.
         - '/^Method Psr\\Cache\\CacheItemPoolInterface\:\:clear\(\) invoked with 1 parameter, 0 required\.$/'

psalm-baseline.xml

@@ -300,15 +300,9 @@
       <code><![CDATA[$mapping]]></code>
       <code><![CDATA[$overrideMapping]]></code>
     </InvalidArgument>
-    <InvalidNullableReturnType>
-      <code><![CDATA[ReflectionClass|null]]></code>
-    </InvalidNullableReturnType>
     <InvalidPropertyAssignmentValue>
       <code><![CDATA[$definition]]></code>
     </InvalidPropertyAssignmentValue>
-    <NullableReturnStatement>
-      <code><![CDATA[$this->reflClass]]></code>
-    </NullableReturnStatement>
     <ParamNameMismatch>
       <code><![CDATA[$entity]]></code>
     </ParamNameMismatch>
@@ -342,6 +336,7 @@
     <RedundantCondition>
       <code><![CDATA[$mapping !== false]]></code>
       <code><![CDATA[$mapping !== false]]></code>
+      <code><![CDATA[$this->reflClass]]></code>
     </RedundantCondition>
     <RedundantFunctionCall>
       <code><![CDATA[array_values]]></code>
@@ -475,6 +470,14 @@
       <code><![CDATA[getIndexes]]></code>
     </PossiblyNullReference>
   </file>
+  <file src="src/Mapping/Driver/LoadMappingFileImplementation.php">
+    <LessSpecificImplementedReturnType>
+      <code><![CDATA[array]]></code>
+    </LessSpecificImplementedReturnType>
+    <MissingParamType>
+      <code><![CDATA[$file]]></code>
+    </MissingParamType>
+  </file>
   <file src="src/Mapping/Driver/SimplifiedXmlDriver.php">
     <MissingParamType>
       <code><![CDATA[$fileExtension]]></code>
@@ -527,6 +530,14 @@
       <code><![CDATA[$metadata]]></code>
     </MoreSpecificImplementedParamType>
   </file>
+  <file src="src/Mapping/GetReflectionClassImplementation.php">
+    <ImplementedReturnTypeMismatch>
+      <code><![CDATA[ReflectionClass]]></code>
+    </ImplementedReturnTypeMismatch>
+    <InvalidNullableReturnType>
+      <code><![CDATA[ReflectionClass]]></code>
+    </InvalidNullableReturnType>
+  </file>
   <file src="src/Mapping/ManyToManyInverseSideMapping.php">
     <PropertyNotSetInConstructor>
       <code><![CDATA[ManyToManyInverseSideMapping]]></code>

src/EntityManager.php

@@ -560,9 +560,9 @@ public function initializeObject(object $obj): void
     /**
      * {@inheritDoc}
      */
-    public function isUninitializedObject($obj): bool
+    public function isUninitializedObject($value): bool
     {
-        return $this->unitOfWork->isUninitializedObject($obj);
+        return $this->unitOfWork->isUninitializedObject($value);
     }
 
     public function getFilters(): FilterCollection

src/Exception/NotSupported.php

@@ -8,14 +8,15 @@
 
 use function sprintf;
 
-/** @deprecated */
 final class NotSupported extends LogicException implements ORMException
 {
+    /** @deprecated */
     public static function create(): self
     {
         return new self('This behaviour is (currently) not supported by Doctrine 2');
     }
 
+    /** @deprecated */
     public static function createForDbal3(string $context): self
     {
         return new self(sprintf(
@@ -29,6 +30,7 @@ public static function createForDbal3(string $context): self
         ));
     }
 
+    /** @deprecated */
     public static function createForPersistence3(string $context): self
     {
         return new self(sprintf(
@@ -41,4 +43,16 @@ public static function createForPersistence3(string $context): self
             $context,
         ));
     }
+
+    public static function createForPersistence4(string $context): self
+    {
+        return new self(sprintf(
+            <<<'EXCEPTION'
+            Context: %s
+            Problem: Feature was deprecated in doctrine/persistence 3.x and is not supported by installed doctrine/persistence:4.x
+            Solution: See the doctrine/deprecations logs for new alternative approaches.
+            EXCEPTION,
+            $context,
+        ));
+    }
 }

src/Mapping/ClassMetadata.php

@@ -70,6 +70,8 @@
  */
 class ClassMetadata implements PersistenceClassMetadata, Stringable
 {
+    use GetReflectionClassImplementation;
+
     /* The inheritance mapping types */
     /**
      * NONE means the class does not participate in an inheritance hierarchy
@@ -929,16 +931,6 @@ public function validateLifecycleCallbacks(ReflectionService $reflService): void
         }
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * Can return null when using static reflection, in violation of the LSP
-     */
-    public function getReflectionClass(): ReflectionClass|null
-    {
-        return $this->reflClass;
-    }
-
     /** @psalm-param array{usage?: mixed, region?: mixed} $cache */
     public function enableCache(array $cache): void
     {

src/Mapping/Driver/DatabaseDriver.php

@@ -12,17 +12,20 @@
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Inflector\Inflector;
 use Doctrine\Inflector\InflectorFactory;
+use Doctrine\ORM\Exception\NotSupported;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\MappingException;
 use Doctrine\Persistence\Mapping\ClassMetadata as PersistenceClassMetadata;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
+use Doctrine\Persistence\Mapping\StaticReflectionService;
 use InvalidArgumentException;
 use TypeError;
 
 use function array_diff;
 use function array_keys;
 use function array_merge;
 use function assert;
+use function class_exists;
 use function count;
 use function current;
 use function get_debug_type;
@@ -79,6 +82,10 @@ class DatabaseDriver implements MappingDriver
 
     public function __construct(private readonly AbstractSchemaManager $sm)
     {
+        if (! class_exists(StaticReflectionService::class)) {
+            throw NotSupported::createForPersistence4('StaticReflectionService');
+        }
+
         $this->inflector = InflectorFactory::create()->build();
     }
 

src/Mapping/Driver/LoadMappingFileImplementation.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Mapping\Driver;
+
+use Doctrine\Persistence\Mapping\StaticReflectionService;
+
+use function class_exists;
+
+if (class_exists(StaticReflectionService::class)) {
+    /** @internal */
+    trait LoadMappingFileImplementation
+    {
+        /**
+         * {@inheritDoc}
+         */
+        protected function loadMappingFile($file)
+        {
+            return $this->doLoadMappingFile($file);
+        }
+    }
+} else {
+    /** @internal */
+    trait LoadMappingFileImplementation
+    {
+        /**
+         * {@inheritDoc}
+         */
+        protected function loadMappingFile($file): array
+        {
+            return $this->doLoadMappingFile($file);
+        }
+    }
+}

src/Mapping/Driver/XmlDriver.php

@@ -43,6 +43,8 @@
  */
 class XmlDriver extends FileDriver
 {
+    use LoadMappingFileImplementation;
+
     public const DEFAULT_FILE_EXTENSION = '.dcm.xml';
 
     /**
@@ -876,10 +878,8 @@ private function getCascadeMappings(SimpleXMLElement $cascadeElement): array
         return $cascades;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    protected function loadMappingFile($file)
+    /** @return array<class-string, SimpleXMLElement> */
+    private function doLoadMappingFile(string $file): array
     {
         $this->validateMapping($file);
         $result = [];

src/Mapping/GetReflectionClassImplementation.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Mapping;
+
+use Doctrine\Persistence\Mapping\StaticReflectionService;
+use ReflectionClass;
+
+use function class_exists;
+
+if (class_exists(StaticReflectionService::class)) {
+    trait GetReflectionClassImplementation
+    {
+        /**
+         * {@inheritDoc}
+         *
+         * Can return null when using static reflection, in violation of the LSP
+         */
+        public function getReflectionClass(): ReflectionClass|null
+        {
+            return $this->reflClass;
+        }
+    }
+} else {
+    trait GetReflectionClassImplementation
+    {
+        public function getReflectionClass(): ReflectionClass
+        {
+            return $this->reflClass;
+        }
+    }
+}

tests/Tests/Mocks/MetadataDriverMock.php

@@ -15,22 +15,22 @@ class MetadataDriverMock implements MappingDriver
     /**
      * {@inheritDoc}
      */
-    public function loadMetadataForClass($className, ClassMetadata $metadata)
+    public function loadMetadataForClass($className, ClassMetadata $metadata): void
     {
     }
 
     /**
      * {@inheritDoc}
      */
-    public function isTransient($className)
+    public function isTransient($className): bool
     {
         return false;
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getAllClassNames()
+    public function getAllClassNames(): array
     {
         return [];
     }

tests/Tests/ORM/Functional/DatabaseDriverTestCase.php

@@ -6,10 +6,12 @@
 
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\Driver\DatabaseDriver;
+use Doctrine\Persistence\Mapping\StaticReflectionService;
 use Doctrine\Tests\OrmFunctionalTestCase;
 
 use function array_keys;
 use function array_map;
+use function class_exists;
 use function count;
 use function implode;
 use function in_array;
@@ -20,6 +22,13 @@
  */
 abstract class DatabaseDriverTestCase extends OrmFunctionalTestCase
 {
+    protected function setUp(): void
+    {
+        if (! class_exists(StaticReflectionService::class)) {
+            self::markTestSkipped('This test is not supported by the current installed doctrine/persistence version');
+        }
+    }
+
     /** @psalm-return array<string, ClassMetadata> */
     protected function convertToClassMetadata(array $entityTables, array $manyTables = []): array
     {

tests/Tests/ORM/Functional/Ticket/DDC3103Test.php

@@ -7,17 +7,26 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\Column;
 use Doctrine\ORM\Mapping\Embeddable;
+use Doctrine\Persistence\Mapping\StaticReflectionService;
 use Doctrine\Tests\OrmFunctionalTestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Group;
 
+use function class_exists;
 use function serialize;
 use function unserialize;
 
 #[CoversClass(ClassMetadata::class)]
 #[Group('DDC-3103')]
 class DDC3103Test extends OrmFunctionalTestCase
 {
+    protected function setUp(): void
+    {
+        if (! class_exists(StaticReflectionService::class)) {
+            self::markTestSkipped('This test is not supported by the current installed doctrine/persistence version');
+        }
+    }
+
     public function testIssue(): void
     {
         $classMetadata = new ClassMetadata(DDC3103ArticleId::class);
@@ -39,7 +48,6 @@ public function testIssue(): void
 #[Embeddable]
 class DDC3103ArticleId
 {
-    /** @var string */
     #[Column(name: 'name', type: 'string', length: 255)]
-    protected $nameValue;
+    protected string $nameValue;
 }