Add new feature to serializer: empty_data

Nek- · Nek- · commit a5c2a5ef3e4c · 2017-12-20T20:42:42.000+01:00
You can now add empty_data to the context on deserialization
of objects. This allow you to deserialize objects that have
requirements in the constructor that can't be given.

Basically, it helps you hydrate with value objects, so the
validation component can invalid the object without the
serializer send an error.
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -6,6 +6,8 @@ CHANGELOG
 
 * added `IncompleteInputDataException` new exception for deserialization failure
   of objects that needs data insertion in constructor
+* added an optional `empty_data` option of context to specify a default data in
+  case the object is not initializable by its constructor because of data missing
 
 4.0.0
 -----
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
@@ -37,6 +37,7 @@ abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerIn
     const GROUPS = 'groups';
     const ATTRIBUTES = 'attributes';
     const ALLOW_EXTRA_ATTRIBUTES = 'allow_extra_attributes';
+    const EMPTY_DATA = 'empty_data';
 
     /**
      * @var int
@@ -355,6 +356,8 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref
                     // Don't run set for a parameter passed to the constructor
                     $params[] = $parameterData;
                     unset($data[$key]);
+                } elseif ($allowed && !$ignored && isset($context[static::EMPTY_DATA][$class][$key])) {
+                    $params[] = $context[static::EMPTY_DATA][$class][$key];
                 } elseif ($constructorParameter->isDefaultValueAvailable()) {
                     $params[] = $constructorParameter->getDefaultValue();
                 } else {
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -218,6 +218,23 @@ public function testConstructorWithMissingData()
         $normalizer->denormalize($data, DummyValueObject::class);
     }
 
+    public function testFillWithEmptyDataWhenMissingData()
+    {
+        $data = array(
+            'foo' => 10,
+        );
+
+        $normalizer = new ObjectNormalizer();
+
+        $result = $normalizer->denormalize($data, DummyValueObject::class, 'json', array(
+            'empty_data' => array(
+                DummyValueObject::class => ['foo' => '', 'bar' => ''],
+            ),
+        ));
+
+        $this->assertEquals(new DummyValueObject(10, ''), $result);
+    }
+
     public function testGroupsNormalize()
     {
         $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
