Skip to content

New normalizers #6314

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 7 commits into from
Closed

New normalizers #6314

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
67a00d0
Add information about JsonSerializableNormalizer
mcfedr Mar 1, 2016
99aa80a
Add information for DateTimeNormalizer
mcfedr Mar 1, 2016
dfd8143
Add information for the DataUriNormalizer
mcfedr Mar 1, 2016
d20a80f
Double backticks for code
mcfedr Mar 1, 2016
85add13
Add links to php docs
mcfedr Mar 2, 2016
c4432a6
Add a link to RFC3339
mcfedr Mar 5, 2016
79245af
Add versionadded
mcfedr Mar 5, 2016
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,26 @@ There are several types of normalizers available:

Objects are normalized to a map of property names to property values.

::class:`Symfony\\Component\\Serializer\\Normalizer\\JsonSerializableNormalizer`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The colon @theofidry is confused of comes from the double colon here (the directive is :class:).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ha indeed, misread I though it was the same for the others

This normalizer works with classes that implement `\JsonSerializable`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use double backticks here and below to enclose class names, method names, etc.


It will call the `jsonSerialize` method and then further normalize the result.
This means that nested `JsonSerializable` classes will also be normalized.

This normalizer is particularly helpful when you want to gradually migrate
from an existing codebase using simple `json_encode` to the full Symfony
Serializer by allowing you to mix which normalizers are used for which classes.

Unlike with `json_encode` circular references are handled.

::class:`Symfony\\Component\\Serializer\\Normalizer\\DateTimeNormalizer`
This normalizer converts \DateTime objects (or anything that implements
`\DateTimeInterface`) into strings. By default it uses the RFC3339 format.

::class:`Symfony\\Component\\Serializer\\Normalizer\\DataUriNormalizer`
This normalizer converts \SplFileInfo objects into a data URI string
(`data:...`) such that files can be embedded into serialized data.

Handling Circular References
----------------------------

Expand Down