Narrow responsibilities in datetime related types

doctrine · Apr 18, 2023 · 3731555 · 3731555
1 parent 1265f8c
commit 3731555
Show file tree

Hide file tree

Showing 9 changed files with 154 additions and 54 deletions.
diff --git a/docs/en/reference/types.rst b/docs/en/reference/types.rst
@@ -278,13 +278,19 @@ or ``null`` if no data is present.
     could cause quite some troubles on platforms that had various
     microtime precision formats.
     Starting with 2.5 whenever the parsing of a date fails with
-    the predefined platform format, the ``date_create()``
-    function will be used to parse the date.
+    the predefined platform format, ``DateTime::__construct()``
+    method will be used to parse the date.
 
     This could cause some troubles when your date format is weird
-    and not parsed correctly by ``date_create()``, however since
+    and not parsed correctly by ``DateTime::__construct()``, however since
     databases are rather strict on dates there should be no problem.
 
+.. warning::
+
+    Passing instances of ``DateTimeImmutable`` to this type is deprecated since 3.7. Use
+    :ref:`datetime_immutable` instead.
+
+.. _datetime_immutable:
 datetime_immutable
 ^^^^^^^^^^^^^^^^^^
 
@@ -301,6 +307,12 @@ information, you should consider using this type.
 Values retrieved from the database are always converted to PHP's ``\DateTime`` object
 or ``null`` if no data is present.
 
+.. warning::
+
+    Passing instances of ``DateTimeImmutable`` to this type is deprecated since 3.7. Use
+    :ref:`datetimetz_immutable` instead.
+
+.. _datetimetz_immutable:
 datetimetz_immutable
 ^^^^^^^^^^^^^^^^^^^^
 

diff --git a/src/Types/DateIntervalType.php b/src/Types/DateIntervalType.php
@@ -53,7 +53,7 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
             return $value->format(self::FORMAT);
         }
 
-        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateInterval']);
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', DateInterval::class]);
     }
 
     /**

diff --git a/src/Types/DateTimeImmutableType.php b/src/Types/DateTimeImmutableType.php
@@ -5,8 +5,7 @@
 use DateTimeImmutable;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\Deprecations\Deprecation;
-
-use function date_create_immutable;
+use Throwable;
 
 /**
  * Immutable type of {@see DateTimeType}.
@@ -65,15 +64,16 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         $dateTime = DateTimeImmutable::createFromFormat($platform->getDateTimeFormatString(), $value);
 
         if ($dateTime === false) {
-            $dateTime = date_create_immutable($value);
-        }
-
-        if ($dateTime === false) {
-            throw ConversionException::conversionFailedFormat(
-                $value,
-                $this->getName(),
-                $platform->getDateTimeFormatString(),
-            );
+            try {
+                $dateTime = new DateTimeImmutable($value);
+            } catch (Throwable $e) {
+                throw ConversionException::conversionFailedFormat(
+                    $value,
+                    $this->getName(),
+                    $platform->getDateTimeFormatString(),
+                    $e,
+                );
+            }
         }
 
         return $dateTime;

diff --git a/src/Types/DateTimeType.php b/src/Types/DateTimeType.php
@@ -3,10 +3,13 @@
 namespace Doctrine\DBAL\Types;
 
 use DateTime;
+use DateTimeImmutable;
 use DateTimeInterface;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\Deprecations\Deprecation;
+use Throwable;
 
-use function date_create;
+use function get_class;
 
 /**
  * Type that maps an SQL DATETIME/TIMESTAMP to a PHP DateTime object.
@@ -45,10 +48,23 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         }
 
         if ($value instanceof DateTimeInterface) {
+            if (! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value->format($platform->getDateTimeFormatString());
         }
 
-        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
+        throw ConversionException::conversionFailedInvalidType(
+            $value,
+            $this->getName(),
+            ['null', DateTime::class, DateTimeImmutable::class],
+        );
     }
 
     /**
@@ -63,23 +79,33 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
         if ($value === null || $value instanceof DateTimeInterface) {
+            if ($value !== null && ! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value;
         }
 
-        $val = DateTime::createFromFormat($platform->getDateTimeFormatString(), $value);
-
-        if ($val === false) {
-            $val = date_create($value);
-        }
+        $dateTime = DateTime::createFromFormat($platform->getDateTimeFormatString(), $value);
 
-        if ($val === false) {
-            throw ConversionException::conversionFailedFormat(
-                $value,
-                $this->getName(),
-                $platform->getDateTimeFormatString(),
-            );
+        if ($dateTime === false) {
+            try {
+                $dateTime = new DateTime($value);
+            } catch (Throwable $e) {
+                throw ConversionException::conversionFailedFormat(
+                    $value,
+                    $this->getName(),
+                    $platform->getDateTimeFormatString(),
+                    $e,
+                );
+            }
         }
 
-        return $val;
+        return $dateTime;
     }
 }
diff --git a/src/Types/DateTimeTzType.php b/src/Types/DateTimeTzType.php
@@ -5,6 +5,9 @@
 use DateTime;
 use DateTimeInterface;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\Deprecations\Deprecation;
+
+use function get_class;
 
 /**
  * DateTime type saving additional timezone information.
@@ -56,13 +59,22 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         }
 
         if ($value instanceof DateTimeInterface) {
+            if (! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value->format($platform->getDateTimeTzFormatString());
         }
 
         throw ConversionException::conversionFailedInvalidType(
             $value,
             $this->getName(),
-            ['null', 'DateTime'],
+            ['null', DateTime::class],
         );
     }
 
@@ -78,18 +90,27 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
         if ($value === null || $value instanceof DateTimeInterface) {
+            if ($value !== null && ! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value;
         }
 
-        $val = DateTime::createFromFormat($platform->getDateTimeTzFormatString(), $value);
-        if ($val === false) {
+        $dateTime = DateTime::createFromFormat($platform->getDateTimeTzFormatString(), $value);
+        if ($dateTime === false) {
             throw ConversionException::conversionFailedFormat(
                 $value,
                 $this->getName(),
                 $platform->getDateTimeTzFormatString(),
             );
         }
 
-        return $val;
+        return $dateTime;
     }
 }
diff --git a/src/Types/DateType.php b/src/Types/DateType.php
@@ -5,6 +5,9 @@
 use DateTime;
 use DateTimeInterface;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\Deprecations\Deprecation;
+
+use function get_class;
 
 /**
  * Type that maps an SQL DATE to a PHP Date object.
@@ -43,10 +46,19 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         }
 
         if ($value instanceof DateTimeInterface) {
+            if (! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value->format($platform->getDateFormatString());
         }
 
-        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', DateTime::class]);
     }
 
     /**
@@ -61,18 +73,27 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
         if ($value === null || $value instanceof DateTimeInterface) {
+            if ($value !== null && ! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value;
         }
 
-        $val = DateTime::createFromFormat('!' . $platform->getDateFormatString(), $value);
-        if ($val === false) {
+        $dateTime = DateTime::createFromFormat('!' . $platform->getDateFormatString(), $value);
+        if ($dateTime === false) {
             throw ConversionException::conversionFailedFormat(
                 $value,
                 $this->getName(),
                 $platform->getDateFormatString(),
             );
         }
 
-        return $val;
+        return $dateTime;
     }
 }
diff --git a/src/Types/TimeType.php b/src/Types/TimeType.php
@@ -5,6 +5,9 @@
 use DateTime;
 use DateTimeInterface;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\Deprecations\Deprecation;
+
+use function get_class;
 
 /**
  * Type that maps an SQL TIME to a PHP DateTime object.
@@ -43,10 +46,19 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         }
 
         if ($value instanceof DateTimeInterface) {
+            if (! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value->format($platform->getTimeFormatString());
         }
 
-        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', DateTime::class]);
     }
 
     /**
@@ -61,18 +73,27 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
         if ($value === null || $value instanceof DateTimeInterface) {
+            if ($value !== null && ! $value instanceof Datetime) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/6017',
+                    'Passing an instance of %s is deprecated.',
+                    get_class($value),
+                );
+            }
+
             return $value;
         }
 
-        $val = DateTime::createFromFormat('!' . $platform->getTimeFormatString(), $value);
-        if ($val === false) {
+        $dateTime = DateTime::createFromFormat('!' . $platform->getTimeFormatString(), $value);
+        if ($dateTime === false) {
             throw ConversionException::conversionFailedFormat(
                 $value,
                 $this->getName(),
                 $platform->getTimeFormatString(),
             );
         }
 
-        return $val;
+        return $dateTime;
     }
 }
diff --git a/src/Types/VarDateTimeImmutableType.php b/src/Types/VarDateTimeImmutableType.php
@@ -5,8 +5,7 @@
 use DateTimeImmutable;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\Deprecations\Deprecation;
-
-use function date_create_immutable;
+use Throwable;
 
 /**
  * Immutable type of {@see VarDateTimeType}.
@@ -62,10 +61,10 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
             return $value;
         }
 
-        $dateTime = date_create_immutable($value);
-
-        if ($dateTime === false) {
-            throw ConversionException::conversionFailed($value, $this->getName());
+        try {
+            $dateTime = new DateTimeImmutable($value);
+        } catch (Throwable $e) {
+            throw ConversionException::conversionFailed($value, $this->getName(), $e);
         }
 
         return $dateTime;