JsonEncoder

JsonEncoder зашифровывает и расшифровывает JSON-строки, опираясь на PHP-функции json_encode и json_decode.

В некоторых случаях может быть полезно изменить работу этих функций с помощью таких опций, как JSON_PRESERVE_ZERO_FRACTION. Вы можете использовать контекст сериализации для передачи этих опций с помощью ключа json_encode_options или json_decode_options соответственно:

1
2
3

$this->serializer->serialize($data, 'json', [
    'json_encode_options' => \JSON_PRESERVE_ZERO_FRACTION,
]);

Вот все опции контекста, доступные для кодировщика JSON :

json_decode_associative (по умолчанию: false)

Если установлено как true - возвращает результат в виде массива, в противном случае - возвращает вложенную иерархию stdClass.

json_decode_detailed_errors (по умолчанию: false)

Если установлено как true - исключения, вызываемые при анализе JSON, более конкретны. Требует пакет`seld/jsonlint`_.

json_decode_options (по умолчанию: 0)

Флажки, переданные функции json_decode.

json_encode_options (по умолчанию: \JSON_PRESERVE_ZERO_FRACTION)

Флажки, переданные функции json_encode.

json_decode_recursion_depth (по умолчанию: 512)

Устанавливает максимальную глубину рекурсии.

CsvEncoder

CsvEncoder зашифровывает и расшифровывает CSV. Доступны несколько
опций контекста для настройки поведения кодировщика:

csv_delimiter (по умолчанию: ,)

Устанавливает разделитель полей, разделяющий значения (только один символ).

csv_enclosure (по умолчанию: ")

Устанавливает замыкание поля (только один символ).

csv_end_of_line (по умолчанию: \n)

Устанавливает символ(ы) для обозначения конца каждой строки в файле CSV.

csv_escape_char (по умолчанию: порожній рядок)

7.2

Опция csv_escape_char устарела, начиная с Symfony 7.2.

Устанавливает символ экранирования (максимум один символ).

csv_key_separator (по умолчанию: .)

Устанавливает разделитель для ключей массива во время его выравнивания

csv_headers (по умолчанию: [], виведено з ключів даних введення)

Устанавливает порядок заголовка и столбцов данных. Например, если вы установите значение ['a', 'b', 'c'] и сериализуете ['c' => 3, 'a' => 1, 'b' => 2], порядок будет a,b,c вместо порядка ввода (c,a,b).

csv_escape_formulas (по умолчанию: false)

Экранирует поля, содержащие формулы, добавляя к ним символ \t в начале.

as_collection (по умолчанию: true)

Всегда возвращает результаты в виде коллекции, даже если расшифрована только одна строка.

no_headers (по умолчанию: false)

Если установлено false, то при денормализации будет использована первая строка в качестве заголовков, если true - генерирует числовые заголовки.

output_utf8_bom (по умолчанию: false)

Выводит специальный UTF-8 BOM вместе с зашифрованными данными.

XmlEncoder

Этот кодировщик преобразует PHP-значение в XML и наоборот.

Например, возьмем объект, который нормализуется следующим образом:

1

$normalizedArray = ['foo' => [1, 2], 'bar' => true];

XmlEncoder зашифрует этот объект так:

1
2
3
4
5
6

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <foo>1</foo>
    <foo>2</foo>
    <bar>1</bar>
</response>

Специальный ключ # можно использовать для определения данных узла:

1
2
3
4
5
6
7
8
9
10

['foo' => ['@bar' => 'value', '#' => 'baz']];

/* зашифровано наступним чином:
   <?xml version="1.0"?>
   <response>
       <foo bar="value">
          baz
       </foo>
   </response>
 */

Кроме того, ключи, начинающиеся с @, будут считаться атрибутами, а ключ #comment можно использовать для шифрования XML-комментариев:

1
2
3
4
5
6
7
8
9
10
11
12

$encoder = new XmlEncoder();
$xml = $encoder->encode([
    'foo' => ['@bar' => 'value'],
    'qux' => ['#comment' => 'A comment'],
], 'xml');
/* вернет:
   <?xml version="1.0"?>
   <response>
       <foo bar="value"/>
       <qux><!-- A comment --!><qux>
   </response>
 */

Вы можете передать ключ контекста as_collection, чтобы всегда получить результаты
в виде коллекции.

Возможно, вам придется добавить некоторые атрибуты к корневому узлу:

1
2
3
4
5
6
7
8
9
10
11
12

$encoder = new XmlEncoder();
$encoder->encode([
    '@attribute1' => 'foo',
    '@attribute2' => 'bar',
    '#' => ['foo' => ['@bar' => 'value', '#' => 'baz']]
], 'xml');

// вернет:
// <?xml version="1.0"?>
// <response attribute1="foo" attribute2="bar">
// <foo bar="value">baz</foo>
// </response>

1

$xmlEncoder->encode($array, 'xml', [XmlEncoder::ENCODER_IGNORED_NODE_TYPES => [\XML_COMMENT_NODE]]);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

use Symfony\Component\Serializer\Encoder\XmlEncoder;

$data = [
    'id' => 'IDHNQIItNyQ',
    'date' => '2019-10-24',
];

$xmlEncoder->encode($data, 'xml', ['xml_format_output' => true]);
// выводит:
// <?xml version="1.0"?>
// <response>
//   <id>IDHNQIItNyQ</id>
//   <date>2019-10-24</date>
// </response>

$xmlEncoder->encode($data, 'xml', [
    'xml_format_output' => true,
    'xml_root_node_name' => 'track',
    'encoder_ignored_node_types' => [
        \XML_PI_NODE, // видаляє оголошення XML (перший xml-тег)
    ],
]);
// выводит:
// <track>
//   <id>IDHNQIItNyQ</id>
//   <date>2019-10-24</date>
// </track>

YamlEncoder

Этот кодировщик требует Компонент Yaml и преобразует из и в Yaml.

Как и для других кодировщиков, для него доступны несколько
опций контекста :

yaml_inline (по умолчанию: 0)

Уровень, на котором вы переходите на встроенный YAML.

yaml_indent (по умолчанию: 0)

Уровень отступа (используется внутренне).

yaml_flags (по умолчанию: 0)

Битовое поле констант Yaml::DUMP_*/`Yaml::PARSE_*`` для настройки зашифровки/расшифровки YAML-строки.

Создание пользовательского кодировщика

Представьте, что вы хотите сериализировать и десериализировать NEON. Для этого вам нужно создать собственный кодировщик:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

// src/Serializer/YamlEncoder.php
namespace App\Serializer;

use Nette\Neon\Neon;
use Symfony\Component\Serializer\Encoder\DecoderInterface;
use Symfony\Component\Serializer\Encoder\EncoderInterface;

class NeonEncoder implements EncoderInterface, DecoderInterface
{
    public function encode($data, string $format, array $context = [])
    {
        return Neon::encode($data);
    }

    public function supportsEncoding(string $format)
    {
        return 'neon' === $format;
    }

    public function decode(string $data, string $format, array $context = [])
    {
        return Neon::decode($data);
    }

    public function supportsDecoding(string $format)
    {
        return 'neon' === $format;
    }
}

1
2
3
4
5
6

# config/services.yaml
services:
    # ...

    App\Serializer\NeonEncoder:
        tags: ['serializer.encoder']

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <!-- ... -->

        <service id="App\Serializer\NeonEncoder">
            <tag name="serializer.encoder"/>
        </service>
    </services>
</container>

1
2
3
4
5
6
7
8
9
10
11
12

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\Serializer\NeonEncoder;

return function(ContainerConfigurator $container) {
    // ...

    $services->set(NeonEncoder::class)
        ->tag('serializer.encoder')
    ;
};