Merge pull request #12088 from greg0ire/quote-parts

greg0ire · web-flow · commit 64444dcfd511 · 2025-08-05T08:05:51.000+02:00
Quote parts of the table name
diff --git a/src/Mapping/ClassMetadata.php b/src/Mapping/ClassMetadata.php
@@ -400,13 +400,9 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
     public DiscriminatorColumnMapping|null $discriminatorColumn = null;
 
     /**
-     * READ-ONLY: The primary table definition. The definition is an array with the
-     * following entries:
+     * READ-ONLY: The primary table definition.
      *
-     * name => <tableName>
-     * schema => <schemaName>
-     * indexes => array
-     * uniqueConstraints => array
+     * "quoted" indicates whether the table name is quoted (with backticks) or not
      *
      * @var mixed[]
      * @phpstan-var array{
diff --git a/src/Mapping/DefaultQuoteStrategy.php b/src/Mapping/DefaultQuoteStrategy.php
@@ -10,8 +10,11 @@
 use function array_map;
 use function array_merge;
 use function assert;
+use function explode;
+use function implode;
 use function is_numeric;
 use function preg_replace;
+use function sprintf;
 use function substr;
 
 /**
@@ -38,7 +41,13 @@ public function getTableName(ClassMetadata $class, AbstractPlatform $platform):
         $tableName = $class->table['name'];
 
         if (! empty($class->table['schema'])) {
-            $tableName = $class->table['schema'] . '.' . $class->table['name'];
+            return isset($class->table['quoted'])
+                ? sprintf(
+                    '%s.%s',
+                    $platform->quoteSingleIdentifier($class->table['schema']),
+                    $platform->quoteSingleIdentifier($tableName),
+                )
+                : $class->table['schema'] . '.' . $class->table['name'];
         }
 
         return isset($class->table['quoted'])
@@ -52,7 +61,10 @@ public function getTableName(ClassMetadata $class, AbstractPlatform $platform):
     public function getSequenceName(array $definition, ClassMetadata $class, AbstractPlatform $platform): string
     {
         return isset($definition['quoted'])
-            ? $platform->quoteSingleIdentifier($definition['sequenceName'])
+            ? implode('.', array_map(
+                static fn (string $part) => $platform->quoteSingleIdentifier($part),
+                explode('.', $definition['sequenceName']),
+            ))
             : $definition['sequenceName'];
     }
 
diff --git a/tests/Tests/ORM/Functional/Ticket/DDC2825Test.php b/tests/Tests/ORM/Functional/Ticket/DDC2825Test.php
@@ -11,8 +11,6 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
 
-use function sprintf;
-
 /**
  * This class makes tests on the correct use of a database schema when entities are stored
  */
@@ -30,28 +28,7 @@ protected function setUp(): void
         }
     }
 
-    #[DataProvider('getTestedClasses')]
-    public function testClassSchemaMappingsValidity(string $className, string $expectedSchemaName, string $expectedTableName): void
-    {
-        $classMetadata   = $this->_em->getClassMetadata($className);
-        $platform        = $this->_em->getConnection()->getDatabasePlatform();
-        $quotedTableName = $this->_em->getConfiguration()->getQuoteStrategy()->getTableName($classMetadata, $platform);
-
-        // Check if table name and schema properties are defined in the class metadata
-        self::assertEquals($expectedTableName, $classMetadata->table['name']);
-        self::assertEquals($expectedSchemaName, $classMetadata->table['schema']);
-
-        $fullTableName = sprintf('%s.%s', $expectedSchemaName, $expectedTableName);
-
-        self::assertEquals($fullTableName, $quotedTableName);
-
-        // Checks sequence name validity
-        self::assertEquals(
-            $fullTableName . '_' . $classMetadata->getSingleIdentifierColumnName() . '_seq',
-            $classMetadata->getSequenceName($platform),
-        );
-    }
-
+    /** @param class-string $className */
     #[DataProvider('getTestedClasses')]
     public function testPersistenceOfEntityWithSchemaMapping(string $className): void
     {
@@ -64,17 +41,14 @@ public function testPersistenceOfEntityWithSchemaMapping(string $className): voi
         self::assertCount(1, $this->_em->getRepository($className)->findAll());
     }
 
-    /**
-     * Data provider
-     *
-     * @return string[][]
-     */
+    /** @return list<array{class-string}> */
     public static function getTestedClasses(): array
     {
         return [
-            [ExplicitSchemaAndTable::class, 'explicit_schema', 'explicit_table'],
-            [SchemaAndTableInTableName::class, 'implicit_schema', 'implicit_table'],
-            [DDC2825ClassWithImplicitlyDefinedSchemaAndQuotedTableName::class, 'myschema', 'order'],
+            [ExplicitSchemaAndTable::class],
+            [SchemaAndTableInTableName::class],
+            [DDC2825ClassWithImplicitlyDefinedSchemaAndQuotedTableName::class],
+            [File::class],
         ];
     }
 }
@@ -89,3 +63,13 @@ class DDC2825ClassWithImplicitlyDefinedSchemaAndQuotedTableName
     #[ORM\Column(type: 'integer')]
     public $id;
 }
+
+#[ORM\Entity]
+#[ORM\Table(name: '`file`', schema: 'yourschema')]
+class File
+{
+    #[ORM\Id]
+    #[ORM\Column]
+    #[ORM\GeneratedValue]
+    public int $id;
+}
diff --git a/tests/Tests/ORM/Mapping/ClassMetadataTest.php b/tests/Tests/ORM/Mapping/ClassMetadataTest.php
@@ -5,6 +5,7 @@
 namespace Doctrine\Tests\ORM\Mapping;
 
 use ArrayObject;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use Doctrine\ORM\Events;
@@ -51,6 +52,7 @@
 use Doctrine\Tests\OrmTestCase;
 use DoctrineGlobalArticle;
 use LogicException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group as TestGroup;
 use PHPUnit\Framework\Attributes\WithoutErrorHandler;
 use ReflectionClass;
@@ -970,6 +972,47 @@ public function testQuotedSequenceName(): void
         );
     }
 
+    #[DataProvider('fullTableNameProvider')]
+    public function testGetSequenceName(
+        string $expectedSequenceName,
+        string $fullTableName,
+    ): void {
+        $cm = new ClassMetadata(self::class);
+        $cm->setIdentifier(['id']);
+        $cm->setPrimaryTable(['name' => $fullTableName]);
+
+        $platform = $this->createStub(AbstractPlatform::class);
+
+        self::assertSame(
+            $expectedSequenceName,
+            $cm->getSequenceName($platform),
+        );
+    }
+
+    /** @return iterable<string, array{string, string}> */
+    public static function fullTableNameProvider(): iterable
+    {
+        yield 'quoted table name with schema' => [
+            'custom.reserved_id_seq',
+            'custom.`reserved`',
+        ];
+
+        yield 'unquoted table name with schema' => [
+            'custom.non_reserved_id_seq',
+            'custom.non_reserved',
+        ];
+
+        yield 'quoted table name without schema' => [
+            'reserved_id_seq',
+            '`reserved`',
+        ];
+
+        yield 'unquoted table name without schema' => [
+            'non_reserved_id_seq',
+            'non_reserved',
+        ];
+    }
+
     #[TestGroup('DDC-2700')]
     public function testIsIdentifierMappedSuperClass(): void
     {
diff --git a/tests/Tests/ORM/Mapping/DefaultQuoteStrategyTest.php b/tests/Tests/ORM/Mapping/DefaultQuoteStrategyTest.php
@@ -6,13 +6,16 @@
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Name\UnquotedIdentifierFolding;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\DefaultQuoteStrategy;
 use Doctrine\Tests\Models\NonPublicSchemaJoins\User as NonPublicSchemaUser;
 use Doctrine\Tests\OrmTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
 
 use function assert;
 use function enum_exists;
+use function sprintf;
 
 /**
  * Doctrine\Tests\ORM\Mapping\DefaultQuoteStrategyTest
@@ -34,4 +37,48 @@ public function testGetJoinTableName(): void
             $strategy->getJoinTableName($metadata->associationMappings['readers'], $metadata, $platform),
         );
     }
+
+    #[DataProvider('fullTableNameProvider')]
+    public function testGetTableName(string $expectedFullTableName, string $tableName): void
+    {
+        $classMetadata = new ClassMetadata(self::class);
+        $classMetadata->setPrimaryTable(['name' => $tableName]);
+
+        $platform = $this->createStub(AbstractPlatform::class);
+        $platform->method('quoteSingleIdentifier')
+            ->willReturnCallback(
+                static fn (string $identifier): string => sprintf('✌️%s✌️', $identifier),
+            );
+
+        $quotedTableName = (new DefaultQuoteStrategy())->getTableName(
+            $classMetadata,
+            $platform,
+        );
+
+        self::assertSame($expectedFullTableName, $quotedTableName);
+    }
+
+    /** @return iterable<string, array{string, string}> */
+    public static function fullTableNameProvider(): iterable
+    {
+        yield 'quoted table name with schema' => [
+            '✌️custom✌️.✌️reserved✌️',
+            'custom.`reserved`',
+        ];
+
+        yield 'unquoted table name with schema' => [
+            'custom.non_reserved',
+            'custom.non_reserved',
+        ];
+
+        yield 'quoted table name without schema' => [
+            '✌️reserved✌️',
+            '`reserved`',
+        ];
+
+        yield 'unquoted table name without schema' => [
+            'non_reserved',
+            'non_reserved',
+        ];
+    }
 }
