Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergiorodenas/stream-parser
⚡ PHP7 / Laravel Multi-format Streaming Parser
https://github.com/sergiorodenas/stream-parser
collections csv json laravel parser php streaming xml
Last synced: about 1 month ago
JSON representation
⚡ PHP7 / Laravel Multi-format Streaming Parser
- Host: GitHub
- URL: https://github.com/sergiorodenas/stream-parser
- Owner: sergiorodenas
- License: mit
- Created: 2018-05-15T22:07:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T02:17:11.000Z (9 months ago)
- Last Synced: 2024-08-04T09:08:29.347Z (5 months ago)
- Topics: collections, csv, json, laravel, parser, php, streaming, xml
- Language: PHP
- Homepage:
- Size: 64.5 KB
- Stars: 438
- Watchers: 13
- Forks: 45
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# ⚡ PHP7 / Laravel Multi-format Streaming Parser
[](https://scrutinizer-ci.com/g/Rodenastyle/stream-parser/build-status/master)
[](https://packagist.org/packages/rodenastyle/stream-parser)
[](https://scrutinizer-ci.com/g/Rodenastyle/stream-parser/?branch=master)
[](https://scrutinizer-ci.com/g/Rodenastyle/stream-parser/?branch=master)
[](https://packagist.org/packages/Rodenastyle/stream-parser)
> When it comes to parsing XML/CSV/JSON/... documents, there are 2 approaches to consider:
>
> **DOM loading**: loads all the document, making it easy to navigate and parse, and as such provides maximum flexibility for developers.
>
> **Streaming**: implies iterating through the document, acts like a cursor and stops at each element in its way, thus avoiding memory overkill.
>
> [https://www.linkedin.com/pulse/processing-xml-documents-dom-vs-streaming-marius-ilina/](https://www.linkedin.com/pulse/processing-xml-documents-dom-vs-streaming-marius-ilina)
Thus, when it comes to big files, callbacks will be executed meanwhile file is downloading and will be much more efficient as far as memory is concerned.
## Installation
```
composer require rodenastyle/stream-parser
```
## Recommended usage
Delegate as possible the callback execution so it doesn't blocks the document reading:
(Laravel Queue based example)
```php
use Illuminate\Support\Collection;
StreamParser::xml("https://example.com/users.xml")->each(function(Collection $user){
dispatch(new App\Jobs\SendEmail($user));
});
```
## Practical Input/Code/Output demos
### XML
```xml
The Iliad and The Odyssey
12.95
Best translation I've read.
I like other versions better.
[...]
```
```php
use Illuminate\Support\Collection;
StreamParser::xml("https://example.com/books.xml")->each(function(Collection $book){
var_dump($book);
var_dump($book->get('comments')->toArray());
});
```
```
class Tightenco\Collect\Support\Collection#19 (1) {
protected $items =>
array(4) {
'ISBN' =>
string(13) "10-000000-001"
'title' =>
string(25) "The Iliad and The Odyssey"
'price' =>
string(5) "12.95"
'comments' =>
class Tightenco\Collect\Support\Collection#17 (1) {
protected $items =>
array(2) {
...
}
}
}
}
array(2) {
[0] =>
array(2) {
'rating' =>
string(1) "4"
'userComment' =>
string(27) "Best translation I've read."
}
[1] =>
array(2) {
'rating' =>
string(1) "2"
'userComment' =>
string(29) "I like other versions better."
}
}
```
Additionally, you could make use of ```->withSeparatedParametersList()``` to get the params of each element separated on the ```__params``` property.
Also, ```->withoutSkippingFirstElement()``` could be of help to parse the very first item (usually the element that contains the elements).
### JSON
```json
[
{
"title": "The Iliad and The Odyssey",
"price": 12.95,
"comments": [
{"comment": "Best translation I've read."},
{"comment": "I like other versions better."}
]
},
{
"title": "Anthology of World Literature",
"price": 24.95,
"comments": [
{"comment": "Needs more modern literature."},
{"comment": "Excellent overview of world literature."}
]
}
]
```
```php
use Illuminate\Support\Collection;
StreamParser::json("https://example.com/books.json")->each(function(Collection $book){
var_dump($book->get('comments')->count());
});
```
```
int(2)
int(2)
```
### CSV
```csv
title,price,comments
The Iliad and The Odyssey,12.95,"Best translation I've read.,I like other versions better."
Anthology of World Literature,24.95,"Needs more modern literature.,Excellent overview of world literature."
```
```php
use Illuminate\Support\Collection;
StreamParser::csv("https://example.com/books.csv")->each(function(Collection $book){
var_dump($book->get('comments')->last());
});
```
```
string(29) "I like other versions better."
string(39) "Excellent overview of world literature."
```
## License
This library is released under [MIT](http://www.tldrlegal.com/license/mit-license) license.