Spec-Zone.ru › CakePHP 2.7

Класс Xml

Обработка XML для CakePHP.

Методы в этих классах позволяют работать с источниками данных, использующими XML.

Пакет: Cake\Утилиты
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение Cake/Utility/Xml.php

Подробное описание методов

_createChildисходный код protected static

_createChild( array $data )

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

Параметры

массив $data
Массив с информацией для создания дочерних элементов

_fromArrayисходный код protected static

_fromArray( DOMDocument $dom , DOMElement $node , array $data , string $format )

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

Параметры

DOMDocument $dom
Обработчик DOMDocument
DOMElement $node
Обработчик DOMElement (дочерний)
массив $data
$data Массив данных, которые нужно добавить в узел $node.
строка $format
Либо 'attributes', либо 'tags'. Это определяет, куда помещаются вложенные ключи.

Исключения

XmlException
XmlException

_loadXmlисходный код protected static

_loadXml( string $input , array $options )

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

Параметры

строка $input
Входные данные для загрузки.
массив $options
Параметры для использования. См. Xml::build()

Возвращает

SimpleXmlElement|DOMDocument
SimpleXmlElement|DOMDocument

Исключения

XmlException
XmlException

_toArrayисходный код protected static

_toArray( SimpleXMLElement $xml , array $parentData , string $ns , array $namespaces )

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

Параметры

SimpleXMLElement $xml
Объект SimpleXMLElement
массив $parentData
$parentData Родительский массив с данными
строка $ns
Пространство имен текущего дочернего элемента
массив $namespaces
Список пространств имен в XML

buildисходный код public static

build( string|array $input , array $options array() )

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

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

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

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

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

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

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

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

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

$xml = Xml::build('http://example.com/example.xml');

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

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

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

Параметры

  • return Может быть 'simplexml' для возвращения объекта SimpleXMLElement или 'domdocument' для возвращения DOMDocument.
  • loadEntities По умолчанию false. Установите в true, чтобы разрешить загрузку определений <!ENTITY. Это отключено по умолчанию по соображениям безопасности.
  • readFile Установите в false, чтобы отключить чтение файлов. Это важно отключить, когда вы используете пользовательские данные в Xml::build(). Если включено, локальные и удаленные файлы будут считаны, если они существуют. По умолчанию true для обратной совместимости.
  • Если вы используете массив в качестве входных данных, вы можете передать options из Xml::fromArray.

Параметры

строка|массив $input
XML-строка, путь к файлу, URL или массив
массив $options необязательно массив()
Параметры для использования

Возвращает

SimpleXMLElement|DOMDocument
SimpleXMLElement или DOMDocument

Исключения

XmlException
XmlException

fromArrayисходный код public static

fromArray( array $input , array $options array() )

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

Параметры

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

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

$value = array(
   'root' => array(
       'tag' => array(
           '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>

Параметры

массив $input
Массив с данными
массив $options необязательно массив()
Параметры для использования

Возвращает

SimpleXMLElement|DOMDocument
SimpleXMLElement или DOMDocument

Исключения

XmlException
XmlException

toArrayисходный код public static

toArray( SimpleXMLElement|DOMDocument|DOMNode $obj )

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

Параметры

SimpleXMLElement|DOMDocument|DOMNode $obj
Объект SimpleXMLElement, DOMDocument или DOMNode

Возвращает

array
Представление XML-структуры в виде массива.

Исключения

XmlException
XmlException

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-Xml.html

Spec-Zone.ru

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