Add DateTimeInterface value support to date fields (#315)

yiisoft · Apr 1, 2024 · e147cdb · e147cdb
1 parent 82bbaf1
commit e147cdb
Show file tree

Hide file tree

Showing 10 changed files with 104 additions and 1 deletion.
diff --git a/src/Field/Base/DateTimeInputField.php b/src/Field/Base/DateTimeInputField.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Field\Base;
 
+use DateTimeInterface;
 use InvalidArgumentException;
 use ReflectionClass;
 use Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesInterface;
@@ -150,7 +151,9 @@ final protected function generateInput(): string
     {
         $value = $this->getValue();
 
-        if (!is_string($value) && $value !== null) {
+        if ($value instanceof DateTimeInterface) {
+            $value = $this->formatDateTime($value);
+        } elseif (!is_string($value) && $value !== null) {
             throw new InvalidArgumentException(
                 (new ReflectionClass($this))->getShortName() .
                 ' field requires a string or null value.'
@@ -166,6 +169,8 @@ final protected function generateInput(): string
         return Html::input($this->getInputType(), $this->getName(), $value, $inputAttributes)->render();
     }
 
+    abstract protected function formatDateTime(DateTimeInterface $value): string;
+
     abstract protected function getInputType(): string;
 
     protected function prepareContainerAttributes(array &$attributes): void

diff --git a/src/Field/Date.php b/src/Field/Date.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Field;
 
+use DateTimeInterface;
 use Yiisoft\Form\Field\Base\DateTimeInputField;
 
 /**
@@ -19,4 +20,9 @@ protected function getInputType(): string
     {
         return 'date';
     }
+
+    protected function formatDateTime(DateTimeInterface $value): string
+    {
+        return $value->format('Y-m-d');
+    }
 }
diff --git a/src/Field/DateTime.php b/src/Field/DateTime.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Field;
 
+use DateTimeInterface;
 use Yiisoft\Form\Field\Base\DateTimeInputField;
 
 /**
@@ -19,4 +20,9 @@ protected function getInputType(): string
     {
         return 'datetime';
     }
+
+    protected function formatDateTime(DateTimeInterface $value): string
+    {
+        return $value->format('Y-m-d\TH:i');
+    }
 }
diff --git a/src/Field/DateTimeLocal.php b/src/Field/DateTimeLocal.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Field;
 
+use DateTimeInterface;
 use Yiisoft\Form\Field\Base\DateTimeInputField;
 
 /**
@@ -19,4 +20,9 @@ protected function getInputType(): string
     {
         return 'datetime-local';
     }
+
+    protected function formatDateTime(DateTimeInterface $value): string
+    {
+        return $value->format('Y-m-d\TH:i');
+    }
 }
diff --git a/src/Field/Time.php b/src/Field/Time.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Field;
 
+use DateTimeInterface;
 use Yiisoft\Form\Field\Base\DateTimeInputField;
 
 /**
@@ -19,4 +20,9 @@ protected function getInputType(): string
     {
         return 'time';
     }
+
+    protected function formatDateTime(DateTimeInterface $value): string
+    {
+        return $value->format('H:i');
+    }
 }
diff --git a/tests/Field/DateTest.php b/tests/Field/DateTest.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Tests\Field;
 
+use DateTime;
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Form\Field\Base\InputData\PureInputData;
 use Yiisoft\Form\Field\Date;
@@ -56,4 +57,20 @@ public function testRange(): void
 
         $this->assertSame($expected, $result);
     }
+
+    public function testWithDateTimeInterface(): void
+    {
+        $result = Date::widget()
+            ->value(new DateTime('1996-12-19'))
+            ->render();
+
+        $this->assertSame(
+            <<<HTML
+            <div>
+            <input type="date" value="1996-12-19">
+            </div>
+            HTML,
+            $result,
+        );
+    }
 }
diff --git a/tests/Field/DateTimeLocalTest.php b/tests/Field/DateTimeLocalTest.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Tests\Field;
 
+use DateTime;
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Form\Field\Base\InputData\PureInputData;
 use Yiisoft\Form\Field\DateTimeLocal;
@@ -39,4 +40,20 @@ public function testBase(): void
 
         $this->assertSame($expected, $result);
     }
+
+    public function testWithDateTimeInterface(): void
+    {
+        $value = (new DateTime('1996-12-19'))->setTime(20, 35);
+
+        $result = DateTimeLocal::widget()->value($value)->render();
+
+        $this->assertSame(
+            <<<HTML
+            <div>
+            <input type="datetime-local" value="1996-12-19T20:35">
+            </div>
+            HTML,
+            $result,
+        );
+    }
 }
diff --git a/tests/Field/DateTimeTest.php b/tests/Field/DateTimeTest.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Tests\Field;
 
+use DateTimeImmutable;
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Form\Field\Base\InputData\PureInputData;
 use Yiisoft\Form\Field\DateTime;
@@ -39,4 +40,20 @@ public function testBase(): void
 
         $this->assertSame($expected, $result);
     }
+
+    public function testWithDateTimeInterface(): void
+    {
+        $value = (new DateTimeImmutable('1996-12-19'))->setTime(20, 35);
+
+        $result = DateTime::widget()->value($value)->render();
+
+        $this->assertSame(
+            <<<HTML
+            <div>
+            <input type="datetime" value="1996-12-19T20:35">
+            </div>
+            HTML,
+            $result,
+        );
+    }
 }
diff --git a/tests/Field/TimeTest.php b/tests/Field/TimeTest.php
@@ -6,6 +6,7 @@
 
 namespace Yiisoft\Form\Tests\Field;
 
+use DateTimeImmutable;
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Form\Field\Time;
 use Yiisoft\Form\ThemeContainer;
@@ -49,4 +50,20 @@ public function testExtended(): void
 
         $this->assertSame($expected, $result);
     }
+
+    public function testWithDateTimeInterface(): void
+    {
+        $value = (new DateTimeImmutable('1996-12-19'))->setTime(20, 35);
+
+        $result = Time::widget()->value($value)->render();
+
+        $this->assertSame(
+            <<<HTML
+            <div>
+            <input type="time" value="20:35">
+            </div>
+            HTML,
+            $result,
+        );
+    }
 }
diff --git a/tests/Support/StubDateTimeInputField.php b/tests/Support/StubDateTimeInputField.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Form\Tests\Support;
 
+use DateTimeInterface;
 use Yiisoft\Form\Field\Base\DateTimeInputField;
 
 final class StubDateTimeInputField extends DateTimeInputField
@@ -12,4 +13,9 @@ protected function getInputType(): string
     {
         return 'datetime';
     }
+
+    protected function formatDateTime(DateTimeInterface $value): string
+    {
+        return $value->format('d.m.Y');
+    }
 }