Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gyselroth/php-stream-iterator
PSR-7 compatible stream wrapper for iterators
https://github.com/gyselroth/php-stream-iterator
php psr-7 stream
Last synced: 4 days ago
JSON representation
PSR-7 compatible stream wrapper for iterators
- Host: GitHub
- URL: https://github.com/gyselroth/php-stream-iterator
- Owner: gyselroth
- License: mit
- Created: 2018-10-24T12:28:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-03T14:05:32.000Z (almost 5 years ago)
- Last Synced: 2024-09-23T09:09:13.846Z (about 2 months ago)
- Topics: php, psr-7, stream
- Language: PHP
- Homepage:
- Size: 2.82 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# php-stream-iterator
[](https://travis-ci.org/gyselroth/php-stream-iterator)
[](https://raw.githubusercontent.com/gyselroth/php-stream-iterator/master/LICENSE)
[](https://scrutinizer-ci.com/g/gyselroth/php-stream-iterator)
[](https://scrutinizer-ci.com/g/gyselroth/php-stream-iterator/?branch=master)
[](https://github.com/gyselroth/php-stream-iterator/releases)
[](https://packagist.org/packages/gyselroth/stream-iterator)
\StreamIterator\StreamIterator provides a fully PSR-7 compatible stream wrapper for an interator.
You may also pass a callback which handles each yielded iterator entry.
\StreamIterator is also nicely useable on blocking iterators and/or to create realtime stream responses.
# Requirements
* The minimum supported PHP version is 5.6
* The library depends on the following external PHP libraries:
* psr/http-message (^1.0)
# Installation
The package is available at packagist an can be installed via composer:
```
composer require gyselroth/stream-iterator
```
## Documentation
The examples use a simple ArrayIterator, of course you may use any kind of traversable object.
### Read the whole iterator
```php
$my_iterator = new \ArrayIterator([0,1,2,3,4,5]);
$stream = new \StreamIterator\StreamIterator($my_iterator);
$contents = $stream->getContents();
echo $contents; //Prints 012345
```
### Using a callback
Using a callback enables us to operate on each of the yielded iterator elements:
```php
$my_iterator = new \ArrayIterator([0,1,2,3,4,5]);
$stream = new \StreamIterator\StreamIterator($my_iterator, function($item) {
return '-'.$item;
})
$contents = $stream->getContents();
echo $contents; //Prints -0-1-2-3-4-5
```
### JSON stream example
In this example we create a json output from the example iterator:
```php
$my_iterator = new \ArrayIterator([['foo' => 'bar'], ['foo' => 'bar']]);
$stream = new \StreamIterator\StreamIterator($my_iterator, function($item) {
if($this->tell() === 0) {
$string = '[';
} else {
$string = ',';
}
$string .= json_encode($item);
if($this->eof()) {
$string .= ']';
}
return $string;
})
$contents = $stream->getContents();
echo $contents; //Prints [{"foo":"bar"},{"foo":"bar"}]
```
### (JSON) stream without buffer
This enables a realtime json stream of an iterator. This also allows to operate on blocking iterators
where \Iterator::next() blocks until a new entry gets yielded. Each iterator item gets printed as soon as it arrives.
>**Note** Some web server have output buffers or gzip enabled, this will not work with a realtime stream. Be sure
that all buffers are completely disabled (For endpoints where a realtime stream is used). For example if you are using Nginx and PHP-FPM you will most likely need
to send a header `header('X-Accel-Buffering', 'no')` to disable the fastcgi nginx buffer. Otherwise nginx will buffer your output.
```php
$my_iterator = new \ArrayIterator([['foo' => 'bar'], ['foo' => 'bar']]);
$stream = new \StreamIterator\StreamIterator($my_iterator, function($item) {
if($this->tell() === 0) {
$string = '[';
} else {
$string = ',';
}
$string .= json_encode($item);
if($this->eof()) {
$string .= ']';
}
echo $string;
flush();
return '';
})
$contents = $stream->getContents(); //Prints [{"foo":"bar"},{"foo":"bar"}]
echo $contents; //Prints "" (Empty string)
```
## Changelog
A changelog is available [here](https://github.com/gyselroth/php-stream-iterator/CHANGELOG.md).
## Contribute
We are glad that you would like to contribute to this project. Please follow the given [terms](https://github.com/gyselroth/php-stream-iterator/blob/master/CONTRIBUTING.md).
## Thanks
This projects use ideas provided by Matthew Weier O'Phinney [phly/psr7examples](https://github.com/phly/psr7examples).