SymfonyWorld Online 2021 Summer Edition
June 17 – 18, 2021
SymfonyWorld Online 2021 Winter Edition
December 9 – 10, 2021
  1. Home
  2. Documentation
  3. Serializer
  4. Encoders

Warning: You are browsing the documentation for Symfony 3.3, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

Encoders

3.3 version
Unmaintained
2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0

Encoders

Encoders basically turn arrays into formats and vice versa. They implement Symfony\Component\Serializer\Encoder\EncoderInterface for encoding (array to format) and Symfony\Component\Serializer\Encoder\DecoderInterface for decoding (format to array).

You can add new encoders to a Serializer instance by using its second constructor argument:

use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Encoder\JsonEncoder;

$encoders = array(new XmlEncoder(), new JsonEncoder());
$serializer = new Serializer(array(), $encoders);

Built-in Encoders

The Serializer component provides built-in encoders:

  • Symfony\Component\Serializer\Encoder\CsvEncoder to encode/decode CSV
  • Symfony\Component\Serializer\Encoder\JsonEncoder to encode/decode JSON
  • Symfony\Component\Serializer\Encoder\XmlEncoder to encode/decode XML
  • Symfony\Component\Serializer\Encoder\YamlEncoder to encode/decode Yaml

New in version 3.2: The Symfony\Component\Serializer\Encoder\CsvEncoder and the Symfony\Component\Serializer\Encoder\YamlEncoder were introduced in Symfony 3.2.

The JsonEncoder

The JsonEncoder encodes to and decodes from JSON strings, based on the PHP json_encode and json_decode functions.

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 will encode this object like that:

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

Be aware that this encoder will consider keys beginning with @ as attributes:

$encoder = new XmlEncoder();
$encoder->encode(array('foo' => array('@bar' => 'value')));
// will return:
// <?xml version="1.0"?>
// <response>
//     <foo bar="value" />
// </response>

The YamlEncoder

This encoder requires the Yaml Component and transforms from and to Yaml.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.