Merge pull request #4568 from morozov/deprecations

Trigger runtime deprecations for previously deprecated APIs
doctrine · Apr 2, 2021 · b2befb0 · b2befb0
2 parents 7de2292 + 1ccf9ef
commit b2befb0
Show file tree

Hide file tree

Showing 17 changed files with 191 additions and 3 deletions.
diff --git a/src/Connection.php b/src/Connection.php
@@ -21,6 +21,7 @@
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\SQL\Parser;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Deprecations\Deprecation;
 use Throwable;
 use Traversable;
 
@@ -69,7 +70,7 @@ class Connection
     protected $_eventManager;
 
     /**
-     * @deprecated Use {@link getExpressionBuilder()} instead.
+     * @deprecated Use {@link createExpressionBuilder()} instead.
      *
      * @var ExpressionBuilder
      */
@@ -296,6 +297,13 @@ public function createExpressionBuilder(): ExpressionBuilder
      */
     public function getExpressionBuilder()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4515',
+            'Connection::getExpressionBuilder() is deprecated,'
+                . ' use Connection::createExpressionBuilder() instead.'
+        );
+
         return $this->_expr;
     }
 
@@ -1544,6 +1552,12 @@ public function createSchemaManager(): AbstractSchemaManager
      */
     public function getSchemaManager()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4515',
+            'Connection::getSchemaManager() is deprecated, use Connection::createSchemaManager() instead.'
+        );
+
         if ($this->_schemaManager === null) {
             $this->_schemaManager = $this->createSchemaManager();
         }

diff --git a/src/Driver/PDO/SQLSrv/Statement.php b/src/Driver/PDO/SQLSrv/Statement.php
@@ -6,8 +6,11 @@
 use Doctrine\DBAL\Driver\Result;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 use PDO;
 
+use function func_num_args;
+
 final class Statement implements StatementInterface
 {
     /** @var PDOStatement */
@@ -32,6 +35,14 @@ public function __construct(PDOStatement $statement)
      */
     public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null, $driverOptions = null)
     {
+        if (func_num_args() > 4) {
+            Deprecation::triggerIfCalledFromOutside(
+                'doctrine/dbal',
+                'https://github.com/doctrine/dbal/issues/4533',
+                'The $driverOptions argument of Statement::bindParam() is deprecated.'
+            );
+        }
+
         switch ($type) {
             case ParameterType::LARGE_OBJECT:
             case ParameterType::BINARY:

diff --git a/src/Driver/PDO/Statement.php b/src/Driver/PDO/Statement.php
@@ -7,12 +7,14 @@
 use Doctrine\DBAL\Driver\Result as ResultInterface;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 use PDO;
 use PDOException;
 use PDOStatement;
 
 use function array_slice;
 use function func_get_args;
+use function func_num_args;
 
 final class Statement implements StatementInterface
 {
@@ -64,6 +66,14 @@ public function bindValue($param, $value, $type = ParameterType::STRING)
      */
     public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null, $driverOptions = null)
     {
+        if (func_num_args() > 4) {
+            Deprecation::triggerIfCalledFromOutside(
+                'doctrine/dbal',
+                'https://github.com/doctrine/dbal/issues/4533',
+                'The $driverOptions argument of Statement::bindParam() is deprecated.'
+            );
+        }
+
         $type = $this->convertParamType($type);
 
         try {

diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -2758,6 +2758,13 @@ public function getListDatabasesSQL()
      */
     public function getListNamespacesSQL()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'AbstractPlatform::getListNamespacesSQL() is deprecated,'
+                . ' use AbstractSchemaManager::listSchemaNames() instead.'
+        );
+
         throw Exception::notSupported(__METHOD__);
     }
 
@@ -3529,6 +3536,13 @@ protected function createReservedKeywordsList(): KeywordList
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'AbstractPlatform::getReservedKeywordsClass() is deprecated,'
+                . ' use AbstractPlatform::createReservedKeywordsList() instead.'
+        );
+
         throw Exception::notSupported(__METHOD__);
     }
 

diff --git a/src/Platforms/DB2Platform.php b/src/Platforms/DB2Platform.php
@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\Deprecations\Deprecation;
 
 use function array_merge;
 use function count;
@@ -901,6 +902,13 @@ public function supportsSavepoints()
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'DB2Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use DB2Platform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\DB2Keywords::class;
     }
 

diff --git a/src/Platforms/MariaDb1027Platform.php b/src/Platforms/MariaDb1027Platform.php
@@ -3,6 +3,7 @@
 namespace Doctrine\DBAL\Platforms;
 
 use Doctrine\DBAL\Types\Types;
+use Doctrine\Deprecations\Deprecation;
 
 /**
  * Provides the behavior, features and SQL dialect of the MariaDB 10.2 (10.2.7 GA) database platform.
@@ -26,6 +27,13 @@ public function getJsonTypeDeclarationSQL(array $column): string
      */
     protected function getReservedKeywordsClass(): string
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'MariaDb1027Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use MariaDb1027Platform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\MariaDb102Keywords::class;
     }
 

diff --git a/src/Platforms/MySQL57Platform.php b/src/Platforms/MySQL57Platform.php
@@ -6,6 +6,7 @@
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\SQL\Parser;
 use Doctrine\DBAL\Types\Types;
+use Doctrine\Deprecations\Deprecation;
 
 /**
  * Provides the behavior, features and SQL dialect of the MySQL 5.7 (5.7.9 GA) database platform.
@@ -64,6 +65,13 @@ protected function getRenameIndexSQL($oldIndexName, Index $index, $tableName)
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'MySQL57Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use MySQL57Platform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\MySQL57Keywords::class;
     }
 

diff --git a/src/Platforms/MySQL80Platform.php b/src/Platforms/MySQL80Platform.php
@@ -2,6 +2,8 @@
 
 namespace Doctrine\DBAL\Platforms;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * Provides the behavior, features and SQL dialect of the MySQL 8.0 (8.0 GA) database platform.
  */
@@ -14,6 +16,13 @@ class MySQL80Platform extends MySQL57Platform
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'MySQL80Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use MySQL80Platform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\MySQL80Keywords::class;
     }
 }
diff --git a/src/Platforms/MySQLPlatform.php b/src/Platforms/MySQLPlatform.php
@@ -11,6 +11,7 @@
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\BlobType;
 use Doctrine\DBAL\Types\TextType;
+use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 
 use function array_diff_key;
@@ -1110,6 +1111,13 @@ public function getBinaryMaxLength()
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'MySQLPlatform::getReservedKeywordsClass() is deprecated,'
+                . ' use MySQLPlatform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\MySQLKeywords::class;
     }
 

diff --git a/src/Platforms/OraclePlatform.php b/src/Platforms/OraclePlatform.php
@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\BinaryType;
+use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 
 use function array_merge;
@@ -1165,6 +1166,13 @@ public function releaseSavePoint($savepoint)
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'OraclePlatform::getReservedKeywordsClass() is deprecated,'
+            . ' use OraclePlatform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\OracleKeywords::class;
     }
 

diff --git a/src/Platforms/PostgreSQL100Platform.php b/src/Platforms/PostgreSQL100Platform.php
@@ -5,6 +5,7 @@
 namespace Doctrine\DBAL\Platforms;
 
 use Doctrine\DBAL\Platforms\Keywords\PostgreSQL100Keywords;
+use Doctrine\Deprecations\Deprecation;
 
 /**
  * Provides the behavior, features and SQL dialect of the PostgreSQL 10.0 database platform.
@@ -16,6 +17,13 @@ class PostgreSQL100Platform extends PostgreSQL94Platform
      */
     protected function getReservedKeywordsClass(): string
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'PostgreSQL100Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use PostgreSQL100Platform::createReservedKeywordsList() instead.'
+        );
+
         return PostgreSQL100Keywords::class;
     }
 

diff --git a/src/Platforms/PostgreSQL94Platform.php b/src/Platforms/PostgreSQL94Platform.php
@@ -14,6 +14,7 @@
 use Doctrine\DBAL\Types\BlobType;
 use Doctrine\DBAL\Types\IntegerType;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Deprecations\Deprecation;
 use UnexpectedValueException;
 
 use function array_diff;
@@ -232,6 +233,13 @@ public function getListDatabasesSQL()
      */
     public function getListNamespacesSQL()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'PostgreSQL94Platform::getListNamespacesSQL() is deprecated,'
+                . ' use PostgreSQLSchemaManager::listSchemaNames() instead.'
+        );
+
         return "SELECT schema_name AS nspname
                 FROM   information_schema.schemata
                 WHERE  schema_name NOT LIKE 'pg\_%'
@@ -1181,6 +1189,13 @@ public function hasNativeJsonType()
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'PostgreSQL94Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use PostgreSQL94Platform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\PostgreSQL94Keywords::class;
     }
 

diff --git a/src/Platforms/SQLServer2012Platform.php b/src/Platforms/SQLServer2012Platform.php
@@ -12,6 +12,7 @@
 use Doctrine\DBAL\Schema\Sequence;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
+use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 
 use function array_merge;
@@ -1165,6 +1166,13 @@ public function getListDatabasesSQL()
      */
     public function getListNamespacesSQL()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4503',
+            'SQLServer2012Platform::getListNamespacesSQL() is deprecated,'
+                . ' use SQLServerSchemaManager::listSchemaNames() instead.'
+        );
+
         return "SELECT name FROM sys.schemas WHERE name NOT IN('guest', 'INFORMATION_SCHEMA', 'sys')";
     }
 
@@ -1561,6 +1569,13 @@ public function getForUpdateSQL()
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'QLServer2012Platform::getReservedKeywordsClass() is deprecated,'
+                . ' use QLServer2012Platform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\SQLServer2012Keywords::class;
     }
 

diff --git a/src/Platforms/SqlitePlatform.php b/src/Platforms/SqlitePlatform.php
@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types;
+use Doctrine\Deprecations\Deprecation;
 
 use function array_merge;
 use function array_unique;
@@ -689,6 +690,13 @@ protected function initializeDoctrineTypeMappings()
      */
     protected function getReservedKeywordsClass()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/issues/4510',
+            'SqlitePlatform::getReservedKeywordsClass() is deprecated,'
+                . ' use SqlitePlatform::createReservedKeywordsList() instead.'
+        );
+
         return Keywords\SQLiteKeywords::class;
     }