Ensure DateType marshalling works for both mutable and immutable types

cakephp · Aug 14, 2020 · b534211 · b534211
1 parent 0296bc8
commit b534211
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/Type/DateTimeType.php b/Type/DateTimeType.php
@@ -449,9 +449,9 @@ public function useMutable()
      * @param string $value The value to parse and convert to an object.
      * @return \Cake\I18n\I18nDateTimeInterface|null
      */
-    protected function _parseLocaleValue(string $value)
+    protected function _parseLocaleValue(string $value): ?I18nDateTimeInterface
     {
-        /** @var \Cake\I18n\I18nDateTimeInterface $class */
+        /** @psalm-var class-string<\Cake\I18n\I18nDateTimeInterface> $class */
         $class = $this->_className;
 
         return $class::parseDateTime($value, $this->_localeMarshalFormat);
@@ -464,9 +464,9 @@ protected function _parseLocaleValue(string $value)
      * @param string $value The value to parse and convert to an object.
      * @return \DateTimeInterface|null
      */
-    protected function _parseValue(string $value)
+    protected function _parseValue(string $value): ?DateTimeInterface
     {
-        /** @var \DateTime|\DateTimeImmutable $class */
+        /** @psalm-var class-string<\DateTime>|class-string<\DateTimeImmutable> $class */
         $class = $this->_className;
 
         foreach ($this->_marshalFormats as $format) {

diff --git a/Type/DateType.php b/Type/DateType.php
@@ -18,6 +18,7 @@
 
 use Cake\I18n\Date;
 use Cake\I18n\FrozenDate;
+use Cake\I18n\I18nDateTimeInterface;
 use DateTime;
 use DateTimeImmutable;
 use DateTimeInterface;
@@ -80,7 +81,9 @@ public function useMutable()
     public function marshal($value): ?DateTimeInterface
     {
         $date = parent::marshal($value);
-        if ($date instanceof DateTime) {
+        if ($date && !$date instanceof I18nDateTimeInterface) {
+            // Clear time manually when I18n types aren't available and raw DateTime used
+            /** @psalm-var \DateTime|\DateTimeImmutable $date */
             $date->setTime(0, 0, 0);
         }
 
@@ -90,9 +93,9 @@ public function marshal($value): ?DateTimeInterface
     /**
      * @inheritDoc
      */
-    protected function _parseLocaleValue(string $value)
+    protected function _parseLocaleValue(string $value): ?I18nDateTimeInterface
     {
-        /** @var \Cake\I18n\I18nDateTimeInterface $class */
+        /** @psalm-var class-string<\Cake\I18n\I18nDateTimeInterface> $class */
         $class = $this->_className;
 
         return $class::parseDate($value, $this->_localeMarshalFormat);

diff --git a/Type/TimeType.php b/Type/TimeType.php
@@ -16,6 +16,8 @@
  */
 namespace Cake\Database\Type;
 
+use Cake\I18n\I18nDateTimeInterface;
+
 /**
  * Time type converter.
  *
@@ -38,9 +40,9 @@ class TimeType extends DateTimeType
     /**
      * @inheritDoc
      */
-    protected function _parseLocaleValue(string $value)
+    protected function _parseLocaleValue(string $value): ?I18nDateTimeInterface
     {
-        /** @var \Cake\I18n\I18nDateTimeInterface $class */
+        /** @psalm-var class-string<\Cake\I18n\I18nDateTimeInterface> $class */
         $class = $this->_className;
 
         /** @psalm-suppress PossiblyInvalidArgument */