Provide generic implementation for getName()

The consequence of this is that it no longer need to be implemented in child classes. This means users no longer need to make sure the name they use in getName() is the same they use when registering the type. Type already has a dependency on TypeRegistry, which should make this change OK and should not make it harder to get rid of getName() entirely in the future. Apart from rare scenarios where one would use a type without registering it, that implementation should work reliably. That scenario happens quite frequently in tests, which is why there were some changes in the test suite.
doctrine · Nov 28, 2021 · 114311a · 114311a
1 parent 59f914f
commit 114311a
Show file tree

Hide file tree

Showing 47 changed files with 121 additions and 279 deletions.
diff --git a/docs/en/reference/types.rst b/docs/en/reference/types.rst
@@ -845,8 +845,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';
@@ -861,11 +859,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/Types/ArrayType.php b/src/Types/ArrayType.php
@@ -55,14 +55,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::ARRAY;
-    }
-
     /**
      * {@inheritdoc}
      */

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
@@ -10,14 +10,6 @@
  */
 class BigIntType extends Type implements PhpIntegerMappingType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::BIGINT;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/BinaryType.php b/src/Types/BinaryType.php
@@ -49,14 +49,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return $value;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::BINARY;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/BlobType.php b/src/Types/BlobType.php
@@ -49,14 +49,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return $value;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::BLOB;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/BooleanType.php b/src/Types/BooleanType.php
@@ -34,14 +34,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return $platform->convertFromBoolean($value);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::BOOLEAN;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/DateImmutableType.php b/src/Types/DateImmutableType.php
@@ -10,14 +10,6 @@
  */
 class DateImmutableType extends DateType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::DATE_IMMUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/DateIntervalType.php b/src/Types/DateIntervalType.php
@@ -15,14 +15,6 @@ class DateIntervalType extends Type
 {
     public const FORMAT = '%RP%YY%MM%DDT%HH%IM%SS';
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::DATEINTERVAL;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/DateTimeImmutableType.php b/src/Types/DateTimeImmutableType.php
@@ -12,14 +12,6 @@
  */
 class DateTimeImmutableType extends DateTimeType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::DATETIME_IMMUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/DateTimeType.php b/src/Types/DateTimeType.php
@@ -13,14 +13,6 @@
  */
 class DateTimeType extends Type implements PhpDateTimeMappingType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::DATETIME_MUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/DateTimeTzImmutableType.php b/src/Types/DateTimeTzImmutableType.php
@@ -10,14 +10,6 @@
  */
 class DateTimeTzImmutableType extends DateTimeTzType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::DATETIMETZ_IMMUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/DateTimeTzType.php b/src/Types/DateTimeTzType.php
@@ -24,14 +24,6 @@
  */
 class DateTimeTzType extends Type implements PhpDateTimeMappingType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::DATETIMETZ_MUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */

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

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

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

diff --git a/src/Types/GuidType.php b/src/Types/GuidType.php
@@ -17,14 +17,6 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform)
         return $platform->getGuidTypeDeclarationSQL($column);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::GUID;
-    }
-
     /**
      * {@inheritdoc}
      */

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

diff --git a/src/Types/JsonType.php b/src/Types/JsonType.php
@@ -61,14 +61,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::JSON;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/ObjectType.php b/src/Types/ObjectType.php
@@ -54,14 +54,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::OBJECT;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/SimpleArrayType.php b/src/Types/SimpleArrayType.php
@@ -52,14 +52,6 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         return explode(',', $value);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::SIMPLE_ARRAY;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/SmallIntType.php b/src/Types/SmallIntType.php
@@ -10,14 +10,6 @@
  */
 class SmallIntType extends Type implements PhpIntegerMappingType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::SMALLINT;
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Types/StringType.php b/src/Types/StringType.php
@@ -16,12 +16,4 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform)
     {
         return $platform->getVarcharTypeDeclarationSQL($column);
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::STRING;
-    }
 }
diff --git a/src/Types/TextType.php b/src/Types/TextType.php
@@ -27,12 +27,4 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
     {
         return is_resource($value) ? stream_get_contents($value) : $value;
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::TEXT;
-    }
 }
diff --git a/src/Types/TimeImmutableType.php b/src/Types/TimeImmutableType.php
@@ -10,14 +10,6 @@
  */
 class TimeImmutableType extends TimeType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getName()
-    {
-        return Types::TIME_IMMUTABLE;
-    }
-
     /**
      * {@inheritdoc}
      */

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