graze / xml-utils
XML utilities, mainly conversion between XML <=> array.
Installs: 16 397
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 12
Forks: 1
Open Issues: 0
Requires
- php: >=5.5
Requires (Dev)
- graze/standards: ^2.0
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-10-24 05:13:20 UTC
README
XML utilities, mainly conversion between XML <=> array.
Install
Via Composer
$ composer require graze/xml-utils
Usage
Converting an array to XML
$array = [ 'child1' => 111, 'child2' => 222 ]; $xmlElement = new SimpleXMLElement('<root/>'); $xmlConverter = new Graze\XmlUtils\XmlConverter(); $xmlConverter->addArrayAsChildren($array, $xmlElement); echo $xmlElement->asXml();
result:
?xml version="1.0"?>
<root><child1>111</child1><child2>222</child2></root>
Attributes
Attributes are supported by using @attributes
key with an array of attribute name => value.
$array = [
'child1' => [
'@attributes' => [
'id' => 123
]
]
];
result:
<child1 id="123"/>
Attributes with value
If a value needs to be set for an element with an attribute then the @value
key should be used.
$array = [
'child1' => [
'@attributes' => [
'id' => 123
],
'@value' => 'some description'
]
];
result:
<child1 id="123">some description</child1>
Repeated elements
Repeated elements are supported with indexed arrays.
$array = [
'child' => [
'first',
'second'
]
];
result:
<child>first</child><child>second</child>
Converting XML to an array
$xml = '<root><child1>123</child1><child2 id="1"><subchild1>456</subchild1></child2></root>';
$xmlElement = new SimpleXMLElement($xml);
$xmlConverter = new XmlConverter();
$array = $xmlConverter->convertToArray($xmlElement);
result:
[
'child1' => '123',
'child2' => [
'@attributes' => [
'id' => '1'
],
'subchild1' => '456'
]
];
Formatting XML
Formats XML so it is easier to read.
$unformattedXml = '<?xml version="1.0" encoding="UTF-8"?><root><child1>123</child1><child2 attribute="1"><subchild1>456</subchild1></child2></root>';
$xmlFormatter = new XmlFormatter();
$formattedXml = $xmlFormatter->format($unformattedXml);
result:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<child1>123</child1>
<child2 attribute="1">
<subchild1>456</subchild1>
</child2>
</root>
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
make build test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email security@graze.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.