Deprecate AbstractMySQLPlatform::getColumnTypeSQLSnippet

doctrine · Nov 5, 2023 · 0376c0f · 0376c0f
1 parent 630da85
commit 0376c0f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -506,6 +506,11 @@
                 <referencedMethod name="Doctrine\DBAL\Query\QueryBuilder::getQueryParts"/>
                 <referencedMethod name="Doctrine\DBAL\Query\QueryBuilder::resetQueryPart"/>
                 <referencedMethod name="Doctrine\DBAL\Query\QueryBuilder::resetQueryParts"/>
+                <!--
+                    See https://github.com/doctrine/dbal/pull/6202
+                    TODO: remove in 4.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Platforms\AbstractMySQLPlatform::getColumnTypeSQLSnippets" />
 
                 <!-- TODO for PHPUnit 10 -->
                 <referencedMethod name="PHPUnit\Framework\MockObject\Builder\InvocationMocker::withConsecutive"/>

diff --git a/src/Platforms/AbstractMySQLPlatform.php b/src/Platforms/AbstractMySQLPlatform.php
@@ -398,6 +398,8 @@ public function getListTableColumnsSQL($table, $database = null)
     }
 
     /**
+     * @deprecated Use {@see getColumnTypeSQLSnippet()} instead.
+     *
      * The SQL snippets required to elucidate a column type
      *
      * Returns an array of the form [column type SELECT snippet, additional JOIN statement snippet]
@@ -406,6 +408,13 @@ public function getListTableColumnsSQL($table, $database = null)
      */
     public function getColumnTypeSQLSnippets(string $tableAlias = 'c'): array
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/6202',
+            'AbstractMySQLPlatform::getColumnTypeSQLSnippets() is deprecated. '
+            . 'Use AbstractMySQLPlatform::getColumnTypeSQLSnippet() instead.',
+        );
+
         return [$this->getColumnTypeSQLSnippet(...func_get_args()), ''];
     }