Merge branch '4.4.x' into 5.0.x

Author: morozov

UPGRADE.md

@@ -360,10 +360,26 @@ all drivers and middleware.
 
 # Upgrade to 4.4
 
+## Deprecated extension of schema classes
+
+Extending the following classes has been deprecated. Use them directly.
+
+- `Schema`
+- `Sequence`
+- `Table`
+- `View`
+
+## Deprecated features of `Table::getIndexes()`, `Table::getUniqueConstraints()` and `Table::getForeignKeys()`
+
+Using the keys of the arrays returned by `Table::getIndexes()`, `Table::getUniqueConstraints()` and
+`Table::getForeignKeys()` as index or constraint names is deprecated. Instead, retrieve the name from the index or
+constraint object using `NamedObject::getObjectName()` or `OptionallyNamedObject::getObjectName()`. In order to retrieve
+an object by name, use `Table::getIndex()`, `Table::getUniqueConstraint()` or `Table::getForeignKey()` respectively.
+
 ## Deprecated `AbstractAsset::getName()`
 
 The `AbstractAsset::getName()` method has been deprecated. Instead, use `NamedObject::getObjectName()` or 
-`OptionallyQualifiedName::getObjectName()` to get the object representation of the name. SQL context, convert the
+`OptionallyQualifiedName::getObjectName()` to get the object representation of the name. In SQL context, convert the
 resulting `Name` to SQL using `Name::toSQL()`. In other contexts, convert the resulting name to string using
 `Name::toString()`.
 

src/Platforms/SQLitePlatform.php

@@ -803,8 +803,9 @@ private function getIndexesInAlteredTable(TableDiff $diff): array
         $nameMap  = $this->getDiffColumnNameMap($diff);
 
         foreach ($indexes as $key => $index) {
+            $indexName = $index->getObjectName()->getIdentifier()->getValue();
             foreach ($diff->getRenamedIndexes() as $oldIndexName => $renamedIndex) {
-                if (strtolower($key) !== strtolower($oldIndexName)) {
+                if (strtolower($indexName) !== strtolower($oldIndexName)) {
                     continue;
                 }
 

src/Schema/Collections/ObjectSet.php

@@ -7,15 +7,17 @@
 use Doctrine\DBAL\Schema\Collections\Exception\ObjectAlreadyExists;
 use Doctrine\DBAL\Schema\Collections\Exception\ObjectDoesNotExist;
 use Doctrine\DBAL\Schema\Name\UnqualifiedName;
+use IteratorAggregate;
 
 /**
  * A set of objects where each object is uniquely identified by its {@link UnqualifiedName}.
  *
  * @internal
  *
  * @template E of object
+ * @template-extends IteratorAggregate<int, E>
  */
-interface ObjectSet
+interface ObjectSet extends IteratorAggregate
 {
     /**
      * Checks if the set is empty.

src/Schema/Collections/OptionallyUnqualifiedNamedObjectSet.php

@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Schema\Collections\Exception\ObjectDoesNotExist;
 use Doctrine\DBAL\Schema\Name\UnqualifiedName;
 use Doctrine\DBAL\Schema\OptionallyNamedObject;
+use Traversable;
 
 use function array_splice;
 use function count;
@@ -110,6 +111,12 @@ public function toList(): array
         return $this->elements;
     }
 
+    /** {@inheritDoc} */
+    public function getIterator(): Traversable
+    {
+        yield from $this->elements;
+    }
+
     /**
      * Replaces the element corresponding to the old key with the provided element.
      *

src/Schema/Collections/UnqualifiedNamedObjectSet.php

@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Schema\Collections\Exception\ObjectDoesNotExist;
 use Doctrine\DBAL\Schema\Name\UnqualifiedName;
 use Doctrine\DBAL\Schema\NamedObject;
+use Traversable;
 
 use function array_combine;
 use function array_keys;
@@ -97,6 +98,14 @@ public function toList(): array
         return array_values($this->elements);
     }
 
+    /** {@inheritDoc} */
+    public function getIterator(): Traversable
+    {
+        foreach ($this->elements as $element) {
+            yield $element;
+        }
+    }
+
     /**
      * Replaces the element corresponding to the old key with the provided element. The position of the element in the
      * set is preserved.

src/Schema/Comparator.php

@@ -228,31 +228,35 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
         $folding    = $this->platform->getUnquotedIdentifierFolding();
 
         // See if all the indexes from the old table exist in the new one
-        foreach ($newIndexes as $newIndexName => $newIndex) {
-            if ($oldTable->hasIndex($newIndexName)) {
+        foreach ($newIndexes as $newIndex) {
+            $newIndexName = $newIndex->getObjectName();
+
+            if ($oldTable->hasIndex($newIndexName->toString())) {
                 continue;
             }
 
-            $addedIndexes[$newIndexName] = $newIndex;
+            $addedIndexes[] = $newIndex;
         }
 
         // See if there are any removed indexes in the new table
-        foreach ($oldIndexes as $oldIndexName => $oldIndex) {
-            if (! $newTable->hasIndex($oldIndexName)) {
-                $droppedIndexes[$oldIndexName] = $oldIndex;
+        foreach ($oldIndexes as $oldIndex) {
+            $oldIndexName = $oldIndex->getObjectName();
+
+            if (! $newTable->hasIndex($oldIndexName->toString())) {
+                $droppedIndexes[] = $oldIndex;
 
                 continue;
             }
 
             // See if index has changed in the new table.
-            $newIndex = $newTable->getIndex($oldIndexName);
+            $newIndex = $newTable->getIndex($oldIndexName->toString());
 
             if ($oldIndex->equals($newIndex, $folding)) {
                 continue;
             }
 
-            $droppedIndexes[$oldIndexName] = $oldIndex;
-            $addedIndexes[$oldIndexName]   = $newIndex;
+            $droppedIndexes[] = $oldIndex;
+            $addedIndexes[]   = $newIndex;
         }
 
         if ($this->config->getDetectRenamedIndexes()) {
@@ -376,8 +380,8 @@ private function primaryKeyConstraintsEqual(
      * Try to find indexes that only changed their name, rename operations maybe cheaper than add/drop
      * however ambiguities between different possibilities should not lead to renaming at all.
      *
-     * @param array<string,Index> $addedIndexes
-     * @param array<string,Index> $removedIndexes
+     * @param array<Index> $addedIndexes
+     * @param array<Index> $removedIndexes
      *
      * @return array<string,Index>
      */
@@ -389,15 +393,15 @@ private function detectRenamedIndexes(
         $candidatesByName = [];
 
         // Gather possible rename candidates by comparing each added and removed index based on semantics.
-        foreach ($addedIndexes as $addedIndexName => $addedIndex) {
-            foreach ($removedIndexes as $removedIndex) {
+        foreach ($addedIndexes as $addedIndexKey => $addedIndex) {
+            foreach ($removedIndexes as $removedIndexKey => $removedIndex) {
                 if (! $addedIndex->equals($removedIndex, $folding)) {
                     continue;
                 }
 
                 $candidatesByName[$addedIndex->getObjectName()
                         ->getIdentifier()
-                        ->getValue()][] = [$removedIndex, $addedIndex, $addedIndexName];
+                        ->getValue()][] = [$removedIndexKey, $addedIndexKey];
             }
         }
 
@@ -412,28 +416,25 @@ private function detectRenamedIndexes(
                 continue;
             }
 
-            [$removedIndex, $addedIndex] = $candidates[0];
+            [$removedIndexKey, $addedIndexKey] = $candidates[0];
 
+            $removedIndex     = $removedIndexes[$removedIndexKey];
             $removedIndexName = strtolower(
                 $removedIndex->getObjectName()
                     ->getIdentifier()
                     ->getValue(),
             );
 
-            $addedIndexName = strtolower(
-                $addedIndex->getObjectName()
-                    ->getIdentifier()
-                    ->getValue(),
-            );
-
             if (isset($renamedIndexes[$removedIndexName])) {
                 continue;
             }
 
+            $addedIndex = $addedIndexes[$addedIndexKey];
+
             $renamedIndexes[$removedIndexName] = $addedIndex;
             unset(
-                $addedIndexes[$addedIndexName],
-                $removedIndexes[$removedIndexName],
+                $addedIndexes[$addedIndexKey],
+                $removedIndexes[$removedIndexKey],
             );
         }
 

src/Schema/Schema.php

@@ -53,6 +53,8 @@
  * the CREATE/DROP SQL visitors will just filter this queries and do not
  * execute them. Only the queries for the currently connected database are
  * executed.
+ *
+ * @final
  */
 class Schema
 {

src/Schema/Sequence.php

@@ -12,6 +12,7 @@
 /**
  * Sequence structure.
  *
+ * @final
  * @extends AbstractNamedObject<OptionallyQualifiedName>
  */
 class Sequence extends AbstractNamedObject

src/Schema/Table.php

@@ -48,6 +48,7 @@
 /**
  * Object Representation of a table.
  *
+ * @final
  * @extends AbstractNamedObject<OptionallyQualifiedName>
  */
 class Table extends AbstractNamedObject

src/Schema/TableEditor.php

@@ -156,7 +156,7 @@ public function renameColumn(UnqualifiedName $oldColumnName, UnqualifiedName $ne
 
     private function renameColumnInIndexes(UnqualifiedName $oldColumnName, UnqualifiedName $newColumnName): void
     {
-        foreach ($this->indexes->toList() as $index) {
+        foreach ($this->indexes as $index) {
             $modified = false;
             $columns  = [];
 
@@ -264,7 +264,7 @@ private function renameColumnInConstraints(
         $constraints = [];
         $anyModified = false;
 
-        foreach ($collection->toList() as $constraint) {
+        foreach ($collection as $constraint) {
             $newColumnNames = [];
             $modified       = false;