Improve deprecation layer

doctrine · Nov 6, 2023 · b88a8b6 · b88a8b6
1 parent 30d4dab
commit b88a8b6
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 16 deletions.
diff --git a/src/Platforms/AbstractMySQLPlatform.php b/src/Platforms/AbstractMySQLPlatform.php
@@ -717,7 +717,6 @@ public function getAlterTableSQL(TableDiff $diff)
                 $diff->getAddedForeignKeys(),
                 $diff->getModifiedForeignKeys(),
                 $diff->getDroppedForeignKeys(),
-                null,
                 $diff->getRenamedIndexes(),
             );
         }

diff --git a/src/Schema/Comparator.php b/src/Schema/Comparator.php
@@ -461,7 +461,6 @@ public function compareTables(Table $fromTable, Table $toTable): TableDiff
             $addedForeignKeys,
             $modifiedForeignKeys,
             $droppedForeignKeys,
-            null,
             $renamedIndexes,
         );
     }

diff --git a/src/Schema/Table.php b/src/Schema/Table.php
@@ -13,6 +13,7 @@
 use function array_merge;
 use function in_array;
 use function preg_match;
+use function sprintf;
 use function strlen;
 use function strtolower;
 

diff --git a/src/Schema/TableDiff.php b/src/Schema/TableDiff.php
@@ -9,6 +9,8 @@
 use function array_merge;
 use function array_values;
 use function count;
+use function current;
+use function func_get_args;
 
 /**
  * Table Diff.
@@ -135,8 +137,6 @@ class TableDiff
      */
     public $fromTable;
 
-    private bool $wasRenamedInternalUsed = false;
-
     /**
      * Constructs a TableDiff object.
      *
@@ -152,7 +152,6 @@ class TableDiff
      * @param list<ForeignKeyConstraint>        $addedForeignKeys
      * @param list<ForeignKeyConstraint>        $changedForeignKeys
      * @param list<ForeignKeyConstraint|string> $removedForeignKeys
-     * @param array<string, Column>|null        $renamedColumns
      * @param array<string,Index>               $renamedIndexes
      */
     public function __construct(
@@ -167,7 +166,6 @@ public function __construct(
         $addedForeignKeys = [],
         $changedForeignKeys = [],
         $removedForeignKeys = [],
-        $renamedColumns = null,
         $renamedIndexes = []
     ) {
         $this->name               = $tableName;
@@ -191,15 +189,23 @@ public function __construct(
             );
         }
 
-        if ($renamedColumns !== null) {
+        if (count($renamedIndexes) > 0 && current($renamedIndexes) instanceof Column) {
             Deprecation::trigger(
                 'doctrine/dbal',
                 'https://github.com/doctrine/dbal/pull/6080',
                 'Passing $renamedColumns to %s is deprecated and will be removed in the next major.',
                 __METHOD__,
             );
-            $this->renamedColumns         = $renamedColumns;
-            $this->wasRenamedInternalUsed = true;
+            /** @var array<string, Column> $renamedColumns */
+            $renamedColumns = $renamedIndexes;
+
+            $legacyChangedColumns = [];
+            foreach ($renamedColumns as $oldName => $column) {
+                $legacyChangedColumns[$oldName] = new ColumnDiff($oldName, $column, []);
+            }
+
+            $this->changedColumns = array_merge($this->changedColumns, $legacyChangedColumns);
+            $this->renamedIndexes = func_get_args()[13] ?? [];
         }
 
         $this->fromTable = $fromTable;
@@ -273,22 +279,24 @@ public function getModifiedColumns(): array
     /** @return list<ColumnDiff> */
     public function getChangedColumns(): array
     {
-        if (! $this->wasRenamedInternalUsed && count($this->renamedColumns) > 0) {
+        if (count($this->renamedColumns) > 0) {
             Deprecation::trigger(
                 'doctrine/dbal',
                 'https://github.com/doctrine/dbal/pull/6080',
                 'Modifying $renamedColumns is deprecated, this property will be removed in the next major. ' .
                 'Set $modifiedColumns in the constructor instead',
                 __METHOD__,
             );
-        }
 
-        $legacyChangedColumns = [];
-        foreach ($this->renamedColumns as $oldName => $column) {
-            $legacyChangedColumns[$oldName] = new ColumnDiff($oldName, $column, []);
+            $legacyChangedColumns = [];
+            foreach ($this->renamedColumns as $oldName => $column) {
+                $legacyChangedColumns[$oldName] = new ColumnDiff($oldName, $column, []);
+            }
+
+            return array_values(array_merge($this->changedColumns, $legacyChangedColumns));
         }
 
-        return array_values(array_merge($this->changedColumns, $legacyChangedColumns));
+        return array_values($this->changedColumns);
     }
 
     /** @return list<Column> */
@@ -298,7 +306,7 @@ public function getDroppedColumns(): array
     }
 
     /**
-     * @deprecated Use {@see getModifiedColumns()} instead.
+     * @internal Use {@see getModifiedColumns()} instead.
      *
      * @return array<string,Column>
      */