Drop Type::getName()

doctrine · Jan 25, 2022 · 20615e3 · 20615e3
1 parent 35a569f
commit 20615e3
Show file tree

Hide file tree

Showing 43 changed files with 67 additions and 239 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 4.0
 
+## BC BREAK: Removed `Type::getName()`
+
+As a consequence, only types extending `JsonType` or that type itself can have
+the `jsonb` platform option set.
+
 ## BC BREAK: Deployed database schema no longer contains the information about abstract data types
 
 Database column comments no longer contain type comments added by DBAL.

diff --git a/docs/en/reference/types.rst b/docs/en/reference/types.rst
@@ -848,8 +848,6 @@ Now we implement our ``Doctrine\DBAL\Types\Type`` instance:
      */
     class MoneyType extends Type
     {
-        const MONEY = 'money'; // modify to match your type name
-
         public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
         {
             return 'MyMoney';
@@ -864,11 +862,6 @@ Now we implement our ``Doctrine\DBAL\Types\Type`` instance:
         {
             return $value->toDecimal();
         }
-
-        public function getName()
-        {
-            return self::MONEY;
-        }
     }
 
 The job of Doctrine-DBAL is to transform your type into an SQL

diff --git a/src/Schema/PostgreSQLSchemaManager.php b/src/Schema/PostgreSQLSchemaManager.php
@@ -6,8 +6,8 @@
 
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
+use Doctrine\DBAL\Types\JsonType;
 use Doctrine\DBAL\Types\Type;
-use Doctrine\DBAL\Types\Types;
 
 use function array_change_key_case;
 use function array_keys;
@@ -422,7 +422,7 @@ protected function _getPortableTableColumnDefinition(array $tableColumn): Column
             $column->setPlatformOption('collation', $tableColumn['collation']);
         }
 
-        if ($column->getType()->getName() === Types::JSON) {
+        if ($column->getType() instanceof JsonType) {
             $column->setPlatformOption('jsonb', $jsonb);
         }
 

diff --git a/src/Types/ArrayType.php b/src/Types/ArrayType.php
@@ -41,8 +41,8 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): mix
 
         $value = is_resource($value) ? stream_get_contents($value) : $value;
 
-        set_error_handler(function (int $code, string $message) use ($value): bool {
-            throw ValueNotConvertible::new($value, $this->getName(), $message);
+        set_error_handler(static function (int $code, string $message) use ($value): bool {
+            throw ValueNotConvertible::new($value, 'array', $message);
         });
 
         try {
@@ -52,11 +52,6 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): mix
         }
     }
 
-    public function getName(): string
-    {
-        return Types::ARRAY;
-    }
-
     public function requiresSQLCommentHint(AbstractPlatform $platform): bool
     {
         return true;

diff --git a/src/Types/AsciiStringType.php b/src/Types/AsciiStringType.php
@@ -21,9 +21,4 @@ public function getBindingType(): int
     {
         return ParameterType::ASCII;
     }
-
-    public function getName(): string
-    {
-        return Types::ASCII_STRING;
-    }
 }
diff --git a/src/Types/BigIntType.php b/src/Types/BigIntType.php
@@ -12,11 +12,6 @@
  */
 class BigIntType extends Type implements PhpIntegerMappingType
 {
-    public function getName(): string
-    {
-        return Types::BIGINT;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/BinaryType.php b/src/Types/BinaryType.php
@@ -42,11 +42,6 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?st
         return $value;
     }
 
-    public function getName(): string
-    {
-        return Types::BINARY;
-    }
-
     public function getBindingType(): int
     {
         return ParameterType::BINARY;

diff --git a/src/Types/BlobType.php b/src/Types/BlobType.php
@@ -49,11 +49,6 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): mix
         return $value;
     }
 
-    public function getName(): string
-    {
-        return Types::BLOB;
-    }
-
     public function getBindingType(): int
     {
         return ParameterType::LARGE_OBJECT;

diff --git a/src/Types/BooleanType.php b/src/Types/BooleanType.php
@@ -31,11 +31,6 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?bo
         return $platform->convertFromBoolean($value);
     }
 
-    public function getName(): string
-    {
-        return Types::BOOLEAN;
-    }
-
     public function getBindingType(): int
     {
         return ParameterType::BOOLEAN;

diff --git a/src/Types/DateImmutableType.php b/src/Types/DateImmutableType.php
@@ -14,11 +14,6 @@
  */
 class DateImmutableType extends DateType
 {
-    public function getName(): string
-    {
-        return Types::DATE_IMMUTABLE;
-    }
-
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -31,7 +26,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
 
         throw InvalidType::new(
             $value,
-            $this->getName(),
+            $this::class,
             ['null', DateTimeImmutable::class]
         );
     }
@@ -47,7 +42,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
         if ($dateTime === false) {
             throw InvalidFormat::new(
                 $value,
-                $this->getName(),
+                $this::class,
                 $platform->getDateFormatString()
             );
         }

diff --git a/src/Types/DateIntervalType.php b/src/Types/DateIntervalType.php
@@ -19,13 +19,8 @@ class DateIntervalType extends Type
 {
     public const FORMAT = '%RP%YY%MM%DDT%HH%IM%SS';
 
-    public function getName(): string
-    {
-        return Types::DATEINTERVAL;
-    }
-
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
@@ -44,7 +39,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
             return $value->format(self::FORMAT);
         }
 
-        throw InvalidType::new($value, $this->getName(), ['null', 'DateInterval']);
+        throw InvalidType::new($value, $this::class, ['null', 'DateInterval']);
     }
 
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateInterval
@@ -69,7 +64,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
 
             return $interval;
         } catch (Throwable $exception) {
-            throw InvalidFormat::new($value, $this->getName(), self::FORMAT, $exception);
+            throw InvalidFormat::new($value, $this::class, self::FORMAT, $exception);
         }
     }
 

diff --git a/src/Types/DateTimeImmutableType.php b/src/Types/DateTimeImmutableType.php
@@ -16,11 +16,6 @@
  */
 class DateTimeImmutableType extends DateTimeType
 {
-    public function getName(): string
-    {
-        return Types::DATETIME_IMMUTABLE;
-    }
-
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -33,7 +28,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
 
         throw InvalidType::new(
             $value,
-            $this->getName(),
+            $this::class,
             ['null', DateTimeImmutable::class]
         );
     }
@@ -53,7 +48,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
         if ($dateTime === false) {
             throw InvalidFormat::new(
                 $value,
-                $this->getName(),
+                $this::class,
                 $platform->getDateTimeFormatString()
             );
         }

diff --git a/src/Types/DateTimeType.php b/src/Types/DateTimeType.php
@@ -17,13 +17,8 @@
  */
 class DateTimeType extends Type implements PhpDateTimeMappingType
 {
-    public function getName(): string
-    {
-        return Types::DATETIME_MUTABLE;
-    }
-
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
@@ -40,7 +35,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
             return $value->format($platform->getDateTimeFormatString());
         }
 
-        throw InvalidType::new($value, $this->getName(), ['null', 'DateTime']);
+        throw InvalidType::new($value, $this::class, ['null', 'DateTime']);
     }
 
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeInterface
@@ -58,7 +53,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
         if ($val === false) {
             throw InvalidFormat::new(
                 $value,
-                $this->getName(),
+                $this::class,
                 $platform->getDateTimeFormatString()
             );
         }

diff --git a/src/Types/DateTimeTzImmutableType.php b/src/Types/DateTimeTzImmutableType.php
@@ -14,11 +14,6 @@
  */
 class DateTimeTzImmutableType extends DateTimeTzType
 {
-    public function getName(): string
-    {
-        return Types::DATETIMETZ_IMMUTABLE;
-    }
-
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -31,7 +26,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
 
         throw InvalidType::new(
             $value,
-            $this->getName(),
+            $this::class,
             ['null', DateTimeImmutable::class]
         );
     }
@@ -47,7 +42,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
         if ($dateTime === false) {
             throw InvalidFormat::new(
                 $value,
-                $this->getName(),
+                $this::class,
                 $platform->getDateTimeTzFormatString()
             );
         }

diff --git a/src/Types/DateTimeTzType.php b/src/Types/DateTimeTzType.php
@@ -28,13 +28,8 @@
  */
 class DateTimeTzType extends Type implements PhpDateTimeMappingType
 {
-    public function getName(): string
-    {
-        return Types::DATETIMETZ_MUTABLE;
-    }
-
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
@@ -53,7 +48,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
 
         throw InvalidType::new(
             $value,
-            $this->getName(),
+            $this::class,
             ['null', 'DateTime']
         );
     }
@@ -68,7 +63,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
         if ($val === false) {
             throw InvalidFormat::new(
                 $value,
-                $this->getName(),
+                $this::class,
                 $platform->getDateTimeTzFormatString()
             );
         }

diff --git a/src/Types/DateType.php b/src/Types/DateType.php
@@ -15,11 +15,6 @@
  */
 class DateType extends Type
 {
-    public function getName(): string
-    {
-        return Types::DATE_MUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -38,7 +33,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
             return $value->format($platform->getDateFormatString());
         }
 
-        throw InvalidType::new($value, $this->getName(), ['null', 'DateTime']);
+        throw InvalidType::new($value, $this::class, ['null', 'DateTime']);
     }
 
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeInterface
@@ -51,7 +46,7 @@ public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?Da
         if ($val === false) {
             throw InvalidFormat::new(
                 $value,
-                $this->getName(),
+                $this::class,
                 $platform->getDateFormatString()
             );
         }

diff --git a/src/Types/DecimalType.php b/src/Types/DecimalType.php
@@ -16,11 +16,6 @@
  */
 class DecimalType extends Type
 {
-    public function getName(): string
-    {
-        return Types::DECIMAL;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/FloatType.php b/src/Types/FloatType.php
@@ -8,11 +8,6 @@
 
 class FloatType extends Type
 {
-    public function getName(): string
-    {
-        return Types::FLOAT;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/GuidType.php b/src/Types/GuidType.php
@@ -19,11 +19,6 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getGuidTypeDeclarationSQL($column);
     }
 
-    public function getName(): string
-    {
-        return Types::GUID;
-    }
-
     public function requiresSQLCommentHint(AbstractPlatform $platform): bool
     {
         return ! $platform->hasNativeGuidType();

diff --git a/src/Types/IntegerType.php b/src/Types/IntegerType.php
@@ -12,11 +12,6 @@
  */
 class IntegerType extends Type implements PhpIntegerMappingType
 {
-    public function getName(): string
-    {
-        return Types::INTEGER;
-    }
-
     /**
      * {@inheritdoc}
      */