[Serializer] Allow to cast certain DateTime formats to int/float

norkunas · norkunas · commit d45ef9aa9fd7 · 2023-12-13T12:52:18.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Allow to cast certain DateTime formats to int/float
+
 7.0
 ---
 
diff --git a/src/Symfony/Component/Serializer/Context/Normalizer/DateTimeNormalizerContextBuilder.php b/src/Symfony/Component/Serializer/Context/Normalizer/DateTimeNormalizerContextBuilder.php
@@ -61,4 +61,9 @@ public function withTimezone(\DateTimeZone|string|null $timezone): static
 
         return $this->with(DateTimeNormalizer::TIMEZONE_KEY, $timezone);
     }
+
+    public function withTimestampCast(bool $cast): static
+    {
+        return $this->with(DateTimeNormalizer::TIMESTAMP_CAST_KEY, $cast);
+    }
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
@@ -25,10 +25,12 @@ final class DateTimeNormalizer implements NormalizerInterface, DenormalizerInter
 {
     public const FORMAT_KEY = 'datetime_format';
     public const TIMEZONE_KEY = 'datetime_timezone';
+    public const TIMESTAMP_CAST_KEY = 'datetime_timestamp_cast';
 
     private array $defaultContext = [
         self::FORMAT_KEY => \DateTimeInterface::RFC3339,
         self::TIMEZONE_KEY => null,
+        self::TIMESTAMP_CAST_KEY => false,
     ];
 
     private const SUPPORTED_TYPES = [
@@ -59,7 +61,7 @@ public function getSupportedTypes(?string $format): array
     /**
      * @throws InvalidArgumentException
      */
-    public function normalize(mixed $object, string $format = null, array $context = []): string
+    public function normalize(mixed $object, string $format = null, array $context = []): int|float|string
     {
         if (!$object instanceof \DateTimeInterface) {
             throw new InvalidArgumentException('The object must implement the "\DateTimeInterface".');
@@ -73,7 +75,16 @@ public function normalize(mixed $object, string $format = null, array $context =
             $object = $object->setTimezone($timezone);
         }
 
-        return $object->format($dateTimeFormat);
+        return match ($context[self::TIMESTAMP_CAST_KEY] ?? $this->defaultContext[self::TIMESTAMP_CAST_KEY]) {
+            true => match ($dateTimeFormat) {
+                'U' => $object->getTimestamp(),
+                'U.u' => (float) $object->format('U.u'),
+                'Uv' => (int) $object->format('Uv'),
+                'Uu' => (int) $object->format('Uu'),
+                default => $object->format($dateTimeFormat),
+            },
+            default => $object->format($dateTimeFormat),
+        };
     }
 
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/DateTimeNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/DateTimeNormalizerTest.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
 use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
+use Symfony\Component\Validator\Constraints\DateTime;
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
@@ -154,6 +155,57 @@ public static function normalizeUsingTimeZonePassedInContextAndExpectedFormatWit
         ];
     }
 
+    /**
+     * @dataProvider provideNormalizeUsingTimestampCastCases
+     */
+    public function testNormalizeUsingTimestampCast(\DateTimeInterface $date, string $format, int|float $expectedResult)
+    {
+        self::assertSame($expectedResult, $this->normalizer->normalize($date, null, [
+            DateTimeNormalizer::TIMESTAMP_CAST_KEY => true,
+            DateTimeNormalizer::FORMAT_KEY => $format,
+        ]));
+    }
+
+    /**
+     * @dataProvider provideNormalizeUsingTimestampCastCases
+     */
+    public function testNormalizeUsingTimestampCastFromDefaultContext(\DateTimeInterface $date, string $format, int|float $expectedResult)
+    {
+        $normalizer = new DateTimeNormalizer([
+            DateTimeNormalizer::TIMESTAMP_CAST_KEY => true,
+            DateTimeNormalizer::FORMAT_KEY => $format,
+        ]);
+
+        self::assertSame($expectedResult, $normalizer->normalize($date));
+    }
+
+    public static function provideNormalizeUsingTimestampCastCases()
+    {
+        yield [
+            new \DateTimeImmutable('2016-01-01T00:00:00+00:00'),
+            'U',
+            1451606400,
+        ];
+
+        yield [
+            new \DateTimeImmutable('2016-01-01T00:00:00.123456+00:00'),
+            'U.u',
+            1451606400.123456,
+        ];
+
+        yield [
+            new \DateTimeImmutable('2016-01-01T00:00:00.123456+00:00'),
+            'Uv',
+            1451606400123,
+        ];
+
+        yield [
+            new \DateTimeImmutable('2016-01-01T00:00:00.123456+00:00'),
+            'Uu',
+            1451606400123456,
+        ];
+    }
+
     public function testNormalizeInvalidObjectThrowsException()
     {
         $this->expectException(InvalidArgumentException::class);

Original file line number	Diff line number	Diff line change
`@@ -61,4 +61,9 @@ public function withTimezone(\DateTimeZone\|string\|null $timezone): static`
`61`	`61`
`62`	`62`	`return $this->with(DateTimeNormalizer::TIMEZONE_KEY, $timezone);`
`63`	`63`	`}`
	`64`	`+`
	`65`	`+ public function withTimestampCast(bool $cast): static`
	`66`	`+ {`
	`67`	`+ return $this->with(DateTimeNormalizer::TIMESTAMP_CAST_KEY, $cast);`
	`68`	`+ }`
`64`	`69`	`}`