README

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

PHP >= 5
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.

use Stream/Stream;
$array = [1,2,3,4,5,6,7,8,9,10];
$stream = new Stream($array);

or like that

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

$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

$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

$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

$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

$a = new ArrayList();
$a[] = 1;
$a[] = 2;
$a[] = 3;
echo $a->toStream()->first()->orElse(null); // prints 1

License

MIT

anon767 / phpstream

Maintainers

Details