Merge pull request #6675 from morozov/5.0.x

Merge 4.3.x up into 5.0.x

Author: morozov

UPGRADE.md

@@ -80,6 +80,11 @@ all drivers and middleware.
 
 # Upgrade to 4.3
 
+## Deprecated `AbstractAsset::getQuotedName()`
+
+The `AbstractAsset::getQuotedName()` method has been deprecated. Use `NamedObject::getObjectName()` or
+`OptionallyQualifiedName::getObjectName()` followed by `Name::toSQL()` instead.
+
 ## Deprecated `AbstractAsset` namespace-related methods and property
 
 The following namespace-related methods and property have been deprecated:

psalm.xml.dist

@@ -62,6 +62,12 @@
                 -->
                 <referencedMethod name="Doctrine\DBAL\Schema\AbstractAsset::getNameParser" />
                 <referencedMethod name="Doctrine\DBAL\Schema\AbstractAsset::setName" />
+
+                <!--
+                    https://github.com/doctrine/dbal/pull/6674
+                    TODO: remove in 5.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Schema\AbstractAsset::getQuotedName" />
             </errorLevel>
         </DeprecatedMethod>
         <DocblockTypeContradiction>

src/Schema/AbstractAsset.php

@@ -12,6 +12,7 @@
 use Doctrine\DBAL\Schema\Name\OptionallyQualifiedName;
 use Doctrine\DBAL\Schema\Name\Parser;
 use Doctrine\DBAL\Schema\Name\UnqualifiedName;
+use Doctrine\Deprecations\Deprecation;
 
 use function array_map;
 use function assert;
@@ -148,9 +149,19 @@ public function getName(): string
     /**
      * Returns the quoted representation of this asset's name. If the name is unquoted, it is normalized according to
      * the platform's unquoted name normalization rules.
+     *
+     * @deprecated Use {@see NamedObject::getObjectName()} or {@see OptionallyQualifiedName::getObjectName()} followed
+     * by {@see Name::toSQL()} instead.
      */
     public function getQuotedName(AbstractPlatform $platform): string
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/6674',
+            '%s is deprecated and will be removed in 5.0.',
+            __METHOD__,
+        );
+
         $parts = array_map(static function (Identifier $identifier) use ($platform): string {
             $value = $identifier->getValue();
 

src/Schema/Name.php

@@ -4,11 +4,18 @@
 
 namespace Doctrine\DBAL\Schema;
 
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+
 /**
  * Represents a database object name.
  */
 interface Name
 {
+    /**
+     * Returns the SQL representation of the name for the given platform.
+     */
+    public function toSQL(AbstractPlatform $platform): string;
+
     /**
      * Returns the string representation of the name.
      *

src/Schema/Name/AbstractName.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Schema\Name;
 
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Name;
 
 use function array_map;
@@ -25,11 +26,19 @@ public function __construct(Identifier $firstIdentifier, Identifier ...$otherIde
         $this->identifiers = array_merge([$firstIdentifier], array_values($otherIdentifiers));
     }
 
+    public function toSQL(AbstractPlatform $platform): string
+    {
+        return $this->joinIdentifiers(static fn (Identifier $identifier): string => $identifier->toSql($platform));
+    }
+
     public function toString(): string
     {
-        return implode('.', array_map(
-            static fn (Identifier $identifier): string => $identifier->toString(),
-            $this->identifiers,
-        ));
+        return $this->joinIdentifiers(static fn (Identifier $identifier): string => $identifier->toString());
+    }
+
+    /** @param callable(Identifier): string $mapper */
+    private function joinIdentifiers(callable $mapper): string
+    {
+        return implode('.', array_map($mapper, $this->identifiers));
     }
 }

src/Schema/Name/Identifier.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Schema\Name;
 
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Exception\InvalidIdentifier;
 
 use function sprintf;
@@ -34,6 +35,17 @@ public function isQuoted(): bool
         return $this->isQuoted;
     }
 
+    public function toSql(AbstractPlatform $platform): string
+    {
+        if (! $this->isQuoted) {
+            $value = $platform->normalizeUnquotedIdentifier($this->value);
+        } else {
+            $value = $this->value;
+        }
+
+        return $platform->quoteSingleIdentifier($value);
+    }
+
     public function toString(): string
     {
         if (! $this->isQuoted) {