XmlEncoder
class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface
Кодирует данные XML.
Свойства
| SerializerAwareTrait | Свойство SerializerAware. |
Методы
| setSerializer(SerializerInterface $serializer) Устанавливает сериализатор. | из SerializerAwareTrait | |
| __construct(string $rootNodeName = 'response', int|null $loadOptions = null) Создаёт новый XmlEncoder и позволяет изменить имя корневого узла. | ||
| scalar | encode(mixed $data, string $format, array $context = array()) Кодирует данные в указанный формат. | |
| mixed | decode(string $data, string $format, array $context = array()) Декодирует строку в данные PHP. | |
| bool | supportsEncoding(string $format) Проверяет, может ли сериализатор закодировать в данный формат. | |
| bool | supportsDecoding(string $format) Проверяет, может ли десериализатор декодировать из данного формата. | |
| setRootNodeName(string $name) Устанавливает имя корневого узла. | ||
| string | getRootNodeName() Возвращает имя корневого узла. |
Подробное описание
setSerializer(SerializerInterface $serializer)
Устанавливает сериализатор.
Параметры
| SerializerInterface | $serializer | Экземпляр SerializerInterface |
__construct(string $rootNodeName = 'response', int|null $loadOptions = null)
Создаёт новый XmlEncoder и позволяет изменить имя корневого узла.
Параметры
| string | $rootNodeName | |
| int|null | $loadOptions | Битовое поле констант LIBXML_* |
scalar encode(mixed $data, string $format, array $context = array())
Кодирует данные в указанный формат.
Параметры
| mixed | $data | Данные для кодирования |
| string | $format | Имя формата |
| array | $context | Опции, доступные нормализаторам/кодировщикам |
Возвращаемое значение
| scalar |
Исключения
| UnexpectedValueException |
mixed decode(string $data, string $format, array $context = array())
Декодирует строку в данные PHP.
Параметры
| string | $data | Данные для декодирования |
| string | $format | Имя формата |
| array | $context | Опции, доступные декодерам Параметр format указывает, в каком формате находятся данные; допустимые значения зависят от конкретной реализации. Авторы, реализующие этот интерфейс, должны документировать поддерживаемые форматы в комментариях phpdoc. |
Возвращаемое значение
| mixed |
Исключения
| UnexpectedValueException |
bool supportsEncoding(string $format)
Проверяет, может ли сериализатор закодировать в данный формат.
Параметры
| string | $format | имя формата |
Возвращаемое значение
| bool |
bool supportsDecoding(string $format)
Проверяет, может ли десериализатор декодировать из данного формата.
Параметры
| string | $format | имя формата |
Возвращаемое значение
| bool |
setRootNodeName(string $name)
Устанавливает имя корневого узла.
Параметры
| string | $name | имя корневого узла |
string getRootNodeName()
Возвращает имя корневого узла.
Возвращаемое значение
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Serializer/Encoder/XmlEncoder.html