Add proper types to Doctrine\DBAL\Schema namespace.

morozov · Aug 27, 2019 · cf719bc · cf719bc
1 parent 8fa5c14
commit cf719bc
Show file tree

Hide file tree

Showing 60 changed files with 791 additions and 1,399 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,17 @@
 # Upgrade to 3.0
 
+## BC BREAK: Changes in the `Doctrine\DBAL\Schema` API
+
+- Method `Doctrine\DBAL\Schema\AbstractSchemaManager::_getPortableViewDefinition()` no longer optionally returns false. It will always return a `Doctrine\DBAL\Schema\View` instance.
+- Method `Doctrine\DBAL\Schema\Comparator::diffTable()` now optionally returns null instead of false.
+- Property `Doctrine\DBAL\Schema\TableDiff::$newName` is now optionally null instead of false.
+- Method `Doctrine\DBAL\Schema\AbstractSchemaManager::tablesExist()` no longer accepts a string. Use `Doctrine\DBAL\Schema\AbstractSchemaManager::tableExists()` instead.
+- Method `Doctrine\DBAL\Schema\OracleSchemaManager::createDatabase()` no longer accepts `null` for `$database` argument.
+- Removed unused method `Doctrine\DBAL\Schema\AbstractSchemaManager::_getPortableFunctionsList()`
+- Removed unused method `Doctrine\DBAL\Schema\AbstractSchemaManager::_getPortableFunctionDefinition()`
+- Removed unused method `Doctrine\DBAL\Schema\OracleSchemaManager::_getPortableFunctionDefinition()`
+- Removed unused method `Doctrine\DBAL\Schema\SqliteSchemaManager::_getPortableTableIndexDefinition()`
+
 ## BC BREAK: Changes in the `Doctrine\DBAL\Driver` API
 
 1. The `$username` and `$password` arguments of `::connect()` are no longer nullable. Use an empty string to indicate empty username or password.

diff --git a/lib/Doctrine/DBAL/Event/SchemaCreateTableColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaCreateTableColumnEventArgs.php
@@ -7,7 +7,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\Table;
-use function array_merge;
 use function is_array;
 
 /**
@@ -24,7 +23,7 @@ class SchemaCreateTableColumnEventArgs extends SchemaEventArgs
     /** @var AbstractPlatform */
     private $platform;
 
-    /** @var string[] */
+    /** @var array<int, string> */
     private $sql = [];
 
     public function __construct(Column $column, Table $table, AbstractPlatform $platform)
@@ -66,7 +65,9 @@ public function getPlatform()
     public function addSql($sql)
     {
         if (is_array($sql)) {
-            $this->sql = array_merge($this->sql, $sql);
+            foreach ($sql as $query) {
+                $this->sql[] = $query;
+            }
         } else {
             $this->sql[] = $sql;
         }
@@ -75,7 +76,7 @@ public function addSql($sql)
     }
 
     /**
-     * @return string[]
+     * @return array<int, string>
      */
     public function getSql()
     {

diff --git a/lib/Doctrine/DBAL/Event/SchemaCreateTableEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaCreateTableEventArgs.php
@@ -6,7 +6,6 @@
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Table;
-use function array_merge;
 use function is_array;
 
 /**
@@ -81,7 +80,9 @@ public function getPlatform()
     public function addSql($sql)
     {
         if (is_array($sql)) {
-            $this->sql = array_merge($this->sql, $sql);
+            foreach ($sql as $query) {
+                $this->sql[] = $query;
+            }
         } else {
             $this->sql[] = $sql;
         }
@@ -90,7 +91,7 @@ public function addSql($sql)
     }
 
     /**
-     * @return string[]
+     * @return array<int, string>
      */
     public function getSql()
     {

diff --git a/lib/Doctrine/DBAL/Exception/DatabaseRequired.php b/lib/Doctrine/DBAL/Exception/DatabaseRequired.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Exception;
+
+use Doctrine\DBAL\DBALException;
+use function sprintf;
+
+class DatabaseRequired extends DBALException
+{
+    public static function new(string $methodName) : self
+    {
+        return new self(
+            sprintf(
+                'A database is required for the method: %s.',
+                $methodName
+            )
+        );
+    }
+}
diff --git a/lib/Doctrine/DBAL/Id/TableGeneratorSchemaVisitor.php b/lib/Doctrine/DBAL/Id/TableGeneratorSchemaVisitor.php
@@ -28,7 +28,7 @@ public function __construct($generatorTableName = 'sequences')
     /**
      * {@inheritdoc}
      */
-    public function acceptSchema(Schema $schema)
+    public function acceptSchema(Schema $schema) : void
     {
         $table = $schema->createTable($this->generatorTableName);
         $table->addColumn('sequence_name', 'string');
@@ -39,35 +39,35 @@ public function acceptSchema(Schema $schema)
     /**
      * {@inheritdoc}
      */
-    public function acceptTable(Table $table)
+    public function acceptTable(Table $table) : void
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function acceptColumn(Table $table, Column $column)
+    public function acceptColumn(Table $table, Column $column) : void
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function acceptForeignKey(Table $localTable, ForeignKeyConstraint $fkConstraint)
+    public function acceptForeignKey(Table $localTable, ForeignKeyConstraint $fkConstraint) : void
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function acceptIndex(Table $table, Index $index)
+    public function acceptIndex(Table $table, Index $index) : void
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function acceptSequence(Sequence $sequence)
+    public function acceptSequence(Sequence $sequence) : void
     {
     }
 }
diff --git a/lib/Doctrine/DBAL/Platforms/AbstractPlatform.php b/lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
@@ -1274,7 +1274,7 @@ public function getDropForeignKeySQL($foreignKey, $table) : string
      * Returns the SQL statement(s) to create a table with the specified name, columns and constraints
      * on this platform.
      *
-     * @return string[] The sequence of SQL statements.
+     * @return array<int, string> The sequence of SQL statements.
      *
      * @throws DBALException
      */
@@ -1420,7 +1420,7 @@ public function getInlineColumnCommentSQL(?string $comment) : string
      * @param mixed[][] $columns
      * @param mixed[]   $options
      *
-     * @return string[]
+     * @return array<int, string>
      */
     protected function _getCreateTableSQL(string $tableName, array $columns, array $options = []) : array
     {
@@ -1450,7 +1450,7 @@ protected function _getCreateTableSQL(string $tableName, array $columns, array $
         }
         $query .= ')';
 
-        $sql[] = $query;
+        $sql = [$query];
 
         if (isset($options['foreignKeys'])) {
             foreach ((array) $options['foreignKeys'] as $definition) {
@@ -1656,7 +1656,7 @@ public function getCreateForeignKeySQL(ForeignKeyConstraint $foreignKey, $table)
      *
      * This method returns an array of SQL statements, since some platforms need several statements.
      *
-     * @return string[]
+     * @return array<int, string>
      *
      * @throws DBALException If not supported on this platform.
      */
@@ -1805,7 +1805,7 @@ protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff) : array
         $sql     = [];
         $newName = $diff->getNewName();
 
-        if ($newName !== false) {
+        if ($newName !== null) {
             $tableName = $newName->getQuotedName($this);
         } else {
             $tableName = $diff->getName($this)->getQuotedName($this);

diff --git a/lib/Doctrine/DBAL/Platforms/DB2Platform.php b/lib/Doctrine/DBAL/Platforms/DB2Platform.php
@@ -597,7 +597,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
 
             $newName = $diff->getNewName();
 
-            if ($newName !== false) {
+            if ($newName !== null) {
                 $sql[] = sprintf(
                     'RENAME TABLE %s TO %s',
                     $diff->getName($this)->getQuotedName($this),

diff --git a/lib/Doctrine/DBAL/Platforms/MySqlPlatform.php b/lib/Doctrine/DBAL/Platforms/MySqlPlatform.php
@@ -510,7 +510,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
         $queryParts = [];
         $newName    = $diff->getNewName();
 
-        if ($newName !== false) {
+        if ($newName !== null) {
             $queryParts[] = 'RENAME TO ' . $newName->getQuotedName($this);
         }
 
@@ -815,7 +815,7 @@ protected function getPostAlterTableRenameIndexForeignKeySQL(TableDiff $diff) :
         $sql     = [];
         $newName = $diff->getNewName();
 
-        if ($newName !== false) {
+        if ($newName !== null) {
             $tableName = $newName->getQuotedName($this);
         } else {
             $tableName = $diff->getName($this)->getQuotedName($this);

diff --git a/lib/Doctrine/DBAL/Platforms/OraclePlatform.php b/lib/Doctrine/DBAL/Platforms/OraclePlatform.php
@@ -461,7 +461,7 @@ public function getDropViewSQL(string $name) : string
     }
 
     /**
-     * @return string[]
+     * @return array<int, string>
      */
     public function getCreateAutoincrementSql(string $name, string $table, int $start = 1) : array
     {
@@ -854,7 +854,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
 
             $newName = $diff->getNewName();
 
-            if ($newName !== false) {
+            if ($newName !== null) {
                 $sql[] = sprintf(
                     'ALTER TABLE %s RENAME TO %s',
                     $diff->getName($this)->getQuotedName($this),

diff --git a/lib/Doctrine/DBAL/Platforms/PostgreSqlPlatform.php b/lib/Doctrine/DBAL/Platforms/PostgreSqlPlatform.php
@@ -591,7 +591,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
 
             $newName = $diff->getNewName();
 
-            if ($newName !== false) {
+            if ($newName !== null) {
                 $sql[] = sprintf(
                     'ALTER TABLE %s RENAME TO %s',
                     $diff->getName($this)->getQuotedName($this),

diff --git a/lib/Doctrine/DBAL/Platforms/SQLAnywherePlatform.php b/lib/Doctrine/DBAL/Platforms/SQLAnywherePlatform.php
@@ -190,7 +190,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
 
             $newName = $diff->getNewName();
 
-            if ($newName !== false) {
+            if ($newName !== null) {
                 $sql[] = $this->getAlterTableClause($diff->getName($this)) . ' ' .
                     $this->getAlterTableRenameTableClause($newName);
             }

diff --git a/lib/Doctrine/DBAL/Platforms/SQLServerPlatform.php b/lib/Doctrine/DBAL/Platforms/SQLServerPlatform.php
@@ -579,7 +579,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
 
         $newName = $diff->getNewName();
 
-        if ($newName !== false) {
+        if ($newName !== null) {
             $sql[] = "sp_RENAME '" . $diff->getName($this)->getQuotedName($this) . "', '" . $newName->getName() . "'";
 
             /**

diff --git a/lib/Doctrine/DBAL/Platforms/SqlitePlatform.php b/lib/Doctrine/DBAL/Platforms/SqlitePlatform.php
@@ -684,7 +684,7 @@ protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff) : array
         $sql       = [];
         $tableName = $diff->getNewName();
 
-        if ($tableName === false) {
+        if ($tableName === null) {
             $tableName = $diff->getName($this);
         }
 
@@ -911,7 +911,7 @@ public function getAlterTableSQL(TableDiff $diff) : array
 
             $newName = $diff->getNewName();
 
-            if ($newName !== false) {
+            if ($newName !== null) {
                 $sql[] = sprintf(
                     'ALTER TABLE %s RENAME TO %s',
                     $newTable->getQuotedName($this),
@@ -993,7 +993,7 @@ private function getSimpleAlterTableSQL(TableDiff $diff)
         }
 
         if (! $this->onSchemaAlterTable($diff, $tableSql)) {
-            if ($diff->newName !== false) {
+            if ($diff->newName !== null) {
                 $newTable = new Identifier($diff->newName);
                 $sql[]    = 'ALTER TABLE ' . $table->getQuotedName($this) . ' RENAME TO ' . $newTable->getQuotedName($this);
             }