/array-to-xml

A simple class to convert an array to xml

Primary LanguagePHPMIT LicenseMIT

Convert an array to xml

Latest Version Software License Build Status Quality Score Total Downloads

This package provides a very simple class to convert an array to an xml string.

Install

You can install this package via composer.

composer require spatie/array-to-xml

Usage 1

use Spatie\ArrayToXml\ArrayToXml;
...
$array = [
    'Good guy' => [
        '_attributes' => ['attr1' => 'value']
        'name' => 'Luke Skywalker',
        'weapon' => 'Lightsaber'
    ],
    'Bad guy' => [
        'name' => 'Sauron',
        'weapon' => 'Evil Eye'
    ]
];

$result = ArrayToXml::convert($array);

After running this piece of code $result will contain:

<?xml version="1.0"?>
<root>
    <Good_guy attr1="value">
        <name>Luke Skywalker</name>
        <weapon>Lightsaber</weapon>
    </Good_guy>
    <Bad_guy>
        <name>Sauron</name>
        <weapon>Evil Eye</weapon>
    </Bad_guy>
</root>

Usage 2

use Spatie\ArrayToXml\ArrayToXml;
...
$array = [
    'user' => 
        [
            'alpha', 
            [
                '_attributes'=> [
                    'type'=>'admin'
                ],
                '_value'=>'beta'
            ]
            , 'gamma'
        ]
];

$result = ArrayToXml::convert($array);

After running this piece of code $result will contain:

<?xml version="1.0"?>
<root>
  <user>alpha</user>
  <user type="admin">beta</user>
  <user>gamma</user>
</root>

Optionally you can set the name of the rootElement by passing it as the second argument. If you don't specify this argument (or set it to an empty string) "root" will be used.

$result = ArrayToXml::convert($array, 'customrootname');

By default all spaces in the key names of your array will be converted to underscores. If you want to opt out of this behaviour you can set the third argument to false. We'll leave all keynames alone.

$result = ArrayToXml::convert($array, 'customrootname', false);

If your input contains something that cannot be parsed a DOMException will be thrown.

Testing

vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.