Merge pull request #6590 from morozov/deprecate-quote-identifier

Deprecate AbstractPlatform::quoteIdentifier()

Author: morozov

UPGRADE.md

@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 4.3
 
+## Deprecated `AbstractPlatform::quoteIdentifier()` and `Connection::quoteIdentifier()`
+
+The `AbstractPlatform::quoteIdentifier()` and `Connection::quoteIdentifier()` methods have been deprecated.
+Use the corresponding `quoteSingleIdentifier()` method individually for each part of a qualified name instead.
+
 ## Deprecated dropping columns referenced by constraints
 
 Dropping columns that are referenced by constraints is deprecated. The constraints should be dropped first.

psalm.xml.dist

@@ -74,6 +74,12 @@
                 -->
                 <referencedMethod name="Doctrine\DBAL\Schema\Table::removeForeignKey" />
                 <referencedMethod name="Doctrine\DBAL\Schema\Table::removeUniqueConstraint" />
+
+                <!--
+                    https://github.com/doctrine/dbal/pull/6590
+                    TODO: remove in 5.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::quoteIdentifier" />
             </errorLevel>
         </DeprecatedMethod>
         <DocblockTypeContradiction>

src/Connection.php

@@ -544,15 +544,34 @@ private function extractTypeValues(array $columns, array $types): array
      * you SHOULD use them. In general, they end up causing way more
      * problems than they solve.
      *
+     * @deprecated Use {@link quoteSingleIdentifier()} individually for each part of a qualified name instead.
+     *
      * @param string $identifier The identifier to be quoted.
      *
      * @return string The quoted identifier.
      */
     public function quoteIdentifier(string $identifier): string
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/6590',
+            'Use quoteSingleIdentifier() individually for each part of a qualified name instead.',
+            __METHOD__,
+        );
+
         return $this->getDatabasePlatform()->quoteIdentifier($identifier);
     }
 
+    /**
+     * Quotes a string so that it can be safely used as an identifier in SQL.
+     *
+     * @throws Exception
+     */
+    public function quoteSingleIdentifier(string $identifier): string
+    {
+        return $this->getDatabasePlatform()->quoteSingleIdentifier($identifier);
+    }
+
     /**
      * The usage of this method is discouraged. Use prepared statements
      * or {@see AbstractPlatform::quoteStringLiteral()} instead.

src/Platforms/AbstractPlatform.php

@@ -36,6 +36,7 @@
 use Doctrine\DBAL\Types;
 use Doctrine\DBAL\Types\Exception\TypeNotFound;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Deprecations\Deprecation;
 
 use function addcslashes;
 use function array_map;
@@ -1190,12 +1191,21 @@ public function getDropSchemaSQL(string $schemaName): string
      * you SHOULD use them. In general, they end up causing way more
      * problems than they solve.
      *
+     * @deprecated Use {@link quoteSingleIdentifier()} individually for each part of a qualified name instead.
+     *
      * @param string $identifier The identifier name to be quoted.
      *
      * @return string The quoted identifier string.
      */
     public function quoteIdentifier(string $identifier): string
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/6590',
+            'Use quoteSingleIdentifier() individually for each part of a qualified name instead.',
+            __METHOD__,
+        );
+
         if (str_contains($identifier, '.')) {
             $parts = array_map($this->quoteSingleIdentifier(...), explode('.', $identifier));
 

src/Platforms/SQLServerPlatform.php

@@ -525,7 +525,7 @@ private function getAlterTableDropDefaultConstraintClause(Column $column): strin
             );
         }
 
-        return 'DROP CONSTRAINT ' . $this->quoteIdentifier(
+        return 'DROP CONSTRAINT ' . $this->quoteSingleIdentifier(
             $column->getPlatformOption(self::OPTION_DEFAULT_CONSTRAINT_NAME),
         );
     }

src/Schema/AbstractAsset.php

@@ -131,7 +131,7 @@ public function getQuotedName(AbstractPlatform $platform): string
         $keywords = $platform->getReservedKeywordsList();
         $parts    = explode('.', $this->getName());
         foreach ($parts as $k => $v) {
-            $parts[$k] = $this->_quoted || $keywords->isKeyword($v) ? $platform->quoteIdentifier($v) : $v;
+            $parts[$k] = $this->_quoted || $keywords->isKeyword($v) ? $platform->quoteSingleIdentifier($v) : $v;
         }
 
         return implode('.', $parts);

src/Schema/OracleSchemaManager.php

@@ -305,7 +305,7 @@ public function dropTable(string $name): void
     private function getQuotedIdentifierName(string $identifier): string
     {
         if (preg_match('/[a-z]/', $identifier) === 1) {
-            return $this->platform->quoteIdentifier($identifier);
+            return $this->platform->quoteSingleIdentifier($identifier);
         }
 
         return $identifier;

tests/Functional/Platform/QuotingTest.php

@@ -43,7 +43,7 @@ public function testQuoteIdentifier(string $identifier): void
         }
 
         $query = $platform->getDummySelectSQL(
-            'NULL AS ' . $platform->quoteIdentifier($identifier),
+            'NULL AS ' . $platform->quoteSingleIdentifier($identifier),
         );
 
         $row = $this->connection->fetchAssociative($query);

tests/Functional/Schema/SchemaManagerFunctionalTestCase.php

@@ -1316,8 +1316,8 @@ private function createReservedKeywordTables(): void
     {
         $platform = $this->connection->getDatabasePlatform();
 
-        $this->dropTableIfExists($platform->quoteIdentifier('user'));
-        $this->dropTableIfExists($platform->quoteIdentifier('group'));
+        $this->dropTableIfExists($platform->quoteSingleIdentifier('user'));
+        $this->dropTableIfExists($platform->quoteSingleIdentifier('group'));
 
         $schema = new Schema();
 

tests/Platforms/AbstractPlatformTestCase.php

@@ -524,7 +524,7 @@ public function testAlterTableChangeQuotedColumn(): void
         ]);
 
         self::assertStringContainsString(
-            $this->platform->quoteIdentifier('select'),
+            $this->platform->quoteSingleIdentifier('select'),
             implode(';', $this->platform->getAlterTableSQL($tableDiff)),
         );
     }