alexeyshockov/colada

Collections framework for PHP

Colada

, _(*1)

Goal

Convenient and safe way to work with collections., _(*2)

...And it's been (more or less) solved by some other libraries, like nikic/iter, doctrine/collections or even php-ds/php-ds. That's why the current version of the library contains just a few helpers for that libraries, to conveniently integrate them together., _(*3)

Installation

composer require alexeyshockov/colada:~3.0

Usage

The library's functions are split by namespaces, one namespace = specific function a dependency (in most cases)., _(*4)

\Colada\ds\{group_by}

Helpers from this namespace require php-ds/php-ds to be available., _(*5)

group_by() function prodices a two dimension array (\ArrayObject or \Ds\Map, depends on the group key type), from an iterable based on a group function., _(*6)

TODO

\Colada\GuzzleHttp\{coroutine_invoke, coroutine, time_sleep}

\Colada\React\{coroutine_invoke, coroutine}

Helpers from this namespace require guzzlehttp/promises or react/promise to be available., _(*7)

This is the same concept applied to two most popular libs with async capabilities. If you are familiar with async/await in C# or node.js or coroutines in Go, this should be simple. Take a look at the script, written in callback-style and in coroutine-style:, _(*8)

TODO

TODO

\Colada\iter\opt\{get, head, last, find_one}

Helpers from this namespace require phpoption/phpoption to be available., _(*9)

\Colada\iter\{to_kv_pairs, each_n_and_last, uasort, uksort}

Simple helpers for general iterable types., _(*10)

uasort() and uksort() are basically equivalents for the internal ones, but work for arbitrary iterable type., _(*11)

Contributing

Running Tests

To run all the tests, install the vendors (with Composer) and execute:, _(*12)

vendor/bin/phpunit --testdox

Public API

All classes or functions that are intended to be used by a user should be marked with @api PHPDoc tag. Anything without this mark are internal and should not be used by the end user (no guarantees that the interface will stay the same between versions)., _(*13)