Skip to content

Document the required ClassMetadataFactory #9948

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

Document the required ClassMetadataFactory #9948

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb84068
Document the required ClassMetadataFactory
deviantintegral Jun 21, 2018
06cfc70
Codefence ClassMetadataFactory
deviantintegral Jun 21, 2018
670adb1
Reword
javiereguiluz Jul 16, 2018
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
12 changes: 8 additions & 4 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,11 @@ needs three parameters:
Support for the ``allow_extra_attributes`` key in the context was introduced
in Symfony 3.3.

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::
By default, additional attributes that are not mapped to the denormalized object
will be ignored by the Serializer component. If you prefer to throw an exception
when this happens, set the ``allow_extra_attributes`` context option to
``false`` and provide an object that implements ``ClassMetadataFactoryInterface`
when constructing the normalizer::

$data = <<<EOF
<person>
Expand All @@ -184,6 +185,9 @@ an exception when additional attributes are passed::

// this will throw a Symfony\Component\Serializer\Exception\ExtraAttributesException
// because "city" is not an attribute of the Person class
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$normalizer = new ObjectNormalizer($classMetadataFactory);
$serializer = new Serializer(array($normalizer));
$person = $serializer->deserialize($data, 'Acme\Person', 'xml', array(
'allow_extra_attributes' => false,
));
Expand Down