[Serializer] Add NormalizedValueInterface that can be returned by `…

…NormalizerInterface::normalize` to enable receiving a value object for normalized values.
symfony · bbrala · Oct 14, 2021 · Oct 14, 2021 · Oct 14, 2021 · Oct 14, 2021
commit 64203f75fa8c4d20f28759f08a13ea6a9e793b74
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Remove `ArrayDenormalizer::setSerializer()`, call `setDenormalizer()` instead
  * Remove the ability to create instances of the annotation classes by passing an array of parameters, use named arguments instead
+ * Add `NormalizedValueInterface` to enable normalizers to return a value object
 
 5.4
 ---

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Component\Serializer\Normalizer;
+
+interface NormalizedValueInterface {
+
+    public function getNormalization(): array|string|int|float|bool|\ArrayObject|null;
+
+}
@@ -28,15 +28,15 @@ interface NormalizerInterface
      * @param string $format  Format the normalization result will be encoded as
      * @param array  $context Context options for the normalizer
      *
-     * @return array|string|int|float|bool|\ArrayObject|null \ArrayObject is used to make sure an empty object is encoded as an object not an array
+     * @return array|string|int|float|bool|\ArrayObject|NormalizedValueInterface|null \ArrayObject is used to make sure an empty object is encoded as an object not an array
      *
      * @throws InvalidArgumentException   Occurs when the object given is not a supported type for the normalizer
      * @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular
      *                                    reference handler can fix it
      * @throws LogicException             Occurs when the normalizer is not called in an expected context
      * @throws ExceptionInterface         Occurs for all the other cases of errors
      */
-    public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null;
+    public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|NormalizedValueInterface|null;
 
     /**
      * Checks whether the given class is supported for normalization by this normalizer.

@@ -28,6 +28,7 @@
 use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizedValueInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -161,6 +162,10 @@ public function normalize(mixed $data, string $format = null, array $context = [
             return $normalizer->normalize($data, $format, $context);
         }
 
+        if ($data instanceof NormalizedValueInterface) {
+            $data = $data->getNormalization();
+        }
+
         if (null === $data || is_scalar($data)) {
             return $data;
         }

@@ -41,6 +41,7 @@
 use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer;
+use Symfony\Component\Serializer\Normalizer\NormalizedValueInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
@@ -211,6 +212,20 @@ public function testSerializeArrayOfScalars()
         $this->assertEquals(json_encode($data), $result);
     }
 
+    public function testSerializeNormalizedValue()
+    {
+        $normalizedValue = 'normalizedValue';
+        $normalizedValueObject = $this->createMock(NormalizedValueInterface::class);
+        $normalizedValueObject->method('getNormalization')
+            ->willReturn($normalizedValue);
+
+        $serializer = new Serializer([], ['json' => new JsonEncoder()]);
+        $data = ['foo', [5, $normalizedValueObject]];
+        $expectedData = ['foo', [5, $normalizedValue]];
+        $result = $serializer->serialize($data, 'json');
+        $this->assertEquals(json_encode($expectedData), $result);
+    }
+
     public function testSerializeEmpty()
     {
         $serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ CHANGELOG @@
      * Remove `ArrayDenormalizer::setSerializer()`, call `setDenormalizer()` instead
      * Remove the ability to create instances of the annotation classes by passing an array of parameters, use named arguments instead
+     * Add `NormalizedValueInterface` to enable normalizers to return a value object
 .4
     ---
@@ Expand Down @@