Spec-Zone.ru › CakePHP 2.8

Класс Xml

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

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

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

Краткое описание методов

  • _createChild() protected static
    Помощник для _fromArray(). Он создаст дочерние элементы массивов.
  • _fromArray() protected static
    Рекурсивный метод для создания дочерних элементов из массива.
  • _loadXml() protected static
    Разбор входных данных и создание объекта SimpleXmlElement или DOMDocument.
  • _toArray() protected static
    Рекурсивный метод для преобразования в массив.
  • build() public static
    Инициализация SimpleXMLElement или DOMDocument из заданной XML-строки, пути к файлу, URL или массива.
  • fromArray() public static
    Преобразование массива в SimpleXMLElement.
  • toArray() public static
    Возвращает эту XML-структуру в виде массива.

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

_createChild()source protected static

_createChild( array $data )

Помощник для _fromArray(). Он создаст дочерние элементы массивов

Параметры

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

_fromArray()source protected static

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

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

Параметры

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

Исключения

XmlException

_loadXml()source protected static

_loadXml( string $input , array $options )

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

Параметры

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

Возвращает

SimpleXmlElement|DOMDocument

Исключения

XmlException

_toArray()source protected static

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

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

Параметры

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

build()source 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');

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

$xml = Xml::build('http://example.com/example.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

fromArray()source 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

toArray()source public static

toArray( SimpleXMLElement|DOMDocument|DOMNode $obj )

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

Параметры

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

Возвращает

массив
Массивная представление XML-структуры.

Исключения

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.8/class-Xml.html

Spec-Zone.ru

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