Change instances of TheType|false to TheType|null.

doctrine · May 28, 2019 · 8449ce3 · 8449ce3
1 parent 57a9d5c
commit 8449ce3
Show file tree

Hide file tree

Showing 24 changed files with 40 additions and 45 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,11 @@
 # Upgrade to 3.0
 
+## BC BREAK: Changes in the `Doctrine\DBAL\Schema` API
+
+- Method `Doctrine\DBAL\Schema\AbstractSchemaManager::_getPortableViewDefinition()` now optionally returns null instead of false.
+- 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.
+
 ## 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/Platforms/AbstractPlatform.php b/lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
@@ -1932,7 +1932,7 @@ protected function getPostAlterTableIndexForeignKeySQL(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/DB2Platform.php b/lib/Doctrine/DBAL/Platforms/DB2Platform.php
@@ -602,7 +602,7 @@ public function getAlterTableSQL(TableDiff $diff)
 
             $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
@@ -530,7 +530,7 @@ public function getAlterTableSQL(TableDiff $diff)
         $queryParts = [];
         $newName    = $diff->getNewName();
 
-        if ($newName !== false) {
+        if ($newName !== null) {
             $queryParts[] = 'RENAME TO ' . $newName->getQuotedName($this);
         }
 
@@ -835,7 +835,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
@@ -865,7 +865,7 @@ public function getAlterTableSQL(TableDiff $diff)
 
             $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
@@ -605,7 +605,7 @@ public function getAlterTableSQL(TableDiff $diff)
 
             $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)
 
             $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
@@ -584,7 +584,7 @@ public function getAlterTableSQL(TableDiff $diff)
 
         $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
@@ -682,7 +682,7 @@ protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff)
         $sql       = [];
         $tableName = $diff->getNewName();
 
-        if ($tableName === false) {
+        if ($tableName === null) {
             $tableName = $diff->getName($this);
         }
 
@@ -911,7 +911,7 @@ public function getAlterTableSQL(TableDiff $diff)
 
             $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);
             }

diff --git a/lib/Doctrine/DBAL/Schema/AbstractSchemaManager.php b/lib/Doctrine/DBAL/Schema/AbstractSchemaManager.php
@@ -872,7 +872,7 @@ protected function _getPortableViewsList(array $views) : array
         foreach ($views as $value) {
             $view = $this->_getPortableViewDefinition($value);
 
-            if (! $view) {
+            if ($view === null) {
                 continue;
             }
 
@@ -885,12 +885,10 @@ protected function _getPortableViewsList(array $views) : array
 
     /**
      * @param array<string, mixed> $view
-     *
-     * @return View|false
      */
-    protected function _getPortableViewDefinition(array $view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
-        return false;
+        return null;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Schema/Comparator.php b/lib/Doctrine/DBAL/Schema/Comparator.php
@@ -63,7 +63,7 @@ public function compare(Schema $fromSchema, Schema $toSchema) : SchemaDiff
                 $diff->newTables[$tableName] = $toSchema->getTable($tableName);
             } else {
                 $tableDifferences = $this->diffTable($fromSchema->getTable($tableName), $toSchema->getTable($tableName));
-                if ($tableDifferences !== false) {
+                if ($tableDifferences !== null) {
                     $diff->changedTables[$tableName] = $tableDifferences;
                 }
             }
@@ -170,10 +170,8 @@ public function diffSequence(Sequence $sequence1, Sequence $sequence2) : bool
      * Returns the difference between the tables $table1 and $table2.
      *
      * If there are no differences this method returns the boolean false.
-     *
-     * @return TableDiff|false
      */
-    public function diffTable(Table $table1, Table $table2)
+    public function diffTable(Table $table1, Table $table2) : ?TableDiff
     {
         $changes                     = 0;
         $tableDifferences            = new TableDiff($table1->getName());
@@ -279,7 +277,7 @@ public function diffTable(Table $table1, Table $table2)
             $changes++;
         }
 
-        return $changes ? $tableDifferences : false;
+        return $changes ? $tableDifferences : null;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Schema/DB2SchemaManager.php b/lib/Doctrine/DBAL/Schema/DB2SchemaManager.php
@@ -175,7 +175,7 @@ protected function _getPortableTableForeignKeysList(array $tableForeignKeys) : a
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         $view = array_change_key_case($view, CASE_LOWER);
         // sadly this still segfaults on PDO_IBM, see http://pecl.php.net/bugs/bug.php?id=17199

diff --git a/lib/Doctrine/DBAL/Schema/MySqlSchemaManager.php b/lib/Doctrine/DBAL/Schema/MySqlSchemaManager.php
@@ -48,7 +48,7 @@ class MySqlSchemaManager extends AbstractSchemaManager
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
     }

diff --git a/lib/Doctrine/DBAL/Schema/OracleSchemaManager.php b/lib/Doctrine/DBAL/Schema/OracleSchemaManager.php
@@ -58,7 +58,7 @@ public function dropDatabase($database) : void
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         $view = array_change_key_case($view, CASE_LOWER);
 

diff --git a/lib/Doctrine/DBAL/Schema/PostgreSqlSchemaManager.php b/lib/Doctrine/DBAL/Schema/PostgreSqlSchemaManager.php
@@ -172,7 +172,7 @@ protected function _getPortableTriggerDefinition($trigger)
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         return new View($view['schemaname'] . '.' . $view['viewname'], $view['definition']);
     }

diff --git a/lib/Doctrine/DBAL/Schema/SQLAnywhereSchemaManager.php b/lib/Doctrine/DBAL/Schema/SQLAnywhereSchemaManager.php
@@ -213,7 +213,7 @@ protected function _getPortableTableIndexesList(array $tableIndexRows, string $t
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         $definition = preg_replace('/^.*\s+as\s+SELECT(.*)/i', 'SELECT$1', $view['view_def']);
         assert(is_string($definition));

diff --git a/lib/Doctrine/DBAL/Schema/SQLServerSchemaManager.php b/lib/Doctrine/DBAL/Schema/SQLServerSchemaManager.php
@@ -242,7 +242,7 @@ protected function getPortableNamespaceDefinition(array $namespace)
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         // @todo
         return new View($view['name'], '');

diff --git a/lib/Doctrine/DBAL/Schema/SqliteSchemaManager.php b/lib/Doctrine/DBAL/Schema/SqliteSchemaManager.php
@@ -357,7 +357,7 @@ protected function _getPortableTableColumnDefinition($tableColumn) : Column
     /**
      * {@inheritdoc}
      */
-    protected function _getPortableViewDefinition($view)
+    protected function _getPortableViewDefinition(array $view) : ?View
     {
         return new View($view['name'], $view['sql']);
     }

diff --git a/lib/Doctrine/DBAL/Schema/TableDiff.php b/lib/Doctrine/DBAL/Schema/TableDiff.php
@@ -14,8 +14,8 @@ class TableDiff
     /** @var string */
     public $name = null;
 
-    /** @var string|false */
-    public $newName = false;
+    /** @var string|null */
+    public $newName = null;
 
     /**
      * All added fields.
@@ -137,15 +137,8 @@ public function getName(AbstractPlatform $platform) : Identifier
         );
     }
 
-    /**
-     * @return Identifier|false
-     */
-    public function getNewName()
+    public function getNewName() : ?Identifier
     {
-        if ($this->newName === false) {
-            return false;
-        }
-
-        return new Identifier($this->newName);
+        return $this->newName !== null ? new Identifier($this->newName) : null;
     }
 }
diff --git a/tests/Doctrine/Tests/DBAL/Functional/Schema/ComparatorTest.php b/tests/Doctrine/Tests/DBAL/Functional/Schema/ComparatorTest.php
@@ -39,7 +39,7 @@ public function testDefaultValueComparison(string $type, $value) : void
 
         $onlineTable = $this->schemaManager->listTableDetails('default_value');
 
-        self::assertFalse($this->comparator->diffTable($table, $onlineTable));
+        self::assertNull($this->comparator->diffTable($table, $onlineTable));
     }
 
     /**

diff --git a/tests/Doctrine/Tests/DBAL/Functional/Schema/SchemaManagerFunctionalTestCase.php b/tests/Doctrine/Tests/DBAL/Functional/Schema/SchemaManagerFunctionalTestCase.php
@@ -431,7 +431,7 @@ public function testDiffListTableColumns()
         $comparator = new Comparator();
         $diff       = $comparator->diffTable($offlineTable, $onlineTable);
 
-        self::assertFalse($diff, 'No differences should be detected with the offline vs online schema.');
+        self::assertNull($diff, 'No differences should be detected with the offline vs online schema.');
     }
 
     public function testListTableIndexes()

diff --git a/tests/Doctrine/Tests/DBAL/Functional/Schema/SqliteSchemaManagerTest.php b/tests/Doctrine/Tests/DBAL/Functional/Schema/SqliteSchemaManagerTest.php
@@ -237,7 +237,7 @@ public function testDiffListIntegerAutoincrementTableColumns($integerType, $unsi
         if ($expectedComparatorDiff) {
             self::assertEmpty($this->schemaManager->getDatabasePlatform()->getAlterTableSQL($diff));
         } else {
-            self::assertFalse($diff);
+            self::assertNull($diff);
         }
     }
 

diff --git a/tests/Doctrine/Tests/DBAL/Schema/ComparatorTest.php b/tests/Doctrine/Tests/DBAL/Schema/ComparatorTest.php
@@ -622,7 +622,7 @@ public function testCompareColumnCompareCaseInsensitive()
         $c         = new Comparator();
         $tableDiff = $c->diffTable($tableA, $tableB);
 
-        self::assertFalse($tableDiff);
+        self::assertNull($tableDiff);
     }
 
     public function testCompareIndexBasedOnPropertiesNotName()
@@ -659,7 +659,7 @@ public function testCompareForeignKeyBasedOnPropertiesNotName()
         $c         = new Comparator();
         $tableDiff = $c->diffTable($tableA, $tableB);
 
-        self::assertFalse($tableDiff);
+        self::assertNull($tableDiff);
     }
 
     public function testCompareForeignKeyRestrictNoActionAreTheSame()

diff --git a/tests/Doctrine/Tests/DBAL/Schema/TableDiffTest.php b/tests/Doctrine/Tests/DBAL/Schema/TableDiffTest.php
@@ -58,7 +58,7 @@ public function testReturnsNewName()
     {
         $tableDiff = new TableDiff('foo');
 
-        self::assertFalse($tableDiff->getNewName());
+        self::assertNull($tableDiff->getNewName());
 
         $tableDiff->newName = 'bar';
-Original file line number
+Diff line change
@@ Expand Up @@
             $onlineTable = $this->schemaManager->listTableDetails('default_value');
-            self::assertFalse($this->comparator->diffTable($table, $onlineTable));
+            self::assertNull($this->comparator->diffTable($table, $onlineTable));
         }
         /**
@@ Expand Down @@