Skip to content

Add documentation for XmlEncoder context param #7231

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
Closed
Changes from all 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
57 changes: 57 additions & 0 deletions components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,63 @@ 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 ``XmlEncoder``
------------------

This encoder transforms arrays into XML and vice versa. For example, take an
object normalized as following::

array('foo' => array(1, 2), 'bar' => true);

The ``XmlEncoder`` encodes this object as follows:

.. code-block:: xml

<?xml version="1.0"?>
<response>
<foo>1</foo>
<foo>2</foo>
<bar>1</bar>
</response>

The array keys beginning with ``@`` are considered XML attributes::

array('foo' => array('@bar' => 'value'));

// is encoded as follows:
// <?xml version="1.0"?>
// <response>
// <foo bar="value" />
// </response>

Context
~~~~~~~

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

$xmlEncoder->encode($array, 'xml', $context);

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.

Learn more
----------
Expand Down