vaclavvanik / dom-to-array
An easy way to convert DOM Document to PHP array
Installs: 3 658
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- ext-dom: *
This package is auto-updated.
Last update: 2024-09-30 01:16:33 UTC
README
This package provides an easy way to convert DOMDocument to PHP array.
DomToArray
supports attributes, cdata and array like elements.
Main usage is to convert any XML API response to array. DomToArray consumes good old PHP DOMDocument object. XML API responses are strings which could be flawlessly loaded to DOMDocument with vaclavvanik/dom-loader.
Install
You can install this package via composer.
composer require vaclavvanik/dom-to-array
Usage
Simply pass DOMDocument
<?php declare(strict_types=1); use DOMDocument; use VaclavVanik\DomToArray; $doc = new DOMDocument(); $doc->loadXML('<root/>'); $result = DomToArray::toArray($doc); // $result = ['root' => ''];
Array elements
Multiple elements with same name will create multidimensional array.
<root> <name>guy collection</name> <good_guy> <name>Luke Skywalker</name> <weapon>Lightsaber</weapon> </good_guy> <good_guy> <name>Gandalf</name> <weapon>Staff</weapon> </good_guy> <bad_guy> <name>Saruman</name> <weapon>Staff</weapon> </bad_guy> <bad_guy> <name>Sauron</name> <weapon>Ring</weapon> </bad_guy> </root>
This will result in:
$result = [ 'root' => [ 'name' => 'guy collection', 'good_guy' => [ [ 'name' => 'Luke Skywalker', 'weapon' => 'Lightsaber', ], [ 'name' => 'Gandalf', 'weapon' => 'Staff', ], ], 'bad_guy' => [ [ 'name' => 'Saruman', 'weapon' => 'Staff', ], [ 'name' => 'Sauron', 'weapon' => 'Ring', ], ], ], ];
Attributes
Element attributes create key => value like element_name@attribute_name
=> attribute_value
<root attr="val"> <single type="any"/> <collection type="any1"/> <collection type="any2"/> <author lang="English">Tolkien</author> <guy lang="Black Speech"> <name weapon="Ring">Sauron</name> <weapon>Ring</weapon> </guy> <guy lang="Elvish"> <name weapon="Staff">Gandalf</name> <weapon>Staff</weapon> </guy> <bad_guy lang="Unknown"> <name weapon="Staff">Saruman</name> <name weapon="Ring">Sauron</name> </bad_guy> </root>
This will result in:
$result = [ 'root' => [ 'single' => '', 'single@type' => 'any', 'collection' => [ ['collection@type' => 'any1'], ['collection@type' => 'any2'], ], 'author' => 'Tolkien', 'author@lang' => 'English', 'guy' => [ [ 'name' => 'Sauron', 'name@weapon' => 'Ring', 'weapon' => 'Ring', 'guy@lang' => 'Black Speech', ], 'name' => 'Gandalf', 'name@weapon' => 'Staff', 'weapon' => 'Staff', 'guy@lang' => 'Elvish', ], ], 'bad_guy' => [ [ 'name' => 'Saruman', 'name@weapon' => 'Staff', ], [ 'name' => 'Sauron', 'name@weapon' => 'Ring', ], ], 'bad_guy@lang' => 'Unknown', ], 'root@attr' => 'val', ];
Cdata
Cdata are convert same as element text content.
<root> <good_guy> <name><![CDATA[<h1>Gandalf</h1>]]></name> <weapon>Staff</weapon> </good_guy> </root>
This will result in:
$result = [ 'root' => [ 'good_guy' => [ 'name' => '<h1>Gandalf</h1>', 'weapon' => 'Staff', ], ], ];
DomOptions
Sometimes it is useful to work only with elements (attributes are not needed).
<?php declare(strict_types=1); use DOMDocument; use VaclavVanik\DomToArray; $domOptions = DomOptions::fromArray([DomOptions::SKIP_ATTRIBUTES => true]); $result = DomToArray::toArrayWithOptions($doc, $domOptions);
<root attr="val"> <single type="any"/> <collection type="any1"/> <collection type="any2"/> <author lang="English">Tolkien</author> <guy lang="Black Speech"> <name weapon="Ring">Sauron</name> <weapon>Ring</weapon> </guy> <guy lang="Elvish"> <name weapon="Staff">Gandalf</name> <weapon>Staff</weapon> </guy> <bad_guy lang="Unknown"> <name weapon="Staff">Saruman</name> <name weapon="Ring">Sauron</name> </bad_guy> </root>
This will result in:
$result = [ 'root' => [ 'single' => '', 'collection' => ['', ''], 'author' => 'Tolkien', 'guy' => [ [ 'name' => 'Sauron', 'weapon' => 'Ring', ], [ 'name' => 'Gandalf', 'weapon' => 'Staff', ], ], 'bad_guy' => [ 'name' => ['Saruman', 'Sauron'], ], ], ];
Run check - coding standards and php-unit
Install dependencies:
make install
Run check:
make check
Changelog
Please see CHANGELOG for more information what has changed recently.
License
The MIT License (MIT). Please see License File for more information.