feature #6975 [Serializer] documentation for allow_extra_attributes (juliendidier)

xabbuh · xabbuh · commit f156216c673d · 2017-03-03T08:48:40.000+01:00
This PR was merged into the master branch. Discussion ---------- [Serializer] documentation for allow_extra_attributes Doc PR for [symfony/symfony#19958](symfony/symfony#19958) Commits ------- 28dcc94 [Serializer] documentation for allow_extra_attributes
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -152,6 +152,26 @@ needs three parameters:
 #. The name of the class this information will be decoded to
 #. The encoder used to convert that information into an array
 
+By default, additional attributes that are not mapped to the denormalized object will be ignored
+by the Serializer component. Set the ``allow_extra_attributes`` key of the deserialization context to ``false``
+to let the serializer throw an exception when additional attributes are passed.
+
+This will throw an :class:`Symfony\\Component\\Serializer\\Exception\\ExtraAttributesException` exception,
+because city is not an attribute of the ``Person`` class::
+
+    $data = <<<EOF
+    <person>
+        <name>foo</name>
+        <age>99</age>
+        <city>Paris</city>
+    </person>
+    EOF;
+
+    $person = $serializer->deserialize($data, 'Acme\Person', 'xml', array(
+        'allow_extra_attributes' => false,
+    ));
+
+
 Deserializing in an Existing Object
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
