[Serializer] add a context to allow invalid values in BackedEnumNormalizer

nikophil · nikophil · commit d8e613fe2f49 · 2022-12-29T17:02:36.000+01:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `XmlEncoder::SAVE_OPTIONS` context option
+ * Add `BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION` context option
 
 6.2
 ---
diff --git a/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php
@@ -22,6 +22,11 @@
  */
 final class BackedEnumNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
 {
+    /**
+     * If provided, will return null for any invalid value.
+     */
+    public const NULL_IF_NOT_PART_OF_ENUMERATION = 'null_if_not_part_of_enumeration';
+
     public function normalize(mixed $object, string $format = null, array $context = []): int|string
     {
         if (!$object instanceof \BackedEnum) {
@@ -45,6 +50,18 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
             throw new InvalidArgumentException('The data must belong to a backed enumeration.');
         }
 
+        if (isset($context[self::NULL_IF_NOT_PART_OF_ENUMERATION])) {
+            if (null === $data) { // "tryFrom()" does not accept null
+                return null;
+            }
+
+            try {
+                return $type::tryFrom($data);
+            } catch (\TypeError) {
+                return null;
+            }
+        }
+
         if (!\is_int($data) && !\is_string($data)) {
             throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
         }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php
@@ -114,4 +114,19 @@ public function testSupportsNormalizationShouldFailOnAnyPHPVersionForNonEnumObje
     {
         $this->assertFalse($this->normalizer->supportsNormalization(new \stdClass()));
     }
+
+    public function testItUsesTryFromIfContextIsPassed()
+    {
+        $this->assertNull($this->normalizer->denormalize(1, IntegerBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+        $this->assertNull($this->normalizer->denormalize('foo', IntegerBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+        $this->assertNull($this->normalizer->denormalize(null, IntegerBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+
+        $this->assertSame(IntegerBackedEnumDummy::SUCCESS, $this->normalizer->denormalize(200, IntegerBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+
+        $this->assertNull($this->normalizer->denormalize(1, StringBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+        $this->assertNull($this->normalizer->denormalize('foo', StringBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+        $this->assertNull($this->normalizer->denormalize(null, StringBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+
+        $this->assertSame(StringBackedEnumDummy::GET, $this->normalizer->denormalize('GET', StringBackedEnumDummy::class, null, [BackedEnumNormalizer::NULL_IF_NOT_PART_OF_ENUMERATION => true]));
+    }
 }
