Add support for Doctrine DBAL 4 and ORM 3 (#494)

sonata-project · Feb 19, 2024 · 65c4a93 · 65c4a93
1 parent 1edb2ef
commit 65c4a93
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 9 deletions.
diff --git a/composer.json b/composer.json
@@ -22,14 +22,14 @@
     "homepage": "https://github.com/sonata-project/sonata-doctrine-extensions",
     "require": {
         "php": "^8.0",
-        "doctrine/dbal": "^3.4",
+        "doctrine/dbal": "^3.4 || ^4.0",
         "doctrine/persistence": "^3.0.2"
     },
     "require-dev": {
-        "doctrine/doctrine-bundle": "^2.7",
+        "doctrine/doctrine-bundle": "^2.10",
         "doctrine/event-manager": "^1.2 || ^2.0",
         "doctrine/mongodb-odm": "^2.4",
-        "doctrine/orm": "^2.14",
+        "doctrine/orm": "^2.16 || ^3.0",
         "friendsofphp/php-cs-fixer": "^3.4",
         "matthiasnoback/symfony-config-test": "^4.2 || ^5.0",
         "matthiasnoback/symfony-dependency-injection-test": "^4.2.1 || ^5.0",
@@ -50,7 +50,7 @@
     "conflict": {
         "doctrine/doctrine-bundle": "<2.7",
         "doctrine/mongodb-odm": "<2.4",
-        "doctrine/orm": "<2.14"
+        "doctrine/orm": "<2.16"
     },
     "suggest": {
         "doctrine/mongodb-odm": "If you use mongo",

diff --git a/src/Mapper/ORM/DoctrineORMMapper.php b/src/Mapper/ORM/DoctrineORMMapper.php
@@ -256,8 +256,18 @@ private function loadDiscriminatorColumns(ClassMetadata $metadata): void
             if (isset($this->discriminatorColumns[$metadata->getName()])) {
                 $arrayDiscriminatorColumns = $this->discriminatorColumns[$metadata->getName()];
                 if (isset($metadata->discriminatorColumn)) {
-                    $arrayDiscriminatorColumns = array_merge($metadata->discriminatorColumn, $this->discriminatorColumns[$metadata->getName()]);
+                    $arrayDiscriminatorColumns = array_merge(
+                        (array) $metadata->discriminatorColumn,
+                        $this->discriminatorColumns[$metadata->getName()]
+                    );
                 }
+
+                /**
+                 * ignored until https://github.com/doctrine/orm/pull/11226 is merged.
+                 *
+                 * @psalm-suppress InvalidArgument
+                 * @phpstan-ignore-next-line
+                 */
                 $metadata->setDiscriminatorColumn($arrayDiscriminatorColumns);
             }
         } catch (\ReflectionException $e) {

diff --git a/tests/App/Kernel.php b/tests/App/Kernel.php
@@ -63,6 +63,7 @@ protected function configureContainer(ContainerBuilder $container, LoaderInterfa
         $container->loadFromExtension('doctrine', [
             'dbal' => ['url' => 'sqlite://:memory:'],
             'orm' => [
+                'report_fields_where_declared' => true,
                 'mappings' => [
                     'Entity' => [
                         'type' => 'attribute',

diff --git a/tests/Mapper/DoctrineCollectorTest.php b/tests/Mapper/DoctrineCollectorTest.php
@@ -13,7 +13,7 @@
 
 namespace Sonata\Doctrine\Tests\Mapper;
 
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use PHPUnit\Framework\TestCase;
 use Sonata\Doctrine\Mapper\Builder\ColumnDefinitionBuilder;
 use Sonata\Doctrine\Mapper\Builder\OptionsBuilder;
@@ -46,7 +46,7 @@ public function testClear(): void
         $collector = DoctrineCollector::getInstance();
         $collector->addIndex(\stdClass::class, 'name', ['column']);
         $collector->addUnique(\stdClass::class, 'name', ['column']);
-        $collector->addInheritanceType(\stdClass::class, ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE);
+        $collector->addInheritanceType(\stdClass::class, ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE);
         $collector->addDiscriminatorColumn(\stdClass::class, ColumnDefinitionBuilder::create()
             ->add('columnDef', ''));
         $collector->addAssociation(\stdClass::class, 'type', OptionsBuilder::createOneToOne('foo', 'bar')

diff --git a/tests/Mapper/ORM/DoctrineORMMapperTest.php b/tests/Mapper/ORM/DoctrineORMMapperTest.php
@@ -13,7 +13,10 @@
 
 namespace Sonata\Doctrine\Tests\Mapper\ORM;
 
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\DiscriminatorColumnMapping;
+use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Sonata\Doctrine\Mapper\Builder\ColumnDefinitionBuilder;
 use Sonata\Doctrine\Mapper\Builder\OptionsBuilder;
 use Sonata\Doctrine\Mapper\DoctrineCollector;
@@ -43,7 +46,7 @@ public static function setUpBeforeClass(): void
 
         $collector->addDiscriminator(TestEntity::class, 'test', TestInheritanceEntity::class);
         $collector->addDiscriminatorColumn(TestEntity::class, $columnDefinition);
-        $collector->addInheritanceType(TestEntity::class, ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE);
+        $collector->addInheritanceType(TestEntity::class, ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE);
         $collector->addAssociation(TestEntity::class, 'mapManyToOne', $options);
         $collector->addOverride(TestEntity::class, 'setAttributeOverride', $override);
     }
@@ -62,6 +65,42 @@ public function testDoctrineMappingLoaded(): void
         static::assertInstanceOf(DoctrineORMMapper::class, $mapper);
     }
 
+    public function testLoadClassMetadata(): void
+    {
+        self::bootKernel();
+
+        /** @var DoctrineORMMapper $mapper */
+        $mapper = static::getContainer()->get('sonata.doctrine.mapper');
+
+        /** @var EntityManagerInterface $entityManager */
+        $entityManager = static::getContainer()->get('doctrine.orm.entity_manager');
+
+        $classMetadata = $entityManager->getClassMetadata(TestEntity::class);
+        $classMetadata->setDiscriminatorColumn([
+            'name' => 'discriminator',
+            'length' => 10,
+        ]);
+
+        $mapper->loadClassMetadata(new LoadClassMetadataEventArgs($classMetadata, $entityManager));
+
+        $expectedDefinition = [
+            'type' => 'string',
+            'fieldName' => 'discriminator',
+            'name' => 'discriminator',
+            'length' => 10,
+        ];
+
+        $expected = (array) ($classMetadata->discriminatorColumn instanceof DiscriminatorColumnMapping
+            ? DiscriminatorColumnMapping::fromMappingArray($expectedDefinition)
+            : $expectedDefinition);
+        ksort($expected);
+
+        $actual = (array) $classMetadata->discriminatorColumn;
+        ksort($actual);
+
+        static::assertSame($expected, $actual);
+    }
+
     /**
      * @return class-string
      */