Merge pull request #5512 from morozov/remove-requires-sql-comment-hint

Remove AbstractPlatform::hasNative*Type() methods and Type::requiresSQLCommentHint()
doctrine · Jul 16, 2022 · f436c34 · f436c34
2 parents 25c588a + 1e49835
commit f436c34
Show file tree

Hide file tree

Showing 30 changed files with 4 additions and 378 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -209,13 +209,14 @@ Postgres 9 is not actively supported anymore. The following classes have been me
 
 ## BC BREAK: Removed Platform "commented type" API
 
-Since `Type::requiresSQLCommentTypeHint()` already allows determining whether a
-type should result in SQL columns with a type hint in their comments, the
-following methods are removed:
+The following methods are removed:
 
+- `AbstractPlatform::hasNativeJsonType()`
+- `AbstractPlatform::hasNativeGuidType()`
 - `AbstractPlatform::isCommentedDoctrineType()`
 - `AbstractPlatform::initializeCommentedDoctrineTypes()`
 - `AbstractPlatform::markDoctrineTypeCommented()`
+- `Type::requiresSQLCommentHint()`
 
 The protected property `AbstractPlatform::$doctrineTypeComments` is removed as
 well.

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -39,24 +39,6 @@
                     See https://github.com/doctrine/dbal/pull/4317
                 -->
                 <file name="tests/Functional/LegacyAPITest.php"/>
-                <!--
-                    TODO: remove in 4.0.0
-                -->
-                <referencedMethod name="Doctrine\DBAL\Types\Type::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\DateImmutableType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\DateIntervalType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\DateTimeTzImmutableType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\DateTimeImmutableType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\GuidType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\JsonType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\TimeImmutableType::requiresSQLCommentHint"/>
-                <referencedMethod name="Doctrine\DBAL\Types\VarDateTimeImmutableType::requiresSQLCommentHint"/>
-                <!--
-                    TODO: remove in 4.0.0
-                -->
-                <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::hasNativeGuidType"/>
-                <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::hasNativeJsonType"/>
-                <referencedMethod name="Doctrine\DBAL\Platforms\PostgreSQLPlatform::hasNativeJsonType"/>
             </errorLevel>
         </DeprecatedMethod>
         <DocblockTypeContradiction>

diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -37,7 +37,6 @@
 use Doctrine\DBAL\Types;
 use Doctrine\DBAL\Types\Exception\TypeNotFound;
 use Doctrine\DBAL\Types\Type;
-use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 use UnexpectedValueException;
 
@@ -2286,40 +2285,6 @@ public function supportsCommentOnStatement(): bool
         return false;
     }
 
-    /**
-     * Does this platform have native guid type.
-     *
-     * @deprecated
-     */
-    public function hasNativeGuidType(): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return false;
-    }
-
-    /**
-     * Does this platform have native JSON type.
-     *
-     * @deprecated
-     */
-    public function hasNativeJsonType(): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return false;
-    }
-
     /**
      * Does this platform support column collation?
      */

diff --git a/src/Platforms/MySQLPlatform.php b/src/Platforms/MySQLPlatform.php
@@ -32,11 +32,6 @@ public function getDefaultValueDeclarationSQL(array $column): string
         return parent::getDefaultValueDeclarationSQL($column);
     }
 
-    public function hasNativeJsonType(): bool
-    {
-        return true;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Platforms/PostgreSQLPlatform.php b/src/Platforms/PostgreSQLPlatform.php
@@ -16,7 +16,6 @@
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\Types\BinaryType;
 use Doctrine\DBAL\Types\BlobType;
-use Doctrine\Deprecations\Deprecation;
 use UnexpectedValueException;
 
 use function array_diff;
@@ -155,21 +154,6 @@ public function supportsCommentOnStatement(): bool
         return true;
     }
 
-    /**
-     * @deprecated
-     */
-    public function hasNativeGuidType(): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
-
     public function getListDatabasesSQL(): string
     {
         return 'SELECT datname FROM pg_database';
@@ -823,21 +807,6 @@ protected function initializeDoctrineTypeMappings(): void
         ];
     }
 
-    /**
-     * @deprecated
-     */
-    public function hasNativeJsonType(): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
-
     protected function createReservedKeywordsList(): KeywordList
     {
         return new PostgreSQLKeywords();

diff --git a/src/Platforms/SQLServerPlatform.php b/src/Platforms/SQLServerPlatform.php
@@ -17,7 +17,6 @@
 use Doctrine\DBAL\Schema\Sequence;
 use Doctrine\DBAL\Schema\SQLServerSchemaManager;
 use Doctrine\DBAL\Schema\TableDiff;
-use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 
 use function array_merge;
@@ -155,21 +154,6 @@ public function getSequenceNextValSQL(string $sequence): string
         return 'SELECT NEXT VALUE FOR ' . $sequence;
     }
 
-    /**
-     * @deprecated
-     */
-    public function hasNativeGuidType(): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
-
     public function getDropForeignKeySQL(string $foreignKey, string $table): string
     {
         return $this->getDropConstraintSQL($foreignKey, $table);

diff --git a/src/Types/BooleanType.php b/src/Types/BooleanType.php
@@ -6,8 +6,6 @@
 
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
-use Doctrine\DBAL\Platforms\DB2Platform;
-use Doctrine\Deprecations\Deprecation;
 
 /**
  * Type that maps an SQL boolean to a PHP boolean.
@@ -36,21 +34,4 @@ public function getBindingType(): int
     {
         return ParameterType::BOOLEAN;
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        // We require a commented boolean type in order to distinguish between
-        // boolean and smallint as both (have to) map to the same native type.
-        return $platform instanceof DB2Platform;
-    }
 }
diff --git a/src/Types/DateImmutableType.php b/src/Types/DateImmutableType.php
@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Exception\InvalidFormat;
 use Doctrine\DBAL\Types\Exception\InvalidType;
-use Doctrine\Deprecations\Deprecation;
 
 /**
  * Immutable type of {@see DateType}.
@@ -50,19 +49,4 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
 
         return $dateTime;
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
 }
diff --git a/src/Types/DateIntervalType.php b/src/Types/DateIntervalType.php
@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Exception\InvalidFormat;
 use Doctrine\DBAL\Types\Exception\InvalidType;
-use Doctrine\Deprecations\Deprecation;
 use Throwable;
 
 use function substr;
@@ -68,19 +67,4 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
             throw InvalidFormat::new($value, static::class, self::FORMAT, $exception);
         }
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
 }
diff --git a/src/Types/DateTimeImmutableType.php b/src/Types/DateTimeImmutableType.php
@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Exception\InvalidFormat;
 use Doctrine\DBAL\Types\Exception\InvalidType;
-use Doctrine\Deprecations\Deprecation;
 
 use function date_create_immutable;
 
@@ -56,19 +55,4 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
 
         return $dateTime;
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
 }
diff --git a/src/Types/DateTimeTzImmutableType.php b/src/Types/DateTimeTzImmutableType.php
@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Exception\InvalidFormat;
 use Doctrine\DBAL\Types\Exception\InvalidType;
-use Doctrine\Deprecations\Deprecation;
 
 /**
  * Immutable type of {@see DateTimeTzType}.
@@ -50,19 +49,4 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
 
         return $dateTime;
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return true;
-    }
 }
diff --git a/src/Types/GuidType.php b/src/Types/GuidType.php
@@ -5,7 +5,6 @@
 namespace Doctrine\DBAL\Types;
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
-use Doctrine\Deprecations\Deprecation;
 
 /**
  * Represents a GUID/UUID datatype (both are actually synonyms) in the database.
@@ -19,19 +18,4 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
     {
         return $platform->getGuidTypeDeclarationSQL($column);
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return ! $platform->hasNativeGuidType();
-    }
 }
diff --git a/src/Types/JsonType.php b/src/Types/JsonType.php
@@ -7,7 +7,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Exception\SerializationFailed;
 use Doctrine\DBAL\Types\Exception\ValueNotConvertible;
-use Doctrine\Deprecations\Deprecation;
 use JsonException;
 
 use function is_resource;
@@ -60,19 +59,4 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): mix
             throw ValueNotConvertible::new($value, 'json', $e->getMessage(), $e);
         }
     }
-
-    /**
-     * @deprecated
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/5509',
-            '%s is deprecated.',
-            __METHOD__
-        );
-
-        return ! $platform->hasNativeJsonType();
-    }
 }