[Serializer] Add PRESERVE_CONTEXT_TIMEZONE_KEY to DateTimeNormalizer

frankdekker · frankdekker · commit 78fee13c3dca · 2025-04-15T14:19:18.000+02:00
Add `withPreserveContextTimezone` to `DateTimeNormalizerContextBuilder`
diff --git a/src/Symfony/Component/Serializer/Context/Normalizer/DateTimeNormalizerContextBuilder.php b/src/Symfony/Component/Serializer/Context/Normalizer/DateTimeNormalizerContextBuilder.php
@@ -69,4 +69,13 @@ public function withCast(?string $cast): static
     {
         return $this->with(DateTimeNormalizer::CAST_KEY, $cast);
     }
+
+    /**
+     * Configures if the timezone should be used from the context and ignore any timezone
+     * defined in date strings.
+     */
+    public function withPreserveContextTimezone(?bool $preserveContextTimezone): static
+    {
+        return $this->with(DateTimeNormalizer::PRESERVE_CONTEXT_TIMEZONE_KEY, $preserveContextTimezone);
+    }
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Context/Normalizer/DateTimeNormalizerContextBuilderTest.php b/src/Symfony/Component/Serializer/Tests/Context/Normalizer/DateTimeNormalizerContextBuilderTest.php
@@ -39,6 +39,7 @@ public function testWithers(array $values)
             ->withFormat($values[DateTimeNormalizer::FORMAT_KEY])
             ->withTimezone($values[DateTimeNormalizer::TIMEZONE_KEY])
             ->withCast($values[DateTimeNormalizer::CAST_KEY])
+            ->withPreserveContextTimezone($values[DateTimeNormalizer::PRESERVE_CONTEXT_TIMEZONE_KEY])
             ->toArray();
 
         $this->assertEquals($values, $context);
@@ -53,12 +54,14 @@ public static function withersDataProvider(): iterable
             DateTimeNormalizer::FORMAT_KEY => 'format',
             DateTimeNormalizer::TIMEZONE_KEY => new \DateTimeZone('GMT'),
             DateTimeNormalizer::CAST_KEY => 'int',
+            DateTimeNormalizer::PRESERVE_CONTEXT_TIMEZONE_KEY => true,
         ]];
 
         yield 'With null values' => [[
             DateTimeNormalizer::FORMAT_KEY => null,
             DateTimeNormalizer::TIMEZONE_KEY => null,
             DateTimeNormalizer::CAST_KEY => null,
+            DateTimeNormalizer::PRESERVE_CONTEXT_TIMEZONE_KEY => null,
         ]];
     }
 

Original file line number	Diff line number	Diff line change
`@@ -69,4 +69,13 @@ public function withCast(?string $cast): static`
`69`	`69`	`{`
`70`	`70`	`return $this->with(DateTimeNormalizer::CAST_KEY, $cast);`
`71`	`71`	`}`
	`72`	`+`
	`73`	`+ /**`
	`74`	`+ * Configures if the timezone should be used from the context and ignore any timezone`
	`75`	`+ * defined in date strings.`
	`76`	`+ */`
	`77`	`+ public function withPreserveContextTimezone(?bool $preserveContextTimezone): static`
	`78`	`+ {`
	`79`	`+ return $this->with(DateTimeNormalizer::PRESERVE_CONTEXT_TIMEZONE_KEY, $preserveContextTimezone);`
	`80`	`+ }`
`72`	`81`	`}`