https://github.com/anon767/php-stream-api
A Java inspired PHP Stream API
https://github.com/anon767/php-stream-api
Last synced: about 2 months ago
JSON representation
A Java inspired PHP Stream API
- Host: GitHub
- URL: https://github.com/anon767/php-stream-api
- Owner: anon767
- Created: 2018-02-01T10:13:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-01T20:44:19.000Z (over 7 years ago)
- Last Synced: 2024-04-24T04:29:56.908Z (about 1 year ago)
- Language: PHP
- Size: 485 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# PHP Stream API
This library is based upon the Stream-Api from Java and the Array-Prototype from Javascript
(https://docs.oracle.com/javase/8/docs/api/?java/util/stream/Stream.html)
(https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
If you like functional patterns, readable code or immutable Datatypes and miss it in PHP, you should definitely give it a try.
## Dependencies
1. PHP >= 5
2. PHPUnit for development
## install
execute
```composer require anon767/phpstream```
or add following to your composer.json
```
"require": {
"anon767/phpstream": "*"
}
```
## Usage
Stream-methods that return single elements from an array wrap those into Cells (compare Java optional).
Those values inside can be accessed via ```$cell->unwrap()``` or ```$cell->orElse($default)```.
unwrapping a cell with a null value inside throws a "NoElementException"
You can transform any traditional Array into a Stream either like that.
```PHP
use Stream/Stream;
$array = [1,2,3,4,5,6,7,8,9,10];
$stream = new Stream($array);
```
or like that
```PHP
use Stream/Stream;
$array = [1,2,3,4,5,6,7,8,9,10];
$stream = Stream::asStream($array);
```
The most functions from the Java Stream Api are implemented.
## Examples
#### get the first even number from an array
```PHP
$array = [1,2,3,4,5,6,7,8,9,10];
$onlyEvenNumbers = Stream::asStream($array)->filter(function($v){return $v%2==0;});
$firstEvenNumber = $onlyEvenNumbers->first()->unwrap();
```
or in one line
```PHP
$firstEvenNumber = Stream::asStream([1,2,3,4,5,6,7,8,9,10])->filter(function($v){return $v%2==0;})->first()->unwrap();
```
#### square all numbers in an array
```PHP
$array = [1,2,3,4,5,6,7,8,9,10];
$squares = Stream::asStream($array)->map(function($v){return $v*$v;});
```
#### Print all numbers in an array
```PHP
$array = [1,2,3,4,5,6,7,8,9,10];
Stream::asStream($array)->forEach(function($v){echo $v;});
```
#### ArrayList
The ArrayList class extends ArrayObject and can be therefore used just like a normal PHP array.
Although it can be directly converted to a Stream
```PHP
$a = new ArrayList();
$a[] = 1;
$a[] = 2;
$a[] = 3;
echo $a->toStream()->first()->orElse(null); // prints 1
```
## License
MIT