Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/darkfriend/php5-xml

Generate XML from array. Array to XML. XML encode/decode.
https://github.com/darkfriend/php5-xml

array helper php php5 xml xml-decoder xml-encoder

Last synced: 3 days ago
JSON representation

Generate XML from array. Array to XML. XML encode/decode.

Awesome Lists containing this project

README

        

# PHP5 library for encode/decode xml

``composer require darkfriend/php5-xml``

* Array to XML (``` XML::encode() ```)
* XML to Array (``` XML::decode() ```)

### Other php version
* [Xml encode/decode for php7](https://github.com/darkfriend/php7-xml)

## How to install

```
composer require darkfriend/php5-xml
```

## Array Structure

* elementName - basic example
* @attributes
* `key => value` (array)
* cdata - multiline text
* value - text or tree elements
* elementName - example element with attachments
* @attributes
* `key => value` (array)
* value
* elementName
* @attributes
* `key => value` (array)
* value - text or tree elements
* elementName
* @attributes
* `key => value` (array)
* value - text or tree elements
* elementName - example element with duplicate attachments
* @attributes
* `key => value` (array)
* value
* elementName - duplicate element (array)
* 0
* @attributes
* `key => value` (array)
* value - text or tree elements
* 1
* @attributes
* `key => value` (array)
* value - text or tree elements
* elementName - example element duplicate
* 0
* @attributes
* `key => value` (array)
* value - text or tree elements
* 1
* @attributes
* `key => value` (array)
* value - text or tree elements

### Encode Events

* afterChild - execute function when added child element

## How to use

### Array to XML (encode)

```php
$array = array(
'bar' => 'value bar',
'foo' => 'value foo',
'der' => array(
'@attributes' => array(
'at1' => 'at1val',
'at2' => 'at2val',
),
'cdata' => 'this is long text',
),
'qpo' => array(
'@attributes' => array(
'test1' => 'valTest',
),
'value' => array(
'sub1' => array(
'value' => array(
'sub2'=>'val'
)
),
'multi-sub2' => array(
array(
'@attributes' => array(
'at1' => 'val'
),
'value' => array(
'multi-sub2-sub3' => array(
'value' => 'value multi-sub2'
)
)
),
array(
'value' => 'value multi-sub2'
),
),
),
),
'duplicateElement' => array(
array(
'@attributes' => array(
'atDuplicate1' => 'val'
),
'value' => 'valueDuplicateElement1',
),
array(
'@attributes' => array(
'atDuplicate2' => 'val'
),
'value' => 'valueDuplicateElement2',
),
array(
'@attributes' => array(
'atDuplicate3' => 'val'
),
'value' => array(
'subElement' => 'val'
),
),
)
);

echo \darkfriend\helpers\Xml::encode($array);

// example with use events
\darkfriend\helpers\Xml::encode($array, [
'afterChild' => function($xml, $child, $name, $params) {
// your code
return $child;
},
]);
```

#### Result encode

```xml

value bar
value foo





val


value multi-sub2

value multi-sub2

valueDuplicateElement1
valueDuplicateElement2

val

```

### Xml string to Array (decode)

```php
$xml = '

value bar
value foo





val


value multi-sub2

value multi-sub2

valueDuplicateElement1
valueDuplicateElement2

val

';

var_dump(\darkfriend\helpers\Xml::decode($xml));
```

#### Result decode

```
array(5) {
["bar"]=>
array(1) {
[0]=>
array(1) {
["value"]=>
string(9) "value bar"
}
}
["foo"]=>
array(1) {
[0]=>
array(1) {
["value"]=>
string(9) "value foo"
}
}
["der"]=>
array(1) {
[0]=>
array(2) {
["@attributes"]=>
array(2) {
["at1"]=>
string(6) "at1val"
["at2"]=>
string(6) "at2val"
}
["value"]=>
string(17) "this is long text"
}
}
["qpo"]=>
array(1) {
[0]=>
array(2) {
["@attributes"]=>
array(1) {
["test1"]=>
string(7) "valTest"
}
["value"]=>
array(2) {
["sub1"]=>
array(1) {
[0]=>
array(1) {
["value"]=>
string(0) ""
}
}
["multi-sub2"]=>
array(2) {
[0]=>
array(1) {
["@attributes"]=>
array(1) {
["at1"]=>
string(3) "val"
}
}
[1]=>
array(1) {
["value"]=>
string(16) "value multi-sub2"
}
}
}
}
}
["duplicateElement"]=>
array(3) {
[0]=>
array(2) {
["@attributes"]=>
array(1) {
["atDuplicate1"]=>
string(3) "val"
}
["value"]=>
string(22) "valueDuplicateElement1"
}
[1]=>
array(2) {
["@attributes"]=>
array(1) {
["atDuplicate2"]=>
string(3) "val"
}
["value"]=>
string(22) "valueDuplicateElement2"
}
[2]=>
array(2) {
["@attributes"]=>
array(1) {
["atDuplicate3"]=>
string(3) "val"
}
["value"]=>
array(1) {
["subElement"]=>
array(1) {
[0]=>
array(1) {
["value"]=>
string(3) "val"
}
}
}
}
}
}
```

### Custom \ attributes and custom \

```php
$array = array(
'bar' => 'value bar',
'foo' => 'value foo',
'der' => array(
'@attributes' => array(
'at1' => 'at1val',
'at2' => 'at2val',
),
'value' => 'this is long text',
),
);

echo \darkfriend\helpers\Xml::encode(
$array,
array(
'root' => '', // custom root element with custom attribute atExample
'prolog' => array(
'attributes' => array(
'version' => '1.0',
'encoding' => 'utf-8',
),
'elements' => array( // additional elements for prolog
/*''*/
' '
),
),
)
);
```

```xml

value bar
value foo
this is long text

```

### Custom root element

```php
$array = array(
'bar' => 'value bar',
'foo' => 'value foo',
'der' => array(
'cdata' => 'this is long text',
'@attributes' => array(
'at1' => 'at1val',
'at2' => 'at2val',
),
)
);

echo \darkfriend\helpers\Xml::encode(
$array,
array(
'root' => '',
)
);
```

```xml

value bar
value foo

```