Spec-Zone.ru › Symfony 4.1

XmlEncoder

class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface, SerializerAwareInterface

Кодирует данные XML.

Свойства

SerializerAwareTrait Свойство SerializerAware.

Константы

FORMAT

Свойства

protected SerializerInterface $serializer из SerializerAwareTrait

Методы

setSerializer(SerializerInterface $serializer)

Устанавливает сериализатор.

из SerializerAwareTrait
__construct(string $rootNodeName = 'response', int $loadOptions = null, array $ignoredNodeTypes = array(XML_PI_NODE, XML_COMMENT_NODE))

Создаёт новый XmlEncoder и позволяет изменить имя корневого узла.

string|int|float|bool 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()

Возвращает имя корневого узла.

bool appendXMLString(DOMNode $node, string $val)
bool appendText(DOMNode $node, string $val)
bool appendCData(DOMNode $node, string $val)
bool appendDocumentFragment(DOMNode $node, DOMDocumentFragment $fragment)
bool isElementNameValid(string $name)

Проверяет, является ли имя допустимым именем XML-элемента.

Детали

setSerializer(SerializerInterface $serializer)

Устанавливает сериализатор.

Параметры

SerializerInterface $serializer Экземпляр SerializerInterface

__construct(string $rootNodeName = 'response', int $loadOptions = null, array $ignoredNodeTypes = array(XML_PI_NODE, XML_COMMENT_NODE))

Создаёт новый XmlEncoder и позволяет изменить имя корневого узла.

Параметры

строка $rootNodeName
целое $loadOptions
массив $ignoredNodeTypes

string|int|float|bool encode(mixed $data, string $format, array $context = array())

Кодирует данные в заданном формате.

Параметры

смешанный $data Данные для кодирования
строка $format Имя формата
массив $context Параметры, доступные нормализаторам/кодировщикам

Возвращаемое значение

строка|целое|вещественное|логическое

Исключения

UnexpectedValueException

mixed decode(string $data, string $format, array $context = array())

Декодирует строку в данные PHP.

Параметры

строка $data Данные для декодирования
строка $format Имя формата
массив $context Параметры, доступные декодерам

Параметр format указывает, в каком формате находятся данные; допустимые значения зависят от конкретной реализации. Авторам, реализующим этот интерфейс, рекомендуется документировать поддерживаемые форматы в комментарии phpdoc, не являющемся унаследованным.

Возвращаемое значение

смешанный

Исключения

UnexpectedValueException

bool supportsEncoding(string $format)

Проверяет, может ли сериализатор кодировать в заданном формате.

Параметры

строка $format Имя формата

Возвращаемое значение

логическое

bool supportsDecoding(string $format)

Проверяет, может ли десериализатор декодировать из заданного формата.

Параметры

строка $format Имя формата

Возвращаемое значение

логическое

setRootNodeName(string $name)

Устанавливает имя корневого узла.

Параметры

строка $name Имя корневого узла

string getRootNodeName()

Возвращает имя корневого узла.

Возвращаемое значение

строка

final protected bool appendXMLString(DOMNode $node, string $val)

Параметры

DOMNode $node
строка $val

Возвращаемое значение

логическое

final protected bool appendText(DOMNode $node, string $val)

Параметры

DOMNode $node
строка $val

Возвращаемое значение

логическое

final protected bool appendCData(DOMNode $node, string $val)

Параметры

DOMNode $node
строка $val

Возвращаемое значение

логическое

final protected bool appendDocumentFragment(DOMNode $node, DOMDocumentFragment $fragment)

Параметры

DOMNode $node
DOMDocumentFragment $fragment

Возвращаемое значение

логическое

final protected bool isElementNameValid(string $name)

Проверяет, является ли имя допустимым именем XML-элемента.

Параметры

строка $name

Возвращаемое значение

логическое

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Serializer/Encoder/XmlEncoder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API