Skip to content

[Serializer] Merge encoder sections and show options in a table #14521

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

Merged
merged 1 commit into from
Nov 8, 2020
Merged

[Serializer] Merge encoder sections and show options in a table #14521

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
108 changes: 44 additions & 64 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,6 +823,38 @@ The ``CsvEncoder``

The ``CsvEncoder`` encodes to and decodes from CSV.

The ``CsvEncoder`` Context Options
..................................

The ``encode()`` method defines a third optional parameter called ``context``
which defines the configuration options for the CsvEncoder an associative array::

$csvEncoder->encode($array, 'csv', $context);

These are the options available:

======================= ==================================================== ==========================
Option Description Default
======================= ==================================================== ==========================
``csv_delimiter`` Sets the field delimiter separating values (one ``,``
character only)
``csv_enclosure`` Sets the field enclosure (one character only) ``"``
``csv_escape_char`` Sets the escape character (at most one character)
``csv_key_separator`` Sets the separator for array's keys during its ``.``
flattening
``csv_headers`` Sets the headers for the data ``[]``, inferred from input data's keys
``csv_escape_formulas`` Escapes fields containg formulas by prepending them ``false``
with a ``\t`` character
``as_collection`` Always returns results as a collection, even if only
one line is decoded.
``no_headers`` Disables header in the encoded CSV ``false``
``output_utf8_bom`` Outputs special `UTF-8 BOM`_ along with encoded data ``false``
======================= ==================================================== ==========================

.. versionadded:: 4.4

The ``output_utf8_bom`` option was introduced in Symfony 4.4.

The ``XmlEncoder``
~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -891,23 +923,18 @@ which defines the configuration options for the XmlEncoder an associative array:

These are the options available:

``xml_format_output``
If set to true, formats the generated XML with line breaks and indentation.

``xml_version``
Sets the XML version attribute (default: ``1.1``).

``xml_encoding``
Sets the XML encoding attribute (default: ``utf-8``).

``xml_standalone``
Adds standalone attribute in the generated XML (default: ``true``).

``xml_root_node_name``
Sets the root node name (default: ``response``).

``remove_empty_tags``
If set to true, removes all empty tags in the generated XML (default: ``false``).
====================== ==================================================== ==========================
Option Description Default
====================== ==================================================== ==========================
``xml_format_output`` If set to true, formats the generated XML with line
breaks and indentation.
``xml_version`` Sets the XML version attribute ``1.1``
``xml_encoding`` Sets the XML encoding attribute ``utf-8``
``xml_standalone`` Adds standalone attribute in the generated XML ``true``
``xml_root_node_name`` Sets the root node name (default: ``response``).
``remove_empty_tags`` If set to true, removes all empty tags in the ``false``
generated XML
====================== ==================================================== ==========================

The ``YamlEncoder``
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1232,53 +1259,6 @@ you indicate that you're expecting an array instead of a single object::
$data = ...; // The serialized data from the previous example
$persons = $serializer->deserialize($data, 'Acme\Person[]', 'json');


The ``CsvEncoder``
------------------

This encoder transforms arrays into CSV and vice versa.

Context
~~~~~~~

The ``encode()`` method defines a third optional parameter called ``context``
which defines the configuration options for the CsvEncoder an associative array::

$csvEncoder->encode($array, 'csv', $context);

These are the options available:

``csv_delimiter``
Sets the field delimiter separating values (one character only, default: ``,``).

``csv_enclosure``
Sets the field enclosure (one character only, default: ``"``).

``csv_escape_char``
Sets the escape character (at most one character, default: empty string).

``csv_key_separator``
Sets the separator for array's keys during its flattening (default: ``.``).

``csv_headers``
Sets the headers for the data (default: ``[]``, inferred from input data's keys).

``csv_escape_formulas``
Escapes fields containg formulas by prepending them with a ``\t`` character (default: ``false``).

``as_collection``
Always returns results as a collection, even if only one line is decoded.

``no_headers``
Disables header in the encoded CSV (default: ``false``).

``output_utf8_bom``
Outputs special `UTF-8 BOM`_ along with encoded data (default: ``false``).

.. versionadded:: 4.4

The ``output_utf8_bom`` option was introduced in Symfony 4.4.

Handling Constructor Arguments
------------------------------

Expand Down