Deprecate AbstractPlatform::getReservedKeywordsClass()

UPGRADE.md

@@ -1,5 +1,10 @@
 # Upgrade to 3.1
 
+## Deprecated `AbstractPlatform::getReservedKeywordsClass()`
+
+Instead of implementing `getReservedKeywordsClass()`, `AbstractPlatform` subclasses should implement
+`createReservedKeywordsList()`.
+
 ## Deprecated `$driverOptions` argument of `PDO\Statement::bindParam()` and `PDO\SQLSrv\Statement::bindParam()`
 
 The usage of the `$driverOptions` argument of `PDO\Statement::bindParam()` and `PDO\SQLSrv\Statement::bindParam()` is deprecated.

psalm.xml.dist

@@ -54,6 +54,10 @@
                     See https://github.com/doctrine/dbal/pull/4317
                 -->
                 <file name="tests/Functional/LegacyAPITest.php"/>
+                <!--
+                    This suppression should be removed in 4.0.0.
+                -->
+                <file name="src/Platforms/AbstractPlatform.php"/>
                 <!--
                     This suppression should be removed in 4.0.x
                     See https://github.com/doctrine/dbal/pull/3865

src/Platforms/AbstractPlatform.php

@@ -3480,25 +3480,37 @@ public function rollbackSavePoint($savepoint)
     final public function getReservedKeywordsList()
     {
         // Check for an existing instantiation of the keywords class.
-        if ($this->_keywords !== null) {
-            return $this->_keywords;
+        if ($this->_keywords === null) {
+            // Store the instance so it doesn't need to be generated on every request.
+            $this->_keywords = $this->createReservedKeywordsList();
         }
 
+        return $this->_keywords;
+    }
+
+    /**
+     * Creates an instance of the reserved keyword list of this platform.
+     *
+     * This method will become @abstract in DBAL 4.0.0.
+     *
+     * @throws Exception
+     */
+    protected function createReservedKeywordsList(): KeywordList
+    {
         $class    = $this->getReservedKeywordsClass();
         $keywords = new $class();
         if (! $keywords instanceof KeywordList) {
             throw Exception::notSupported(__METHOD__);
         }
 
-        // Store the instance so it doesn't need to be generated on every request.
-        $this->_keywords = $keywords;
-
         return $keywords;
     }
 
     /**
      * Returns the class name of the reserved keywords list.
      *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
+     *
      * @return string
      *
      * @throws Exception If not supported on this platform.

src/Platforms/DB2Platform.php

@@ -896,6 +896,8 @@ public function supportsSavepoints()
 
     /**
      * {@inheritDoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/MariaDb1027Platform.php

@@ -21,6 +21,9 @@ public function getJsonTypeDeclarationSQL(array $column): string
         return 'LONGTEXT';
     }
 
+    /**
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
+     */
     protected function getReservedKeywordsClass(): string
     {
         return Keywords\MariaDb102Keywords::class;

src/Platforms/MySQL57Platform.php

@@ -59,6 +59,8 @@ protected function getRenameIndexSQL($oldIndexName, Index $index, $tableName)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/MySQL80Platform.php

@@ -9,6 +9,8 @@ class MySQL80Platform extends MySQL57Platform
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/MySQLPlatform.php

@@ -1105,6 +1105,8 @@ public function getBinaryMaxLength()
 
     /**
      * {@inheritDoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/OraclePlatform.php

@@ -1160,6 +1160,8 @@ public function releaseSavePoint($savepoint)
 
     /**
      * {@inheritDoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/PostgreSQL100Platform.php

@@ -11,6 +11,9 @@
  */
 class PostgreSQL100Platform extends PostgreSQL94Platform
 {
+    /**
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
+     */
     protected function getReservedKeywordsClass(): string
     {
         return PostgreSQL100Keywords::class;

src/Platforms/PostgreSQL94Platform.php

@@ -1174,6 +1174,8 @@ public function hasNativeJsonType()
 
     /**
      * {@inheritDoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/SQLServer2012Platform.php

@@ -1554,6 +1554,8 @@ public function getForUpdateSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {

src/Platforms/SqlitePlatform.php

@@ -684,6 +684,8 @@ protected function initializeDoctrineTypeMappings()
 
     /**
      * {@inheritDoc}
+     *
+     * @deprecated Implement {@link createReservedKeywordsList()} instead.
      */
     protected function getReservedKeywordsClass()
     {