vakata/collection

PHP collection manipulation class - supports iterators and generators

collection

![Software License][ico-license] ![Code Coverage][ico-scrutinizer], _(*1)

A PHP class for fast iterables manipulation (arrays, generators, iterators)., _(*2)

All predicate / mutator callables receive the current value, current key and the whole collection as arguments., _(*3)

map & filter do not execute immediately, but instead stack up until you need to get a value (calling squash, toArray, value). Where possible helpers use map & filter in order to minimize RAM usage. This means that it is possible to iterate through a large file reading line by line while maintaining a minimal memory footprint., _(*4)

Install

Via Composer, _(*5)

``` bash composer require vakata/collection, <sub>(*6)</sub>

## Usage

``` php
$collection = \vakata\collection\Collection::from([1,2,3,4,5,6]);
$result = $collection
    ->filter(function ($v) { return $v % 2 === 0; })
    ->map(function ($v) { return $v + 1; })
    ->head(2)
    ->toArray();

Read more in the API docs, <sub>(*7)</sub>

Testing

bash composer test, <sub>(*8)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*9)</sub>

Security

If you discover any security related issues, please email github@vakata.com instead of using the issue tracker., <sub>(*10)</sub>

Credits

A big thanks to im0rtality and the great Underscore package, <sub>(*11)</sub>

• vakata
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*12)</sub>