Name: iterable-functions
Owner: Wikimedia Deutschland e.V.
Description: Functions to transform iterables into more specific types
Created: 2017-06-17 12:48:33.0
Updated: 2017-06-17 17:16:54.0
Pushed: 2018-02-03 08:52:00.0
Size: 16
Language: PHP
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Provides functions to transform variables of type iteratble (added in PHP 7.1) into more specific
types such as array.
If you have an iterable somewhere and you need to pass it to a function that only takes an array
or an Iterator, you have a problem. You will need to add conditional logic to find out the type
of the value and transform it if needed, which gets quite involved in the case of needing an Iterator.
This problem is quite common, as PHP's standard library, as of version 7.1, tends to either require arrays, iterators or traversables.
Example:
tion doStuff(iterable $iterable) {
$iterableMinusFooBar = array_diff( $iterable, [ 'foo', 'bar' ] );
utput: array_diff(): Argument #1 is not an array
To add this package as a local, per-project dependency to your project, simply add a
dependency on wmde/iterable-functions to your project's composer.json file.
Here is a minimal example of a composer.json file that just defines a dependency on
Iterable Functions 1.x:
"require": {
"wmde/iterable-functions": "~1.0"
}
When you need an array
tion doStuff(iterable $iterable) {
$iterableMinusFooBar = array_diff( iterable_to_array( $iterable ), [ 'foo', 'bar' ] );
When you need an Iterator
tion doStuff(iterable $iterable) {
$firstFewThings = new LimitIterator( iterable_to_iterator( $iterable ), 42 );
For a full CI run
composer ci
For tests only
composer test
For style checks only
composer cs
Initial release with
iterable_to_arrayiterable_to_iterator