Класс Xml

_createChild(array<string, mixed> $data): void

Вспомогательный метод для _fromArray(). Он создаёт дочерние элементы массивов.

Параметры

Возвращает

_fromArray(DOMDocument $dom, DOMDocumentDOMElement $node, array $data, string $format): void

Рекурсивный метод для создания дочерних элементов из массива.

Параметры

Возвращает

Исключения

_loadXml(string $input, array<string, mixed> $options): SimpleXMLElementDOMDocument

Парсинг входных данных и создание объекта SimpleXmlElement или DOMDocument.

Параметры

Возвращает

Исключения

_toArray(SimpleXMLElement $xml, array<string, mixed> $parentData, string $ns, array<string> $namespaces): void

Рекурсивный метод для преобразования в массив.

Параметры

Возвращает

build(object|array|string $input, array<string, mixed> $options = []): SimpleXMLElementDOMDocument

Инициализация SimpleXMLElement или DOMDocument из заданной XML-строки, пути к файлу, URL или массива.

Использование:

Создание XML из строки:

$xml = Xml::build('<example>text</example>');

Создание XML из строки (вывод DOMDocument):

$xml = Xml::build('<example>text</example>', ['return' => 'domdocument']);

Создание XML из пути к файлу:

$xml = Xml::build('/path/to/an/xml/file.xml');

Создание XML из удалённого URL:

use Cake\Http\Client;

$http = new Client();
$response = $http->get('http://example.com/example.xml');
$xml = Xml::build($response->body());

Создание из массива:

$value = [
     'tags' => [
         'tag' => [
             [
                 'id' => '1',
                 'name' => 'defect'
             ],
             [
                 'id' => '2',
                 'name' => 'enhancement'
             ]
         ]
     ]
 ];
$xml = Xml::build($value);

При создании XML из массива убедитесь, что есть только один элемент верхнего уровня.

Параметры

• return Может быть 'simplexml' для возврата объекта SimpleXMLElement или 'domdocument' для возврата DOMDocument.
• loadEntities По умолчанию false. Установите в true для включения загрузки <!ENTITY определений. По умолчанию отключено по соображениям безопасности.
• readFile Установите в true для включения чтения файлов. По умолчанию отключено для предотвращения доступа к локальной файловой системе. Включайте этот параметр только тогда, когда входные данные безопасны.
• parseHuge Включить флаг LIBXML_PARSEHUGE.

Если используется массив в качестве входных данных, можно передать options из Xml::fromArray.

Параметры

Возвращает

Исключения

fromArray(object|array $input, array<string, mixed> $options = []): SimpleXMLElementDOMDocument

Преобразование массива в SimpleXMLElement.

Параметры

• format Если создавать дочерние элементы ('tags') или атрибуты ('attributes').
• pretty Возвращает отформатированный XML, если установлено в true. По умолчанию false.
• version Версия XML-документа. По умолчанию 1.0.
• encoding Кодировка XML-документа. Если null, удаляет из заголовка XML. По умолчанию - кодировка приложения.
• return Возвращать объект SimpleXMLElement ('simplexml') или DOMDocument ('domdocument'). По умолчанию SimpleXMLElement.

Используя следующие данные:

$value = [
   'root' => [
       'tag' => [
           'id' => 1,
           'value' => 'defect',
           '@' => 'description'
        ]
    ]
];

Вызов Xml::fromArray($value, 'tags'); сгенерирует:

<root><tag><id>1</id><value>defect</value>description</tag></root>

И вызов Xml::fromArray($value, 'attributes'); сгенерирует:

<root><tag id="1" value="defect">description</tag></root>

Параметры

Возвращает

Исключения

load(string $input, array<string, mixed> $options, Closure $callable): SimpleXMLElementDOMDocument

Парсинг входных данных и создание объекта SimpleXmlElement или DOMDocument.

Параметры

Возвращает

Исключения

loadHtml(string $input, array<string, mixed> $options = []): SimpleXMLElementDOMDocument

Парсинг входной HTML-строки и создание объекта SimpleXmlElement или DOMDocument.

Параметры

Возвращает

Исключения

toArray(SimpleXMLElementDOMDocumentDOMNode $obj): array

Возвращает эту XML-структуру в виде массива.

Параметры

Возвращает

Исключения