Skip to content

Commit cced979

Browse files
committed
[Serializer] Document the CsvEncoder and the YamlEncoder
1 parent 59a73f5 commit cced979

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

serializer/encoders.rst

+18-6
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,23 @@ You can add new encoders to a Serializer instance by using its second constructo
2323
Built-in Encoders
2424
-----------------
2525

26-
Two encoders are used in the example above:
26+
The Serializer component provides built-in encoders:
2727

28-
* :class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder` to encode/decode XML
28+
* :class:`Symfony\\Component\\Serializer\\Encoder\\CsvEncoder` to encode/decode CSV
2929
* :class:`Symfony\\Component\\Serializer\\Encoder\\JsonEncoder` to encode/decode JSON
30+
* :class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder` to encode/decode XML
31+
* :class:`Symfony\\Component\\Serializer\\Encoder\\YamlEncoder` to encode/decode Yaml
32+
33+
.. versionadded:: 3.2
34+
The :class:`Symfony\\Component\\Serializer\\Encoder\\CsvEncoder` and the
35+
:class:`Symfony\\Component\\Serializer\\Encoder\\YamlEncoder` were added in
36+
Symfony 3.2.
37+
38+
The ``JsonEncoder``
39+
~~~~~~~~~~~~~~~~~~~
40+
41+
The ``JsonEncoder`` is much simpler and is based on the PHP
42+
:phpfunction:`json_encode` and :phpfunction:`json_decode` functions.
3043

3144
The ``XmlEncoder``
3245
~~~~~~~~~~~~~~~~~~
@@ -56,8 +69,7 @@ Be aware that this encoder will consider keys beginning with ``@`` as attributes
5669
// <foo bar="value" />
5770
// </response>
5871

59-
The ``JsonEncoder``
60-
~~~~~~~~~~~~~~~~~~~
72+
The ``YamlEncoder``
73+
~~~~~~~~~~~~~~~~~~
6174

62-
The ``JsonEncoder`` is much simpler and is based on the PHP
63-
:phpfunction:`json_encode` and :phpfunction:`json_decode` functions.
75+
This encoder requires the :doc:`Yaml Component </components/yaml>`.

0 commit comments

Comments
 (0)