Deprecate passing timezone information to methods where it is ignored

doctrine · Apr 20, 2023 · 0cdd7a4 · 0cdd7a4
1 parent 4da7e9c
commit 0cdd7a4
Showing 1 changed file with 35 additions and 1 deletion.
diff --git a/src/Types/DateImmutableType.php b/src/Types/DateImmutableType.php
@@ -35,6 +35,21 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
         }
 
         if ($value instanceof DateTimeImmutable) {
+            $offset        = $value->format('O');
+            $defaultOffset = (new DateTimeImmutable())->format('O');
+            if ($offset !== $$defaultOffset) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/xxxx',
+                    'Passing a timezone offset (%s) different than the default one (%s) is deprecated'
+                    . ' as it will be lost, use %s::%s() instead.',
+                    $offset,
+                    $defaultOffset,
+                    DateTimeTzImmutableType::class,
+                    __FUNCTION__,
+                );
+            }
+
             return $value->format($platform->getDateFormatString());
         }
 
@@ -56,7 +71,26 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
      */
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
-        if ($value === null || $value instanceof DateTimeImmutable) {
+        if ($value === null) {
+            return null;
+        }
+
+        if ($value instanceof DateTimeImmutable) {
+            $offset        = $value->format('O');
+            $defaultOffset = (new DateTimeImmutable())->format('O');
+            if ($offset !== $$defaultOffset) {
+                Deprecation::triggerIfCalledFromOutside(
+                    'doctrine/dbal',
+                    'https://github.com/doctrine/dbal/pull/xxxx',
+                    'Passing a timezone offset (%s) different than the default one (%s) is deprecated'
+                    . ' as it may be lost, use %s::%s() instead.',
+                    $offset,
+                    $defaultOffset,
+                    DateTimeTzImmutableType::class,
+                    __FUNCTION__,
+                );
+            }
+
             return $value;
         }