Deprecate TableDiff::getDroppedForeignKeys()

Author: morozov

UPGRADE.md

@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 4.4
 
+## Deprecated `TableDiff::getDroppedForeignKeys()`
+
+The `TableDiff::getDroppedForeignKeys()` method has been deprecated. Use
+`TableDiff::getDroppedForeignKeyConstraintNames()` instead.
+
 ## Deprecated `AbstractSchemaManager` methods
 
 The following `AbstractSchemaManager` methods have been deprecated:

src/Schema/Exception/InvalidState.php

@@ -89,4 +89,9 @@ public static function tableHasInvalidPrimaryKeyConstraint(string $tableName): s
     {
         return new self(sprintf('Table "%s" has invalid primary key constraint.', $tableName));
     }
+
+    public static function tableDiffContainsUnnamedDroppedForeignKeyConstraints(): self
+    {
+        return new self('Table diff contains unnamed dropped foreign key constraints');
+    }
 }

src/Schema/TableDiff.php

@@ -4,6 +4,8 @@
 
 namespace Doctrine\DBAL\Schema;
 
+use Doctrine\DBAL\Schema\Exception\InvalidState;
+use Doctrine\DBAL\Schema\Name\UnqualifiedName;
 use Doctrine\Deprecations\Deprecation;
 
 use function array_filter;
@@ -235,12 +237,33 @@ public function getModifiedForeignKeys(): array
         return $this->modifiedForeignKeys;
     }
 
-    /** @return array<ForeignKeyConstraint> */
+    /**
+     * @deprecated Use {@see getDroppedForeignKeyConstraintNames()}.
+     *
+     * @return array<ForeignKeyConstraint>
+     */
     public function getDroppedForeignKeys(): array
     {
         return $this->droppedForeignKeys;
     }
 
+    /** @return array<UnqualifiedName> */
+    public function getDroppedForeignKeyConstraintNames(): array
+    {
+        $names = [];
+        foreach ($this->droppedForeignKeys as $constraint) {
+            $name = $constraint->getObjectName();
+
+            if ($name === null) {
+                throw InvalidState::tableDiffContainsUnnamedDroppedForeignKeyConstraints();
+            }
+
+            $names[] = $name;
+        }
+
+        return $names;
+    }
+
     /**
      * Returns whether the diff is empty (contains no changes).
      */

tests/Schema/AbstractComparatorTestCase.php

@@ -366,16 +366,6 @@ public function testTableAddForeignKey(): void
 
     public function testTableRemoveForeignKey(): void
     {
-        $tableForeign = Table::editor()
-            ->setUnquotedName('bar')
-            ->setColumns(
-                Column::editor()
-                    ->setUnquotedName('id')
-                    ->setTypeName(Types::INTEGER)
-                    ->create(),
-            )
-            ->create();
-
         $table1 = Table::editor()
             ->setUnquotedName('foo')
             ->setColumns(
@@ -396,6 +386,7 @@ public function testTableRemoveForeignKey(): void
             )
             ->setForeignKeyConstraints(
                 ForeignKeyConstraint::editor()
+                    ->setUnquotedName('fk_bar')
                     ->setUnquotedReferencingColumnNames('fk')
                     ->setUnquotedReferencedTableName('bar')
                     ->setUnquotedReferencedColumnNames('id')
@@ -405,7 +396,7 @@ public function testTableRemoveForeignKey(): void
 
         $tableDiff = $this->comparator->compareTables($table2, $table1);
 
-        self::assertCount(1, $tableDiff->getDroppedForeignKeys());
+        self::assertCount(1, $tableDiff->getDroppedForeignKeyConstraintNames());
     }
 
     public function testTableUpdateForeignKey(): void
@@ -420,6 +411,7 @@ public function testTableUpdateForeignKey(): void
             )
             ->setForeignKeyConstraints(
                 ForeignKeyConstraint::editor()
+                    ->setUnquotedName('fk_bar')
                     ->setUnquotedReferencingColumnNames('fk')
                     ->setUnquotedReferencedTableName('bar')
                     ->setUnquotedReferencedColumnNames('id')
@@ -447,7 +439,7 @@ public function testTableUpdateForeignKey(): void
 
         $tableDiff = $this->comparator->compareTables($table1, $table2);
 
-        self::assertCount(1, $tableDiff->getDroppedForeignKeys());
+        self::assertCount(1, $tableDiff->getDroppedForeignKeyConstraintNames());
         self::assertCount(1, $tableDiff->getAddedForeignKeys());
     }
 
@@ -463,6 +455,7 @@ public function testMovedForeignKeyForeignTable(): void
             )
             ->setForeignKeyConstraints(
                 ForeignKeyConstraint::editor()
+                    ->setUnquotedName('fk_bar')
                     ->setUnquotedReferencingColumnNames('fk')
                     ->setUnquotedReferencedTableName('bar')
                     ->setUnquotedReferencedColumnNames('id')
@@ -489,7 +482,7 @@ public function testMovedForeignKeyForeignTable(): void
 
         $tableDiff = $this->comparator->compareTables($table1, $table2);
 
-        self::assertCount(1, $tableDiff->getDroppedForeignKeys());
+        self::assertCount(1, $tableDiff->getDroppedForeignKeyConstraintNames());
         self::assertCount(1, $tableDiff->getAddedForeignKeys());
     }
 

tests/Schema/TableDiffTest.php

@@ -5,6 +5,7 @@
 namespace Doctrine\DBAL\Tests\Schema;
 
 use Doctrine\DBAL\Schema\Column;
+use Doctrine\DBAL\Schema\Exception\InvalidState;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
@@ -35,6 +36,9 @@ public function testCreateWithInvalidDroppedForeignKeyName(): void
             ->create();
 
         $this->expectDeprecationWithIdentifier('https://github.com/doctrine/dbal/pull/7143');
-        new TableDiff($table, droppedForeignKeys: [$droppedForeignKeys]);
+        $diff = new TableDiff($table, droppedForeignKeys: [$droppedForeignKeys]);
+
+        $this->expectException(InvalidState::class);
+        $diff->getDroppedForeignKeyConstraintNames();
     }
 }