dbrisinajumi/array2xml

Array -> XML Converter Class

[PHP] Array to XML

Array2xml is a PHP library that converts array to valid XML., _(*1)

Based on XMLWriter., _(*2)

Requirements

• PHP 5.3+
• XMLWriter

Installation

require_once ('/path/to/array2xml.php');

Usage (Ex.: RSS Last News)

Load the library and set custom configuration:, _(*3)

$array2xml = new Array2xml();
$array2xml->setRootName('rss');
$array2xml->setRootAttrs(array('version' => '2.0'));
$array2xml->setCDataKeys(array('description'));

Start by creating a root element:, _(*4)

$data['channel']['title']        = 'News RSS';
$data['channel']['link']         = 'http://yoursite.com/';
$data['channel']['description']  = 'Amazing RSS News';
$data['channel']['language']     = 'en';

Now pass elements from DB query in cycle:, _(*5)

$row = $db->lastNews();
foreach($row as $key => $lastNews)
{
    $data['channel'][$key]['item']['title']       = $lastNews->title;
    $data['channel'][$key]['item']['link']        = 'http://yoursite.com/news/'.$lastNews->url;
    $data['channel'][$key]['item']['description'] = $lastNews->description;
    $data['channel'][$key]['item']['pubDate']     = date(DATE_RFC1123, strtotime($lastNews->added));
}

You can also set element attributes individually. The example below appends an attribute AttributeName to item node:, _(*6)

$data['channel'][$key]['item']['@attributes']       = array('AttributeName' => $attributeValue);

Or, if your node doesn't have children, you can use this:, _(*7)

$data['channel]['@attributes'] = array('AttributeName' => $attributeValue);
$data['channel]['@content']    = 'Content of channel node';

This will set both attributes and the content of channel node., _(*8)

Alternatively, you can use setElementsAttrs() method:, _(*9)

$array2xml->setElementsAttrs( array('ElementName' => array('AttributeName' => $attributeValue) ));

Note that in this case all elements with specified names will have identical attribute names and values., _(*10)

If you need to include a raw XML tree somewhere, mark it's element using $array2xml->setRawKeys(array('elementName')), _(*11)

Finally, convert and print output data to screen, _(*12)

echo $array2xml->convert($data);

Configuration

You can easily configure this lib to fit your specific use case using setters described below., _(*13)

setVersion(string $version)

Sets XML version header., _(*14)

setEncoding(string $encoding)

Sets XML encoding, _(*15)

setRootName(string $rootName)

Set XML Root Element Name, _(*16)

setRootAttrs(array $rootAttrs)

Set XML Root Element Attributes, _(*17)

setElementsAttrs(array $attrs)

Set Attributes of every XML Elements that matches the given names. Example argument: ['elementName' => ['someAttr' => 'attrValue']], _(*18)

setCDataKeys(array $elementNames)

Marking given elements as CData ones, _(*19)

setRawKeys(array $elementNames)

Marking given elements as raw ones, _(*20)

setNumericTagPrefix(string $prefix)

Set default prefix for numeric nodes, _(*21)

setSkipNumeric(bool $skipNumeric)

On/Off Skip numeric nodes, _(*22)

setEmptyElementSyntax(const)

In some cases you might want to control the exact syntax of empty elements., _(*23)

By default, nodes that are empty or equal to null are using self-closing syntax(<foo/>)., _(*24)

You can override this behavior using Array2xml::EMPTY_FULL to force using closing tag(<foo></foo>)., _(*25)

Available agruments are Array2xml::EMPTY_SELF_CLOSING or Array2xml::EMPTY_FULL, _(*26)

setFilterNumbersInTags(bool|array $data)

Remove numbers from element names., _(*27)

Possible args are:, _(*28)

• boolean TRUE to remove numbers from ALL elements
• array contains node names that need filtering.

This is a easy workaround to have identically named elements in your XML built from an array., _(*29)

For example, let's build an XML with 3 image nodes:, _(*30)

//list of our images
$images = array('image1.jpg', 'image3.jpg', 'image3.jpg');
// input array
$data = array(); 
for($i=0;$i<3;$i++){
    $data['image'.$i] = $images[$i];
}
$array2xml = new array2xml();
$array2xml->setFilterNumbersInTags(array('image'));

$xml = array2xml->convert($data);

That's it! Now we have a nasty XML with 3 identically named nodes in it., _(*31)

Testing

phpunit Tests/Array2xmlTest.php