Skip to content

[Serializer] Docs for CSV and YAML encoders #7040

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 1 commit into from
Closed

[Serializer] Docs for CSV and YAML encoders #7040

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,30 @@ There are several types of normalizers available:
The ``JsonSerializableNormalizer``, ``DateTimeNormalizer`` and
``DataUriNormalizer`` normalizers were added in Symfony 3.1

Encoders
--------

The Serializer component supports many formats out of the box:

:class:`Symfony\\Component\\Serializer\\Encoder\\JsonEncoder`
This class encodes and decodes data in JSON_.

:class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder`
This class encodes and decodes data in XML_.

:class:`Symfony\\Component\\Serializer\\Encoder\\YamlEncoder`
This encoder encodes and decodes data in YAML_. This encoder requires the
:doc:`Yaml Component </components/yaml>`.

:class:`Symfony\\Component\\Serializer\\Encoder\\CsvEncoder`
This encoder encodes and decodes data in CSV_.

All these encoders are enabled by default when using the Symfony Standard Edition
with the serializer enabled.

.. versionadded:: 3.2
The ``YamlEncoder`` and ``CsvEncoder`` encoders were added in Symfony 3.2
Copy link
Member

Choose a reason for hiding this comment

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

"were introduced in Symfony 3.2."


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

Expand Down Expand Up @@ -688,3 +712,7 @@ Learn more
.. _`JMS serializer`: https://github.com/schmittjoh/serializer
.. _Packagist: https://packagist.org/packages/symfony/serializer
.. _RFC3339: https://tools.ietf.org/html/rfc3339#section-5.8
.. _JSON: http://www.json.org/
.. _XML: https://www.w3.org/XML/
.. _YAML: http://yaml.org/
.. _CSV: https://tools.ietf.org/html/rfc4180