wmde / iterable-functions
Functions to transform iterables into more specific types
Installs: 15 383
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 10
Forks: 1
Open Issues: 2
Requires
- php: >=7.1
- wmde/traversable-iterator: ~1.0
Requires (Dev)
- mediawiki/mediawiki-codesniffer: ~22.0.0
- ockcyp/covers-validator: ~1.0
- phpunit/phpunit: ~7.3.5
- squizlabs/php_codesniffer: ~3.3.1
This package is not auto-updated.
Last update: 2024-09-29 02:58:51 UTC
README
Provides basic functions to work with variables for type iterable
(added in PHP 7.1).
Primarily to transform variables of type iteratble
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:
function doStuff(iterable $iterable) { $iterableMinusFooBar = array_diff( $iterable, [ 'foo', 'bar' ] ); } // Output: array_diff(): Argument #1 is not an array
Installation
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" } }
Usage
When you need an array
function doStuff(iterable $iterable) { $iterableMinusFooBar = array_diff( iterable_to_array( $iterable ), [ 'foo', 'bar' ] ); }
When you need an Iterator
function doStuff(iterable $iterable) { $firstFewThings = new LimitIterator( iterable_to_iterator( $iterable ), 42 ); }
Running the tests
For a full CI run
composer ci
For tests only
composer test
For style checks only
composer cs
Release notes
0.2.0 (2018-09-13)
- Added
iterable_merge
0.1.0 (2017-06-17)
Initial release with
iterable_to_array
iterable_to_iterator