Merge pull request #5433 from morozov/deprecate-keyword-list-get-name

Deprecate KeywordList::getName()

UPGRADE.md

@@ -10,8 +10,13 @@ awareness about deprecated code.
 
 ## Deprecated the functionality of checking schema for the usage of reserved keywords.
 
-The `dbal:reserved-words` console command and the `ReservedWordsCommand` and `ReservedKeywordsValidator` classes
-have been deprecated. Use the documentation on the used database platform(s) instead.
+The following components have been deprecated:
+
+1. The `dbal:reserved-words` console command.
+2. The `ReservedWordsCommand` and `ReservedKeywordsValidator` classes.
+3. The `KeywordList::getName()` method.
+
+Use the documentation on the used database platform(s) instead.
 
 ## Deprecated `CreateSchemaSqlCollector` and `DropSchemaSqlCollector`.
 

psalm.xml.dist

@@ -293,6 +293,10 @@
                     TODO: remove in 4.0.0
                 -->
                 <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::supportsForeignKeyConstraints"/>
+                <!--
+                    TODO: remove in 4.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Platforms\Keywords\KeywordList::getName"/>
             </errorLevel>
         </DeprecatedMethod>
         <DeprecatedProperty>

src/Platforms/Keywords/DB2Keywords.php

@@ -2,16 +2,26 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * DB2 Keywords.
  */
 class DB2Keywords extends KeywordList
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'DB2Keywords::getName() is deprecated.'
+        );
+
         return 'DB2';
     }
 

src/Platforms/Keywords/KeywordList.php

@@ -50,6 +50,8 @@ abstract protected function getKeywords();
     /**
      * Returns the name of this keyword list.
      *
+     * @deprecated
+     *
      * @return string
      */
     abstract public function getName();

src/Platforms/Keywords/MariaDBKeywords.php

@@ -2,10 +2,21 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 class MariaDBKeywords extends MySQLKeywords
 {
+    /**
+     * @deprecated
+     */
     public function getName(): string
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'MariaDBKeywords::getName() is deprecated.'
+        );
+
         return 'MariaDB';
     }
 

src/Platforms/Keywords/MariaDb102Keywords.php

@@ -2,6 +2,8 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * MariaDb reserved keywords list.
  *
@@ -11,8 +13,17 @@
  */
 final class MariaDb102Keywords extends MariaDBKeywords
 {
+    /**
+     * @deprecated
+     */
     public function getName(): string
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'MariaDb102Keywords::getName() is deprecated.'
+        );
+
         return 'MariaDb102';
     }
 }

src/Platforms/Keywords/MySQL57Keywords.php

@@ -2,6 +2,8 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * MySQL 5.7 reserved keywords list.
  *
@@ -11,9 +13,17 @@ class MySQL57Keywords extends MySQLKeywords
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'MySQL57Keywords::getName() is deprecated.'
+        );
+
         return 'MySQL57';
     }
 

src/Platforms/Keywords/MySQL80Keywords.php

@@ -2,6 +2,8 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 use function array_merge;
 
 /**
@@ -11,9 +13,17 @@ class MySQL80Keywords extends MySQL57Keywords
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'MySQL80Keywords::getName() is deprecated.'
+        );
+
         return 'MySQL80';
     }
 

src/Platforms/Keywords/MySQLKeywords.php

@@ -2,16 +2,26 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * MySQL Keywordlist.
  */
 class MySQLKeywords extends KeywordList
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'MySQLKeywords::getName() is deprecated.'
+        );
+
         return 'MySQL';
     }
 

src/Platforms/Keywords/OracleKeywords.php

@@ -2,16 +2,26 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * Oracle Keywordlist.
  */
 class OracleKeywords extends KeywordList
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'OracleKeywords::getName() is deprecated.'
+        );
+
         return 'Oracle';
     }
 

src/Platforms/Keywords/PostgreSQL100Keywords.php

@@ -4,15 +4,26 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * PostgreSQL 10.0 reserved keywords list.
  *
  * @deprecated Use {@link PostgreSQLKeywords} instead.
  */
 class PostgreSQL100Keywords extends PostgreSQL94Keywords
 {
+    /**
+     * @deprecated
+     */
     public function getName(): string
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'PostgreSQL100Keywords::getName() is deprecated.'
+        );
+
         return 'PostgreSQL100';
     }
 }

src/Platforms/Keywords/PostgreSQLKeywords.php

@@ -2,16 +2,26 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * Reserved keywords list corresponding to the PostgreSQL database platform of the oldest supported version.
  */
 class PostgreSQLKeywords extends KeywordList
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'PostgreSQLKeywords::getName() is deprecated.'
+        );
+
         return 'PostgreSQL';
     }
 

src/Platforms/Keywords/SQLServerKeywords.php

@@ -2,6 +2,8 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * Microsoft SQL Server 2012 reserved keyword dictionary.
  * Reserved keywords list corresponding to the Microsoft SQL Server database platform of the oldest supported version.
@@ -10,9 +12,17 @@ class SQLServerKeywords extends KeywordList
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'SQLServerKeywords::getName() is deprecated.'
+        );
+
         return 'SQLServer';
     }
 

src/Platforms/Keywords/SQLiteKeywords.php

@@ -2,16 +2,26 @@
 
 namespace Doctrine\DBAL\Platforms\Keywords;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * SQLite Keywordlist.
  */
 class SQLiteKeywords extends KeywordList
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated
      */
     public function getName()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5433',
+            'SQLiteKeywords::getName() is deprecated.'
+        );
+
         return 'SQLite';
     }