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.

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
Changes from 4 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 @@ -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``.

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
Copy link
Contributor

Choose a reason for hiding this comment

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

you could add a link to the PHP doc for the json_encode function IMO

Copy link
Contributor

Choose a reason for hiding this comment

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

can remove the full

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
Copy link
Contributor

Choose a reason for hiding this comment

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

I would change it for [...] converts \DateTimeInterface objects (ex \DateTime and \DateTimeImmutable) into strings [...].

Indeed \DateTime may be more natural for you, but for other people it may be \DateTimeImmutable or for Laravel users Carbon.

It would be also nice to have links to the PHP doc here too

``\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