Extract constants for built-in types from Type to DefaultTypes

doctrine · Nov 25, 2018 · dc28b62 · dc28b62
1 parent 296b0e5
commit dc28b62
Show file tree

Hide file tree

Showing 52 changed files with 260 additions and 126 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,3 +1,16 @@
+# Upgrade to 2.10
+
+## Deprecated `Type::*` constants
+
+The constants for built-in types have been moved from `Doctrine\DBAL\Types\Type` to a separate class `Doctrine\DBAL\Types\DefaultTypes`.
+
+Some of the constants were renamed:
+* `TARRAY`-> `ARRAY`
+* `DATE` -> `DATE_MUTABLE`
+* `DATETIME` -> `DATETIME_MUTABLE`
+* `DATETIMETZ` -> `DATETIMETZ_MUTABLE`
+* `TIME` -> `TIME_MUTABLE`
+
 # Upgrade to 2.9
 
 ## Deprecated `Configuration::getFilterSchemaAssetsExpression()`, `::setFilterSchemaAssetsExpression()` and `AbstractSchemaManager::getFilterSchemaAssetsExpression()`.

diff --git a/lib/Doctrine/DBAL/Platforms/DB2Platform.php b/lib/Doctrine/DBAL/Platforms/DB2Platform.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
+use Doctrine\DBAL\Types\DefaultTypes;
 use Doctrine\DBAL\Types\Type;
 use function array_merge;
 use function count;
@@ -97,7 +98,7 @@ public function initializeDoctrineTypeMappings()
      */
     public function isCommentedDoctrineType(Type $doctrineType)
     {
-        if ($doctrineType->getName() === Type::BOOLEAN) {
+        if ($doctrineType->getName() === DefaultTypes::BOOLEAN) {
             // 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 true;

diff --git a/lib/Doctrine/DBAL/Platforms/MariaDb1027Platform.php b/lib/Doctrine/DBAL/Platforms/MariaDb1027Platform.php
@@ -2,7 +2,7 @@
 
 namespace Doctrine\DBAL\Platforms;
 
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\DefaultTypes;
 
 /**
  * Provides the behavior, features and SQL dialect of the MariaDB 10.2 (10.2.7 GA) database platform.
@@ -36,6 +36,6 @@ protected function initializeDoctrineTypeMappings() : void
     {
         parent::initializeDoctrineTypeMappings();
 
-        $this->doctrineTypeMapping['json'] = Type::JSON;
+        $this->doctrineTypeMapping['json'] = DefaultTypes::JSON;
     }
 }
diff --git a/lib/Doctrine/DBAL/Platforms/MySQL57Platform.php b/lib/Doctrine/DBAL/Platforms/MySQL57Platform.php
@@ -4,7 +4,7 @@
 
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\TableDiff;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\DefaultTypes;
 
 /**
  * Provides the behavior, features and SQL dialect of the MySQL 5.7 (5.7.9 GA) database platform.
@@ -66,6 +66,6 @@ protected function initializeDoctrineTypeMappings()
     {
         parent::initializeDoctrineTypeMappings();
 
-        $this->doctrineTypeMapping['json'] = Type::JSON;
+        $this->doctrineTypeMapping['json'] = DefaultTypes::JSON;
     }
 }
diff --git a/lib/Doctrine/DBAL/Platforms/PostgreSQL92Platform.php b/lib/Doctrine/DBAL/Platforms/PostgreSQL92Platform.php
@@ -2,7 +2,7 @@
 
 namespace Doctrine\DBAL\Platforms;
 
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\DefaultTypes;
 use function sprintf;
 
 /**
@@ -53,7 +53,7 @@ protected function initializeDoctrineTypeMappings()
     {
         parent::initializeDoctrineTypeMappings();
 
-        $this->doctrineTypeMapping['json'] = Type::JSON;
+        $this->doctrineTypeMapping['json'] = DefaultTypes::JSON;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Platforms/PostgreSQL94Platform.php b/lib/Doctrine/DBAL/Platforms/PostgreSQL94Platform.php
@@ -2,7 +2,7 @@
 
 namespace Doctrine\DBAL\Platforms;
 
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\DefaultTypes;
 
 /**
  * Provides the behavior, features and SQL dialect of the PostgreSQL 9.4 database platform.
@@ -36,6 +36,6 @@ protected function initializeDoctrineTypeMappings()
     {
         parent::initializeDoctrineTypeMappings();
 
-        $this->doctrineTypeMapping['jsonb'] = Type::JSON;
+        $this->doctrineTypeMapping['jsonb'] = DefaultTypes::JSON;
     }
 }
diff --git a/lib/Doctrine/DBAL/Schema/PostgreSqlSchemaManager.php b/lib/Doctrine/DBAL/Schema/PostgreSqlSchemaManager.php
@@ -5,6 +5,7 @@
 use Doctrine\DBAL\Exception\DriverException;
 use Doctrine\DBAL\FetchMode;
 use Doctrine\DBAL\Platforms\PostgreSqlPlatform;
+use Doctrine\DBAL\Types\DefaultTypes;
 use Doctrine\DBAL\Types\Type;
 use const CASE_LOWER;
 use function array_change_key_case;
@@ -456,7 +457,7 @@ protected function _getPortableTableColumnDefinition($tableColumn)
             $column->setPlatformOption('collation', $tableColumn['collation']);
         }
 
-        if (in_array($column->getType()->getName(), [Type::JSON_ARRAY, Type::JSON], true)) {
+        if (in_array($column->getType()->getName(), [DefaultTypes::JSON_ARRAY, DefaultTypes::JSON], true)) {
             $column->setPlatformOption('jsonb', $jsonb);
         }
 

diff --git a/lib/Doctrine/DBAL/Sharding/SQLAzure/SQLAzureFederationsSynchronizer.php b/lib/Doctrine/DBAL/Sharding/SQLAzure/SQLAzureFederationsSynchronizer.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Schema\Synchronizer\AbstractSchemaSynchronizer;
 use Doctrine\DBAL\Schema\Synchronizer\SchemaSynchronizer;
 use Doctrine\DBAL\Schema\Synchronizer\SingleDatabaseSynchronizer;
+use Doctrine\DBAL\Types\DefaultTypes;
 use Doctrine\DBAL\Types\Type;
 use RuntimeException;
 use function array_merge;
@@ -240,12 +241,12 @@ private function getFederationTypeDefaultValue()
         $federationType = Type::getType($this->shardManager->getDistributionType());
 
         switch ($federationType->getName()) {
-            case Type::GUID:
+            case DefaultTypes::GUID:
                 $defaultValue = '00000000-0000-0000-0000-000000000000';
                 break;
-            case Type::INTEGER:
-            case Type::SMALLINT:
-            case Type::BIGINT:
+            case DefaultTypes::INTEGER:
+            case DefaultTypes::SMALLINT:
+            case DefaultTypes::BIGINT:
                 $defaultValue = '0';
                 break;
             default:

diff --git a/lib/Doctrine/DBAL/Types/ArrayType.php b/lib/Doctrine/DBAL/Types/ArrayType.php
@@ -59,7 +59,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::TARRAY;
+        return DefaultTypes::ARRAY;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/BigIntType.php b/lib/Doctrine/DBAL/Types/BigIntType.php
@@ -15,7 +15,7 @@ class BigIntType extends Type implements PhpIntegerMappingType
      */
     public function getName()
     {
-        return Type::BIGINT;
+        return DefaultTypes::BIGINT;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/BinaryType.php b/lib/Doctrine/DBAL/Types/BinaryType.php
@@ -40,7 +40,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         }
 
         if (! is_resource($value)) {
-            throw ConversionException::conversionFailed($value, self::BINARY);
+            throw ConversionException::conversionFailed($value, DefaultTypes::BINARY);
         }
 
         return $value;
@@ -51,7 +51,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::BINARY;
+        return DefaultTypes::BINARY;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/BlobType.php b/lib/Doctrine/DBAL/Types/BlobType.php
@@ -40,7 +40,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         }
 
         if (! is_resource($value)) {
-            throw ConversionException::conversionFailed($value, self::BLOB);
+            throw ConversionException::conversionFailed($value, DefaultTypes::BLOB);
         }
 
         return $value;
@@ -51,7 +51,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::BLOB;
+        return DefaultTypes::BLOB;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/BooleanType.php b/lib/Doctrine/DBAL/Types/BooleanType.php
@@ -39,7 +39,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::BOOLEAN;
+        return DefaultTypes::BOOLEAN;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateImmutableType.php b/lib/Doctrine/DBAL/Types/DateImmutableType.php
@@ -15,7 +15,7 @@ class DateImmutableType extends DateType
      */
     public function getName()
     {
-        return Type::DATE_IMMUTABLE;
+        return DefaultTypes::DATE_IMMUTABLE;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateIntervalType.php b/lib/Doctrine/DBAL/Types/DateIntervalType.php
@@ -19,7 +19,7 @@ class DateIntervalType extends Type
      */
     public function getName()
     {
-        return Type::DATEINTERVAL;
+        return DefaultTypes::DATEINTERVAL;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateTimeImmutableType.php b/lib/Doctrine/DBAL/Types/DateTimeImmutableType.php
@@ -16,7 +16,7 @@ class DateTimeImmutableType extends DateTimeType
      */
     public function getName()
     {
-        return Type::DATETIME_IMMUTABLE;
+        return DefaultTypes::DATETIME_IMMUTABLE;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateTimeType.php b/lib/Doctrine/DBAL/Types/DateTimeType.php
@@ -17,7 +17,7 @@ class DateTimeType extends Type implements PhpDateTimeMappingType
      */
     public function getName()
     {
-        return Type::DATETIME;
+        return DefaultTypes::DATETIME_MUTABLE;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateTimeTzImmutableType.php b/lib/Doctrine/DBAL/Types/DateTimeTzImmutableType.php
@@ -15,7 +15,7 @@ class DateTimeTzImmutableType extends DateTimeTzType
      */
     public function getName()
     {
-        return Type::DATETIMETZ_IMMUTABLE;
+        return DefaultTypes::DATETIMETZ_IMMUTABLE;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateTimeTzType.php b/lib/Doctrine/DBAL/Types/DateTimeTzType.php
@@ -29,7 +29,7 @@ class DateTimeTzType extends Type implements PhpDateTimeMappingType
      */
     public function getName()
     {
-        return Type::DATETIMETZ;
+        return DefaultTypes::DATETIMETZ_MUTABLE;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DateType.php b/lib/Doctrine/DBAL/Types/DateType.php
@@ -16,7 +16,7 @@ class DateType extends Type
      */
     public function getName()
     {
-        return Type::DATE;
+        return DefaultTypes::DATE_MUTABLE;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DecimalType.php b/lib/Doctrine/DBAL/Types/DecimalType.php
@@ -14,7 +14,7 @@ class DecimalType extends Type
      */
     public function getName()
     {
-        return Type::DECIMAL;
+        return DefaultTypes::DECIMAL;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/DefaultTypes.php b/lib/Doctrine/DBAL/Types/DefaultTypes.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Types;
+
+/**
+ * Default built-in types provided by Doctrine.
+ */
+final class DefaultTypes
+{
+    public const ARRAY                = 'array';
+    public const BIGINT               = 'bigint';
+    public const BINARY               = 'binary';
+    public const BLOB                 = 'blob';
+    public const BOOLEAN              = 'boolean';
+    public const DATE_MUTABLE         = 'date';
+    public const DATE_IMMUTABLE       = 'date_immutable';
+    public const DATEINTERVAL         = 'dateinterval';
+    public const DATETIME_MUTABLE     = 'datetime';
+    public const DATETIME_IMMUTABLE   = 'datetime_immutable';
+    public const DATETIMETZ_MUTABLE   = 'datetimetz';
+    public const DATETIMETZ_IMMUTABLE = 'datetimetz_immutable';
+    public const DECIMAL              = 'decimal';
+    public const FLOAT                = 'float';
+    public const GUID                 = 'guid';
+    public const INTEGER              = 'integer';
+    public const JSON                 = 'json';
+    public const OBJECT               = 'object';
+    public const SIMPLE_ARRAY         = 'simple_array';
+    public const SMALLINT             = 'smallint';
+    public const STRING               = 'string';
+    public const TEXT                 = 'text';
+    public const TIME_MUTABLE         = 'time';
+    public const TIME_IMMUTABLE       = 'time_immutable';
+
+    /** @deprecated json_array type is deprecated, use {@see DefaultTypes::JSON} instead. */
+    public const JSON_ARRAY = 'json_array';
+
+    private function __construct()
+    {
+    }
+}
diff --git a/lib/Doctrine/DBAL/Types/FloatType.php b/lib/Doctrine/DBAL/Types/FloatType.php
@@ -11,7 +11,7 @@ class FloatType extends Type
      */
     public function getName()
     {
-        return Type::FLOAT;
+        return DefaultTypes::FLOAT;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/GuidType.php b/lib/Doctrine/DBAL/Types/GuidType.php
@@ -22,7 +22,7 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
      */
     public function getName()
     {
-        return Type::GUID;
+        return DefaultTypes::GUID;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/IntegerType.php b/lib/Doctrine/DBAL/Types/IntegerType.php
@@ -15,7 +15,7 @@ class IntegerType extends Type implements PhpIntegerMappingType
      */
     public function getName()
     {
-        return Type::INTEGER;
+        return DefaultTypes::INTEGER;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/JsonArrayType.php b/lib/Doctrine/DBAL/Types/JsonArrayType.php
@@ -33,7 +33,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::JSON_ARRAY;
+        return DefaultTypes::JSON_ARRAY;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/JsonType.php b/lib/Doctrine/DBAL/Types/JsonType.php
@@ -69,7 +69,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::JSON;
+        return DefaultTypes::JSON;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/ObjectType.php b/lib/Doctrine/DBAL/Types/ObjectType.php
@@ -58,7 +58,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::OBJECT;
+        return DefaultTypes::OBJECT;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/SimpleArrayType.php b/lib/Doctrine/DBAL/Types/SimpleArrayType.php
@@ -54,7 +54,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
      */
     public function getName()
     {
-        return Type::SIMPLE_ARRAY;
+        return DefaultTypes::SIMPLE_ARRAY;
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Types/SmallIntType.php b/lib/Doctrine/DBAL/Types/SmallIntType.php
@@ -15,7 +15,7 @@ class SmallIntType extends Type implements PhpIntegerMappingType
      */
     public function getName()
     {
-        return Type::SMALLINT;
+        return DefaultTypes::SMALLINT;
     }
 
     /**