\Cake\UtilityXml

build()

build(string|array  $input, array  $options = array()) : \SimpleXMLElement|\DOMDocument

Initialize SimpleXMLElement or DOMDocument from a given XML string, file path, URL or array.

Usage:

Building XML from a string:

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

Building XML from string (output DOMDocument):

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

Building XML from a file path:

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

Building XML from a remote URL:

use Cake\Http\Client;

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

Building from an array:

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

When building XML from an array ensure that there is only one top level element.

Options

• return Can be 'simplexml' to return object of SimpleXMLElement or 'domdocument' to return DOMDocument.
• loadEntities Defaults to false. Set to true to enable loading of <!ENTITY definitions. This is disabled by default for security reasons.
• readFile Set to false to disable file reading. This is important to disable when putting user data into Xml::build(). If enabled local files will be read if they exist. Defaults to true for backwards compatibility reasons.
• parseHuge Enable the LIBXML_PARSEHUGE flag.

If using array as input, you can pass options from Xml::fromArray.

Parameters

Throws

\Cake\Utility\Exception\XmlException

Returns

SimpleXMLElement or DOMDocument

loadHtml()

loadHtml(string  $input, array  $options = array()) : \SimpleXMLElement|\DOMDocument

Parse the input html string and create either a SimpleXmlElement object or a DOMDocument.

Parameters

Throws

\Cake\Utility\Exception\XmlException

Returns

fromArray()

fromArray(array|\Cake\Collection\Collection  $input, string|array  $options = array()) : \SimpleXMLElement|\DOMDocument

Transform an array into a SimpleXMLElement

Options

• format If create childs ('tags') or attributes ('attributes').
• pretty Returns formatted Xml when set to true. Defaults to false
• version Version of XML document. Default is 1.0.
• encoding Encoding of XML document. If null remove from XML header. Default is the some of application.
• return If return object of SimpleXMLElement ('simplexml') or DOMDocument ('domdocument'). Default is SimpleXMLElement.

Using the following data:

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

Calling Xml::fromArray($value, 'tags'); Will generate:

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

And calling Xml::fromArray($value, 'attributes'); Will generate:

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

Parameters

Throws

\Cake\Utility\Exception\XmlException

Returns

SimpleXMLElement or DOMDocument

toArray()

toArray(\SimpleXMLElement|\DOMDocument|\DOMNode  $obj) : array

Returns this XML structure as an array.

Parameters

Throws

\Cake\Utility\Exception\XmlException

Returns

Array representation of the XML structure.

_loadXml()

_loadXml(string  $input, array  $options) : \SimpleXMLElement|\DOMDocument

Parse the input data and create either a SimpleXmlElement object or a DOMDocument.

Parameters

Throws

\Cake\Utility\Exception\XmlException

Returns

_fromArray()

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

Recursive method to create childs from array

Parameters

Throws

\Cake\Utility\Exception\XmlException

_createChild()

_createChild(array  $data) : void

Helper to _fromArray(). It will create childs of arrays

Parameters

_toArray()

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

Recursive method to toArray

Parameters