Accept DATE_* constants as formatter values for the DateTime filter

Author: wol-soft

src/Filter/DateTime.php

@@ -24,6 +24,8 @@ class DateTime
      */
     public static function filter(?string $value, array $options = []): ?\DateTime
     {
+        static::convertConstants($options);
+
         try {
             if (($options['convertNullToNow'] ?? false) && $value === null) {
                 return new \DateTime();
@@ -38,7 +40,13 @@ public static function filter(?string $value, array $options = []): ?\DateTime
             }
 
             if (($options['createFromFormat'] ?? false) && $value !== null) {
-                return \DateTime::createFromFormat($options['createFromFormat'], $value);
+                $result = \DateTime::createFromFormat($options['createFromFormat'], $value);
+
+                if (!$result) {
+                    throw new Exception();
+                }
+
+                return $result;
             }
 
             return $value !== null ? new \DateTime($value) : null;
@@ -55,8 +63,24 @@ public static function filter(?string $value, array $options = []): ?\DateTime
      */
     public static function serialize(?\DateTime $value, array $options = []): ?string
     {
+        static::convertConstants($options);
+
         return ($value instanceof \DateTime)
             ? $value->format($options['outputFormat'] ?? $options['createFromFormat'] ?? DATE_ISO8601)
             : null;
     }
+
+    /**
+     * Make DATE constants available
+     *
+     * @param array $options
+     */
+    protected static function convertConstants(array &$options): void
+    {
+        foreach (['createFromFormat', 'outputFormat'] as $format) {
+            if (isset($options[$format]) && defined("DATE_{$options[$format]}")) {
+                $options[$format] = constant("DATE_{$options[$format]}");
+            }
+        }
+    }
 }

tests/Filter/DateTimeTest.php

@@ -81,6 +81,15 @@ public function testCreateFromFormatOption(): void
         );
     }
 
+    public function testCreateFromFormatOptionWithFormatConstant(): void
+    {
+        $dateTime = new DateTime();
+        $this->assertSame(
+            $dateTime->format(DATE_ATOM),
+            DateTimeFilter::filter($dateTime->format(DATE_RSS), ['createFromFormat' => 'RSS'])->format(DATE_ATOM)
+        );
+    }
+
     public function testSerializeDefaultFormat(): void
     {
         $this->assertNull(DateTimeFilter::serialize(null));
@@ -108,4 +117,24 @@ public function testSerializeWithOutputFormat(): void
             DateTimeFilter::serialize($dateTime, ['createFromFormat' => 'mdY', 'outputFormat' => 'Ymd'])
         );
     }
+
+    public function testSerializeWithCreateFromFormatWithFormatConstant(): void
+    {
+        $dateTime = new DateTime();
+
+        $this->assertSame(
+            $dateTime->format(DATE_RSS),
+            DateTimeFilter::serialize($dateTime, ['createFromFormat' => 'RSS'])
+        );
+    }
+
+    public function testSerializeWithOutputFormatWithFormatConstant(): void
+    {
+        $dateTime = new DateTime();
+
+        $this->assertSame(
+            $dateTime->format(DATE_RSS),
+            DateTimeFilter::serialize($dateTime, ['createFromFormat' => 'ATOM', 'outputFormat' => 'RSS'])
+        );
+    }
 }