Skip to content

[Serializer] documentation for allow_extra_attributes #6975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down