XMLBuilder
XMLBuilder copied to clipboard
Published
20 hours ago •
AaronDDM
AaronDDM
A simple PHP XML builder library written for PHP 7.2+
PHP XML Builder Library
This is a simple PHP 7.2+ based XML Builder library. Use it to easily generate XML output with just PHP.
Table of Contents
- PHP XML Builder Library
- Table of Contents
- Installation
- Prerequisites
- Basic Usage
- Example: Using XMLWriter
- Output
- Example: Custom XMLWriter instance
- Output
- Looping through data
- Example: XML output of a list of users
- Output
- Looping without a parent
- Example: XML output of a list of users
- Output
- Using a custom "XMLElementData" class
- Example: Customized MyXMLElementData class
- Output
- Running tests
- License
Installation
composer require aaronddm/xml-builder
Prerequisites
- PHP >=7.2.0
- php-xml if using XMLWriter
Basic Usage
The following is an example of the most basic usage of this library.
Example: Using XMLWriter
<?php
require_once 'vendor/autoload.php';
use AaronDDM\XMLBuilder\XMLBuilder;
use AaronDDM\XMLBuilder\Writer\XMLWriterService;
use AaronDDM\XMLBuilder\Exception\XMLArrayException;
$xmlWriterService = new XMLWriterService();
$xmlBuilder = new XMLBuilder($xmlWriterService);
try {
$xmlBuilder
->createXMLArray()
->start('Root')
->addCData('1 First Child First Element', 'This is a test')
->add('First Child Second Element', false)
->start('Second Parent')
->add('Second child 1', null, ['myAttr' => 'Attr Value'])
->add('Second child 2', false)
->start('Third Parent')
->add('Child')
->end()
->end()
->add('First Child Third Element')
->end();
var_dump($xmlBuilder->getXML());
} catch (XMLArrayException $e) {
var_dump('An exception occurred: ' . $e->getMessage());
}
Output
string(414) "<?xml version="1.0" encoding="UTF-8"?>
<Root>
<FirstChildFirstElement><![CDATA[This is a test]]></FirstChildFirstElement>
<FirstChildSecondElement>False</FirstChildSecondElement>
<SecondParent>
<Secondchild myAttr="Attr Value"/>
<Secondchild>False</Secondchild>
<ThirdParent>
<Child/>
</ThirdParent>
</SecondParent>
<FirstChildThirdElement/>
</Root>
"
Example: Custom XMLWriter instance
<?php
require_once 'vendor/autoload.php';
use AaronDDM\XMLBuilder\XMLBuilder;
use AaronDDM\XMLBuilder\Writer\XMLWriterService;
$xmlWriter = new \XMLWriter();
$xmlWriter->openMemory();
$xmlWriter->setIndent(true);
$xmlWriter->setIndentString(' ');
$xmlWriter->startDocument('1.0', 'UTF-8');
$xmlWriter->writeDtd('html', '-//W3C//DTD XHTML 1.0 Transitional//EN', 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd');
$xmlWriterService = new XMLWriterService($xmlWriter);
$xmlBuilder = new XMLBuilder($xmlWriterService);
try {
$xmlBuilder
->createXMLArray()
->start('Root')
->addCData('1 First Child First Element', 'This is a test')
->add('First Child Second Element', false)
->start('Second Parent')
->add('Second child 1', null, ['myAttr' => 'Attr Value'])
->add('Second child 2', false)
->start('Third Parent')
->add('Child')
->end()
->end()
->add('First Child Third Element')
->end();
var_dump($xmlBuilder->getXML());
} catch (XMLArrayException $e) {
var_dump('An exception occurred: ' . $e->getMessage());
}
Output
string(414) "<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<Root>
<FirstChildFirstElement><![CDATA[This is a test]]></FirstChildFirstElement>
<FirstChildSecondElement>False</FirstChildSecondElement>
<SecondParent>
<Secondchild myAttr="Attr Value"/>
<Secondchild>False</Secondchild>
<ThirdParent>
<Child/>
</ThirdParent>
</SecondParent>
<FirstChildThirdElement/>
</Root>
"
Looping through data
You easily added sets of data using the startLoop method provided.
Example: XML output of a list of users
<?php
require_once 'vendor/autoload.php';
use AaronDDM\XMLBuilder\XMLArray;
use AaronDDM\XMLBuilder\XMLBuilder;
use AaronDDM\XMLBuilder\Writer\XMLWriterService;
$users = [
[
'name' => 'John Doe',
'age' => 32
],
[
'name' => 'Jane Doe',
'age' => 98
]
];
$xmlWriterService = new XMLWriterService();
$xmlBuilder = new XMLBuilder($xmlWriterService);
$xmlBuilder
->createXMLArray()
->start('Root')
->startLoop('Users', [], function (XMLArray $XMLArray) use ($users) {
foreach ($users as $user) {
$XMLArray->start('User')
->add('name', $user['name'])
->add('age', $user['age']);
}
})
->end()
->end();
var_dump($xmlBuilder->getXML());
Output
string(261) "<?xml version="1.0" encoding="UTF-8"?>
<Root>
<Users>
<User>
<name>John Doe</name>
<age>32</age>
</User>
<User>
<name>Jane Doe</name>
<age>98</age>
</User>
</Users>
</Root>
"
Looping without a parent
You easily loop through a list of of data using the loop method provided, without having a parent element for the looped data.
Example: XML output of a list of users
<?php
require_once 'vendor/autoload.php';
use AaronDDM\XMLBuilder\XMLArray;
use AaronDDM\XMLBuilder\XMLBuilder;
use AaronDDM\XMLBuilder\Writer\XMLWriterService;
$users = [
[
'name' => 'John Doe',
'age' => 32
],
[
'name' => 'Jane Doe',
'age' => 98
]
];
$xmlWriterService = new XMLWriterService();
$xmlBuilder = new XMLBuilder($xmlWriterService);
$xmlBuilder
->createXMLArray()
->start('Root')
->loop(function (XMLArray $XMLArray) use ($users) {
foreach ($users as $user) {
$XMLArray->start('User')
->add('name', $user['name'])
->add('age', $user['age']);
}
})
->end();
var_dump($xmlBuilder->getXML());
?>
Output
<Root>
<User>
<name>John Doe</name>
<age>32</age>
</User>
<User>
<name>Jane Doe</name>
<age>98</age>
</User>
</Root>
Using a custom "XMLElementData" class
You can override the XMLElementData element class to implement transformations to the value of your data based on the type passed. To do this, you simply extend the XMLElementData class and override any of the methods to your liking.
Example: Customized MyXMLElementData class
<?php
require_once 'vendor/autoload.php';
use AaronDDM\XMLBuilder\XMLElementData;
use AaronDDM\XMLBuilder\XMLBuilder;
use AaronDDM\XMLBuilder\Writer\XMLWriterService;
use AaronDDM\XMLBuilder\Exception\XMLArrayException;
/**
* Class MyXMLElementData
*/
class MyXMLElementData extends XMLElementData
{
/**
* @return mixed
*/
public function getValue()
{
$type = $this->getType();
$value = $this->value;
if(is_bool($value)) {
$type = 'boolean';
}
switch($type) {
case 'specialType':
$value = 'Special Type Value';
break;
case 'boolean':
$value = ($value) ? 'True' : 'False';
break;
}
return $value;
}
}
$xmlWriterService = new XMLWriterService();
$xmlBuilder = new XMLBuilder($xmlWriterService);
$xmlBuilder->setElementDataClass(MyXMLElementData::class);
try {
$xmlBuilder
->createXMLArray()
->start('Root')
->addCData('1 First Child First Element', 'This is a test')
->add('First Child Second Element', false)
->start('Second Parent')
->add('Second child 1', null, ['myAttr' => 'Attr Value'])
->add('Second child 2', false)
->start('Third Parent')
->add('Child')
->add('Special Type Child', "1", [], 'specialType')
->end()
->end()
->add('First Child Third Element')
->end();
var_dump($xmlBuilder->getXML());
} catch (XMLArrayException $e) {
var_dump('An exception occurred: ' . $e->getMessage());
}
Output
string(482) "<?xml version="1.0" encoding="UTF-8"?>
<Root>
<FirstChildFirstElement><![CDATA[This is a test]]></FirstChildFirstElement>
<FirstChildSecondElement>False</FirstChildSecondElement>
<SecondParent>
<Secondchild myAttr="Attr Value"/>
<Secondchild>False</Secondchild>
<ThirdParent>
<Child/>
<SpecialTypeChild>Special Type Value</SpecialTypeChild>
</ThirdParent>
</SecondParent>
<FirstChildThirdElement/>
</Root>
"
Running tests
cd /root/of/project/
vendor/bin/phpunit
OR
docker build -t xmlbuilder .
docker run -u appuser -it --rm xmlbuilder vendor/bin/phpunit
License
This project is open-sourced software licensed under the MIT license.
AaronDDM