Merge pull request #5731 from morozov/deprecate-table-methods

Deprecate Table methods

Author: morozov

UPGRADE.md

@@ -8,6 +8,13 @@ awareness about deprecated code.
 
 # Upgrade to 3.5
 
+## Deprecated `Table` methods.
+
+The `hasPrimaryKey()` method has been deprecated. Use `getPrimaryKey()` and check if the return value is not null.
+The `getPrimaryKeyColumns()` method has been deprecated. Use `getPrimaryKey()` and `Index::getColumns()` instead.
+The `getForeignKeyColumns()` method has been deprecated. Use `getForeignKey()`
+and `ForeignKeyConstraint::getLocalColumns()` instead.
+
 ## Deprecated `SchemaException` error codes.
 
 Relying on the error code of `SchemaException` is deprecated. In order to handle a specific type of exception,

psalm.xml.dist

@@ -435,6 +435,12 @@
                     TODO: remove in 4.0.0
                 -->
                 <referencedMethod name="Doctrine\DBAL\Schema\TableDiff::getName"/>
+                <!--
+                    TODO: remove in 4.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Schema\Table::getForeignKeyColumns"/>
+                <referencedMethod name="Doctrine\DBAL\Schema\Table::getPrimaryKeyColumns"/>
+                <referencedMethod name="Doctrine\DBAL\Schema\Table::hasPrimaryKey"/>
             </errorLevel>
         </DeprecatedMethod>
         <DeprecatedProperty>

src/Platforms/AbstractMySQLPlatform.php

@@ -866,6 +866,26 @@ private function getPreAlterTableAlterIndexForeignKeySQL(TableDiff $diff): array
             return [];
         }
 
+        $primaryKey = $table->getPrimaryKey();
+
+        if ($primaryKey === null) {
+            return [];
+        }
+
+        $primaryKeyColumns = [];
+
+        foreach ($primaryKey->getColumns() as $columnName) {
+            if (! $table->hasColumn($columnName)) {
+                continue;
+            }
+
+            $primaryKeyColumns[] = $table->getColumn($columnName);
+        }
+
+        if (count($primaryKeyColumns) === 0) {
+            return [];
+        }
+
         $sql = [];
 
         $tableNameSQL = $table->getQuotedName($this);
@@ -876,9 +896,9 @@ private function getPreAlterTableAlterIndexForeignKeySQL(TableDiff $diff): array
                 continue;
             }
 
-            foreach ($table->getPrimaryKeyColumns() as $columnName => $column) {
+            foreach ($primaryKeyColumns as $column) {
                 // Check if an autoincrement column was dropped from the primary key.
-                if (! $column->getAutoincrement() || in_array($columnName, $changedIndex->getColumns(), true)) {
+                if (! $column->getAutoincrement() || in_array($column->getName(), $changedIndex->getColumns(), true)) {
                     continue;
                 }
 

src/Schema/Comparator.php

@@ -330,7 +330,7 @@ public function diffTable(Table $fromTable, Table $toTable)
 
         /* See if all the indexes in "from" table exist in "to" table */
         foreach ($toTableIndexes as $indexName => $index) {
-            if (($index->isPrimary() && $fromTable->hasPrimaryKey()) || $fromTable->hasIndex($indexName)) {
+            if (($index->isPrimary() && $fromTable->getPrimaryKey() !== null) || $fromTable->hasIndex($indexName)) {
                 continue;
             }
 
@@ -343,7 +343,7 @@ public function diffTable(Table $fromTable, Table $toTable)
         foreach ($fromTableIndexes as $indexName => $index) {
             // See if index is removed in "to" table.
             if (
-                ($index->isPrimary() && ! $toTable->hasPrimaryKey()) ||
+                ($index->isPrimary() && $toTable->getPrimaryKey() === null) ||
                 ! $index->isPrimary() && ! $toTable->hasIndex($indexName)
             ) {
                 $droppedIndexes[$indexName] = $index;

src/Schema/Table.php

@@ -683,7 +683,7 @@ public function removeUniqueConstraint(string $name): void
      */
     public function getColumns()
     {
-        $primaryKeyColumns = $this->hasPrimaryKey() ? $this->getPrimaryKeyColumns() : [];
+        $primaryKeyColumns = $this->getPrimaryKey() !== null ? $this->getPrimaryKeyColumns() : [];
         $foreignKeyColumns = $this->getForeignKeyColumns();
         $remainderColumns  = $this->filterColumns(
             array_merge(array_keys($primaryKeyColumns), array_keys($foreignKeyColumns)),
@@ -696,10 +696,19 @@ public function getColumns()
     /**
      * Returns the foreign key columns
      *
+     * @deprecated Use {@see getForeignKey()} and {@see ForeignKeyConstraint::getLocalColumns()} instead.
+     *
      * @return Column[]
      */
     public function getForeignKeyColumns()
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5731',
+            '%s is deprecated. Use getForeignKey() and ForeignKeyConstraint::getLocalColumns() instead.',
+            __METHOD__,
+        );
+
         $foreignKeyColumns = [];
 
         foreach ($this->getForeignKeys() as $foreignKey) {
@@ -774,12 +783,21 @@ public function getPrimaryKey()
     /**
      * Returns the primary key columns.
      *
+     * @deprecated Use {@see getPrimaryKey()} and {@see Index::getColumns()} instead.
+     *
      * @return Column[]
      *
      * @throws Exception
      */
     public function getPrimaryKeyColumns()
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5731',
+            '%s is deprecated. Use getPrimaryKey() and Index::getColumns() instead.',
+            __METHOD__,
+        );
+
         $primaryKey = $this->getPrimaryKey();
 
         if ($primaryKey === null) {
@@ -792,10 +810,19 @@ public function getPrimaryKeyColumns()
     /**
      * Returns whether this table has a primary key.
      *
+     * @deprecated Use {@see getPrimaryKey()} instead.
+     *
      * @return bool
      */
     public function hasPrimaryKey()
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5731',
+            '%s is deprecated. Use getPrimaryKey() instead.',
+            __METHOD__,
+        );
+
         return $this->_primaryKeyName !== null && $this->hasIndex($this->_primaryKeyName);
     }