Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aydinhassan/xmlfuse
A Small library for merging scalar data from multiple XPaths. Similar to an SQL Join, but using XML.
https://github.com/aydinhassan/xmlfuse
Last synced: 1 day ago
JSON representation
A Small library for merging scalar data from multiple XPaths. Similar to an SQL Join, but using XML.
- Host: GitHub
- URL: https://github.com/aydinhassan/xmlfuse
- Owner: AydinHassan
- License: mit
- Created: 2014-07-05T14:05:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-07-31T12:11:30.000Z (about 9 years ago)
- Last Synced: 2024-04-20T16:42:02.965Z (6 months ago)
- Language: PHP
- Homepage:
- Size: 195 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
XmlFuse
=======
[](https://travis-ci.org/AydinHassan/XmlFuse)
[](https://coveralls.io/r/AydinHassan/XmlFuse)
[](https://scrutinizer-ci.com/g/AydinHassan/XmlFuse/?branch=master)
[](https://packagist.org/packages/aydin-hassan/xml-fuse)
[](https://packagist.org/packages/aydin-hassan/xml-fuse)
A Small library for merging scalar data from multiple XPaths's. Similar to an SQL Join, but using XML.
This library is useful if you want to convert XML data into a flat format. This is useful for a source agnostic approach. For example, you may process data from multiple source but want to normalise them all to a similar format.
This library aims to convert 3 dimensional data in to a flat array. Take the following XML as an example:
```xml
01
[email protected]
1
2
despatched
5
1
despatched
```
Imagine an import which updates the status of each item associated with an order. The import only accepts a flat array of data and can only process one item at a time. In order to update the status of an Item, the import must also know the order ID in order to load it and interact with its items.
We could use an xpath to loop each order item like so: `//order/lines/line` and this would give us all the item information, but we still don't have the order ID in the data. What if we could get the data like so:
```php
array(2) {
[0] =>
array(5) {
'orderId' => string(2) "01"
'customerEmail' => string(19) "[email protected]"
'id' => string(1) "1"
'qty' => string(1) "2"
'status' => string(10) "despatched"
}
[1] =>
array(5) {
'orderId' => string(2) "01"
'customerEmail' => string(19) "[email protected]"
'id' => string(1) "5"
'qty' => string(1) "1"
'status' => string(10) "despatched"
}
}
```
This data structure is each of the nodes within each `` embedded with the parent node's data. We can succesfully pass each of these data structures to our order status updater class, and it has all the data it needs to do its work.
Installation
------------
### Composer
```shell
composer require aydin-hassan/xml-fuse
```
Usage
-----
To use the tool you should instantiate the XmlFuser class, passing in your XML and the XPath's you want to combine. You can then call `parse()` to get an array of records back.
#### Example:
```php
$xml = '
01
[email protected]
1
2
despatched
5
1
despatched
';
$xPaths = [
'//order',
'lines/line'
];
$fuser = new \AydinHassan\XmlFuse\XmlFuse($xml, $xPaths);
$res = $fuser->parse();
var_dump($res);
//Output
array(2) {
[0] =>
array(5) {
'orderId' => string(2) "01"
'customerEmail' => string(19) "[email protected]"
'id' => string(1) "1"
'qty' => string(1) "2"
'status' => string(10) "despatched"
}
[1] =>
array(5) {
'orderId' => string(2) "01"
'customerEmail' => string(19) "[email protected]"
'id' => string(1) "5"
'qty' => string(1) "1"
'status' => string(10) "despatched"
}
}
```
### What's going on?
Each of the XPath's passed in to the parser are processed in the order they are given. So the XML will be loaded and the first XPath search will be performed. This will produce an array of nodes (of which there is one).
Each piece of data in the node, which isn't a nested structure will be moved to an array. So we have: orderId & customerEmail:
```php
[
'orderId' => 1,
'customerEmail' => '[email protected]',
]
```
is skipped because it is a nested structure.
Now from this point, the next XPATH is searched, remember our current position? (). Our second XPath is: `lines/line` this will return an array of nodes.
Now each nodes scalar data (non-nested) is converted to an array. Eg:
```php
[
'id' => '1',
'qty' => '1',
'status' => 'despatched',
]
```
It is then merged with the data from the parent search, the node. Which will leave us with:
```php
[
'orderId' => 1,
'customerEmail' => '[email protected]',
'id' => '1',
'qty' => '1',
'status' => 'despatched',
]
```
This is then repeated for each node.
Notes
-----
1. Any amount of XPaths can be given, if they return no results, then no merging will be done, the parent will be returned instead.
2. You can use the `setXPaths()` method to pass in a new set of XPaths, and call the `parse()` method to reparse the XML.
Contributing & Running Tests
----------------------------
```shell
git clone [email protected]:AydinHassan/XmlFuse.git
cd XmlFuse
composer install
./vendor/bin/phpunit
//make sure you run the lint process aswell
./vendor/bin/phpcs --standard=PSR2 ./src
./vendor/bin/phpcs --standard=PSR2 ./test
```