multidimensional/dom-array

Create a DOMDocument from an Array.

1.0.1 2019-02-20 05:37 UTC

This package is auto-updated.

Last update: 2024-12-21 21:08:30 UTC


README

Build Status Latest Stable Version Code Coverage Minimum PHP Version License Total Downloads Scrutinizer Code Quality

This library extends the DOMDocument function by adding a loadArray function that converts PHP arrays to DOMDocument classes that can be used to generate XML, HTML and other types of code. This library does the opposite of our XML-Array library which converts XML to a PHP array.

Requirements

  • PHP 5.5+

Installation

The easiest way to install this library is to use composer. To install, simply include the following in your composer.json file:

"require": {
    "multidimensional/dom-array": "*"
}

Or run the following command from a terminal or shell:

composer require --prefer-dist multidimensional/dom-array

You can also specify version constraints, with more information available here.

Usage

This library utilizes PSR-4 autoloading, so make sure you include the library near the top of your class file:

use Multidimensional\DomArray\DOMArray;

How to use in your code:

$dom = new DOMArray('1.0', 'utf-8');
$array = ['item' => ['subitem' => 'true', '@id' => '123']];
$dom->loadArray($array);
$xml = $dom->saveXML();

echo $xml;

/*  <?xml version="1.0" encoding="utf-8"?>
 *  <item id="123">
 *    <subitem>true</subitem>
 *  </item>
 */

As shown in the example, attributes can be assigned by adding an @ symbol before the attribute name.

Null and Empty arrays will generate a DOMDocument with no elements.

Contributing

We appreciate all help in improving this library by either adding functions or improving existing functionality. If you do want to add to our library, please ensure you use PSR-2 formatting and add unit testing for all added functions.

Feel free to fork and submit a pull request!

License

MIT License

Copyright (c) 2017 - 2019 multidimension.al

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.