Merge pull request #6610 from morozov/deprecate-set-name

Deprecate AbstractAsset::_setName()

Author: morozov

UPGRADE.md

@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 4.3
 
+## Deprecated `AbstractAsset::_setName()`
+
+Setting object name via `AbstractAsset::_setName()` has been deprecated. Pass the name to the `AbstractAsset`
+constructor instead.
+
 ## Marked `Identifier` class as internal
 
 In order to build SQL identifiers, use `AbstractPlatform::quoteSingleIdentifier()`.

psalm.xml.dist

@@ -102,6 +102,12 @@
                 -->
                 <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::createReservedKeywordsList" />
                 <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::getReservedKeywordsList" />
+
+                <!--
+                    https://github.com/doctrine/dbal/pull/6610
+                    TODO: remove in 5.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Schema\AbstractAsset::_setName" />
             </errorLevel>
         </DeprecatedMethod>
         <DeprecatedProperty>

src/Schema/AbstractAsset.php

@@ -45,11 +45,36 @@ abstract class AbstractAsset
 
     private bool $validateFuture = false;
 
+    public function __construct(?string $name = null)
+    {
+        if ($name === null) {
+            Deprecation::trigger(
+                'doctrine/dbal',
+                'https://github.com/doctrine/dbal/pull/6610',
+                'Not passing $name to %s is deprecated.',
+                __METHOD__,
+            );
+
+            return;
+        }
+
+        $this->_setName($name);
+    }
+
     /**
      * Sets the name of this asset.
+     *
+     * @deprecated Use the constructor instead.
      */
     protected function _setName(string $name): void
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/6610',
+            '%s is deprecated. Use the constructor instead.',
+            __METHOD__,
+        );
+
         $input = $name;
 
         if ($this->isIdentifierQuoted($name)) {

src/Schema/Column.php

@@ -50,7 +50,8 @@ class Column extends AbstractAsset
      */
     public function __construct(string $name, Type $type, array $options = [])
     {
-        $this->_setName($name);
+        parent::__construct($name);
+
         $this->setType($type);
         $this->setOptions($options);
     }

src/Schema/ForeignKeyConstraint.php

@@ -53,7 +53,7 @@ public function __construct(
         string $name = '',
         protected array $options = [],
     ) {
-        $this->_setName($name);
+        parent::__construct($name);
 
         $this->_localColumnNames = $this->createIdentifierMap($localColumnNames);
         $this->_foreignTableName = new Identifier($foreignTableName);

src/Schema/Identifier.php

@@ -20,7 +20,7 @@ class Identifier extends AbstractAsset
      */
     public function __construct(string $identifier, bool $quote = false)
     {
-        $this->_setName($identifier);
+        parent::__construct($identifier);
 
         if (! $quote || $this->_quoted) {
             return;

src/Schema/Index.php

@@ -47,13 +47,9 @@ public function __construct(
         array $flags = [],
         private readonly array $options = [],
     ) {
-        $isUnique = $isUnique || $isPrimary;
+        parent::__construct($name ?? '');
 
-        if ($name !== null) {
-            $this->_setName($name);
-        }
-
-        $this->_isUnique  = $isUnique;
+        $this->_isUnique  = $isUnique || $isPrimary;
         $this->_isPrimary = $isPrimary;
 
         foreach ($columns as $column) {

src/Schema/Schema.php

@@ -76,9 +76,7 @@ public function __construct(
 
         $name = $schemaConfig->getName();
 
-        if ($name !== null) {
-            $this->_setName($name);
-        }
+        parent::__construct($name ?? '');
 
         foreach ($namespaces as $namespace) {
             $this->createNamespace($namespace);
@@ -290,7 +288,12 @@ public function createTable(string $name): Table
     public function renameTable(string $oldName, string $newName): self
     {
         $table = $this->getTable($oldName);
-        $table->_setName($newName);
+
+        $identifier = new Identifier($newName);
+
+        $table->_name      = $identifier->_name;
+        $table->_namespace = $identifier->_namespace;
+        $table->_quoted    = $identifier->_quoted;
 
         $this->dropTable($oldName);
         $this->_addTable($table);

src/Schema/Sequence.php

@@ -22,7 +22,8 @@ public function __construct(
         int $initialValue = 1,
         protected ?int $cache = null,
     ) {
-        $this->_setName($name);
+        parent::__construct($name);
+
         $this->setAllocationSize($allocationSize);
         $this->setInitialValue($initialValue);
     }

src/Schema/Table.php

@@ -82,7 +82,7 @@ public function __construct(
             throw InvalidTableName::new($name);
         }
 
-        $this->_setName($name);
+        parent::__construct($name);
 
         foreach ($columns as $column) {
             $this->_addColumn($column);
@@ -299,7 +299,8 @@ final public function renameColumn(string $oldName, string $newName): Column
         }
 
         $column = $this->getColumn($oldName);
-        $column->_setName($newName);
+
+        $column->_name = $newName;
         unset($this->_columns[$oldName]);
         $this->_addColumn($column);