From e51ff172d4f32d9d0043dabf2b579cdd3189c295 Mon Sep 17 00:00:00 2001 From: Sergei Morozov Date: Tue, 29 Oct 2019 23:02:39 -0700 Subject: [PATCH] New deprecations for 2.10 --- UPGRADE.md | 37 +++++++++++++++++++ .../DBAL/Event/ConnectionEventArgs.php | 6 +++ .../SchemaAlterTableAddColumnEventArgs.php | 9 ++--- .../SchemaAlterTableChangeColumnEventArgs.php | 9 ++--- .../DBAL/Event/SchemaAlterTableEventArgs.php | 9 ++--- .../SchemaAlterTableRemoveColumnEventArgs.php | 9 ++--- .../SchemaAlterTableRenameColumnEventArgs.php | 9 ++--- .../Event/SchemaColumnDefinitionEventArgs.php | 2 + .../SchemaCreateTableColumnEventArgs.php | 9 ++--- .../DBAL/Event/SchemaCreateTableEventArgs.php | 9 ++--- 10 files changed, 73 insertions(+), 35 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index b79cc16c5b5..205bf991974 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -1,5 +1,42 @@ # Upgrade to 2.10 +## Deprecated `Doctrine\DBAL\Event\ConnectionEventArgs` methods + +The usage of the `getDriver()`, `getDatabasePlatform()` and `getSchemaManager()` methods of the `ConnectionEventArgs` class has been deprecated. Obtain the underlying connection via `getConnection()` and call the corresponding methods on the connection instance. + +## Deprecated `Doctrine\DBAL\Event\SchemaColumnDefinitionEventArgs` methods + +The usage of the `getDatabasePlatform()` method of the `SchemaColumnDefinitionEventArgs` class has been deprecated. Obtain the underlying connection via `getConnection()` and call the corresponding method on the connection instance. + +## Deprecated `Doctrine\DBAL\Connection` methods + +The usage of the `getHost()`, `getPort()`, `getUsername()` and `getPassword()` methods of the `Connection` class has been deprecated as they leak implementation details. + +## Deprecated array of statements in `addSql()` of `SchemaEventArgs`-based classes. + +Passing multiple SQL statements as an array to `SchemaAlterTableAddColumnEventArgs::addSql()` and the same method in other `SchemaEventArgs`-based classes is deprecated. Pass each statement as an individual argument instead. + +## Deprecated calling `AbstractSchemaManager::tablesExist()` with a string argument. + +Instead of passing a string, pass a one-element array. + +## Deprecated calling `OracleSchemaManager::createDatabase()` without an argument or by passing NULL. + +In order to create a database, always pass the database name. + +## Deprecated unused schema manager methods. + +The following methods have been deprecated as unused: + +- `AbstractSchemaManager::_getPortableFunctionsList()`, +- `AbstractSchemaManager::_getPortableFunctionDefinition()`, +- `OracleSchemaManager::_getPortableFunctionDefinition()`, +- `SqliteSchemaManager::_getPortableTableIndexDefinition()`. + +# Deprecations in `Doctrine\DBAL\Driver` + +- The usage of NULL to indicate empty `$username` or `$password` when calling `connect()` is deprecated. Use an empty string instead. + ## Deprecated `Doctrine\DBAL\Platforms::_getAlterTableIndexForeignKeySQL()` Method `Doctrine\DBAL\Platforms::_getAlterTableIndexForeignKeySQL()` has been deprecated as no longer used. diff --git a/lib/Doctrine/DBAL/Event/ConnectionEventArgs.php b/lib/Doctrine/DBAL/Event/ConnectionEventArgs.php index bb0ca886d99..5c71992cc05 100644 --- a/lib/Doctrine/DBAL/Event/ConnectionEventArgs.php +++ b/lib/Doctrine/DBAL/Event/ConnectionEventArgs.php @@ -30,6 +30,8 @@ public function getConnection() } /** + * @deprecated Use ConnectionEventArgs::getConnection() and Connection::getDriver() instead. + * * @return Driver */ public function getDriver() @@ -38,6 +40,8 @@ public function getDriver() } /** + * @deprecated Use ConnectionEventArgs::getConnection() and Connection::getDatabasePlatform() instead. + * * @return AbstractPlatform */ public function getDatabasePlatform() @@ -46,6 +50,8 @@ public function getDatabasePlatform() } /** + * @deprecated Use ConnectionEventArgs::getConnection() and Connection::getSchemaManager() instead. + * * @return AbstractSchemaManager */ public function getSchemaManager() diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableAddColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableAddColumnEventArgs.php index 2f9edfea688..ff86a93d632 100644 --- a/lib/Doctrine/DBAL/Event/SchemaAlterTableAddColumnEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaAlterTableAddColumnEventArgs.php @@ -6,6 +6,7 @@ use Doctrine\DBAL\Schema\Column; use Doctrine\DBAL\Schema\TableDiff; use function array_merge; +use function func_get_args; use function is_array; /** @@ -57,17 +58,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; } diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableChangeColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableChangeColumnEventArgs.php index 55661d5d307..354eb68bc6b 100644 --- a/lib/Doctrine/DBAL/Event/SchemaAlterTableChangeColumnEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaAlterTableChangeColumnEventArgs.php @@ -6,6 +6,7 @@ use Doctrine\DBAL\Schema\ColumnDiff; use Doctrine\DBAL\Schema\TableDiff; use function array_merge; +use function func_get_args; use function is_array; /** @@ -57,17 +58,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; } diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableEventArgs.php index 8f5f0ecf563..b10bc7a60a2 100644 --- a/lib/Doctrine/DBAL/Event/SchemaAlterTableEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaAlterTableEventArgs.php @@ -5,6 +5,7 @@ use Doctrine\DBAL\Platforms\AbstractPlatform; use Doctrine\DBAL\Schema\TableDiff; use function array_merge; +use function func_get_args; use function is_array; /** @@ -44,17 +45,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaAlterTableEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; } diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableRemoveColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableRemoveColumnEventArgs.php index 1bc9f590187..6e3d6a757c7 100644 --- a/lib/Doctrine/DBAL/Event/SchemaAlterTableRemoveColumnEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaAlterTableRemoveColumnEventArgs.php @@ -6,6 +6,7 @@ use Doctrine\DBAL\Schema\Column; use Doctrine\DBAL\Schema\TableDiff; use function array_merge; +use function func_get_args; use function is_array; /** @@ -57,17 +58,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaAlterTableRemoveColumnEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; } diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableRenameColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableRenameColumnEventArgs.php index 911ea8b4ab6..27e2825314c 100644 --- a/lib/Doctrine/DBAL/Event/SchemaAlterTableRenameColumnEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaAlterTableRenameColumnEventArgs.php @@ -6,6 +6,7 @@ use Doctrine\DBAL\Schema\Column; use Doctrine\DBAL\Schema\TableDiff; use function array_merge; +use function func_get_args; use function is_array; /** @@ -72,17 +73,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaAlterTableRenameColumnEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; } diff --git a/lib/Doctrine/DBAL/Event/SchemaColumnDefinitionEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaColumnDefinitionEventArgs.php index 19d9f93a329..80d9abe73a5 100644 --- a/lib/Doctrine/DBAL/Event/SchemaColumnDefinitionEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaColumnDefinitionEventArgs.php @@ -97,6 +97,8 @@ public function getConnection() } /** + * @deprecated Use SchemaColumnDefinitionEventArgs::getConnection() and Connection::getDatabasePlatform() instead. + * * @return AbstractPlatform */ public function getDatabasePlatform() diff --git a/lib/Doctrine/DBAL/Event/SchemaCreateTableColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaCreateTableColumnEventArgs.php index 9d24b8b9049..6d78aae5c11 100644 --- a/lib/Doctrine/DBAL/Event/SchemaCreateTableColumnEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaCreateTableColumnEventArgs.php @@ -6,6 +6,7 @@ use Doctrine\DBAL\Schema\Column; use Doctrine\DBAL\Schema\Table; use function array_merge; +use function func_get_args; use function is_array; /** @@ -57,17 +58,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; } diff --git a/lib/Doctrine/DBAL/Event/SchemaCreateTableEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaCreateTableEventArgs.php index 954f77aa55a..927a4e4efe1 100644 --- a/lib/Doctrine/DBAL/Event/SchemaCreateTableEventArgs.php +++ b/lib/Doctrine/DBAL/Event/SchemaCreateTableEventArgs.php @@ -5,6 +5,7 @@ use Doctrine\DBAL\Platforms\AbstractPlatform; use Doctrine\DBAL\Schema\Table; use function array_merge; +use function func_get_args; use function is_array; /** @@ -72,17 +73,15 @@ public function getPlatform() } /** + * Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead. + * * @param string|string[] $sql * * @return \Doctrine\DBAL\Event\SchemaCreateTableEventArgs */ public function addSql($sql) { - if (is_array($sql)) { - $this->sql = array_merge($this->sql, $sql); - } else { - $this->sql[] = $sql; - } + $this->sql = array_merge($this->sql, is_array($sql) ? $sql : func_get_args()); return $this; }