itertools.php ➔ accumulate() - Code Metrics - Inspection of "Prepare for new major version" - zicht/itertools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#64)

unknown
created 2021-03-25 08:34 UTC
itertools.php ➔ accumulate() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
nc	2
nop	2
dl	0
loc	8
rs	10
c	0
b	0
f	0
ccs	0
cts	0
cp	0
crap	6
<?php
/**
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Itertools;

use Zicht\Itertools\lib\AccumulateIterator;
use Zicht\Itertools\lib\ChainIterator;
use Zicht\Itertools\lib\CountIterator;
use Zicht\Itertools\lib\CycleIterator;
use Zicht\Itertools\lib\FilterIterator;
use Zicht\Itertools\lib\GroupbyIterator;
use Zicht\Itertools\lib\Interfaces\AccumulateInterface;
use Zicht\Itertools\lib\Interfaces\AllInterface;
use Zicht\Itertools\lib\Interfaces\ChainInterface;
use Zicht\Itertools\lib\Interfaces\CollapseInterface;
use Zicht\Itertools\lib\Interfaces\CycleInterface;
use Zicht\Itertools\lib\Interfaces\FilterInterface;
use Zicht\Itertools\lib\Interfaces\FiniteIterableInterface;
use Zicht\Itertools\lib\Interfaces\FirstInterface;
use Zicht\Itertools\lib\Interfaces\GroupByInterface;
use Zicht\Itertools\lib\Interfaces\LastInterface;
use Zicht\Itertools\lib\Interfaces\MapByInterface;
use Zicht\Itertools\lib\Interfaces\ReduceInterface;
use Zicht\Itertools\lib\Interfaces\ReversedInterface;
use Zicht\Itertools\lib\Interfaces\SliceInterface;
use Zicht\Itertools\lib\Interfaces\SortedInterface;
use Zicht\Itertools\lib\Interfaces\UniqueInterface;
use Zicht\Itertools\lib\Interfaces\ZipInterface;
use Zicht\Itertools\lib\IterableIterator;
use Zicht\Itertools\lib\MapByIterator;
use Zicht\Itertools\lib\MapIterator;
use Zicht\Itertools\lib\RepeatIterator;
use Zicht\Itertools\lib\ReversedIterator;
use Zicht\Itertools\lib\SliceIterator;
use Zicht\Itertools\lib\SortedIterator;
use Zicht\Itertools\lib\UniqueIterator;
use Zicht\Itertools\lib\ZipIterator;
use Zicht\Itertools\reductions;
use Zicht\Itertools\util\Conversions;

/**
 * Transforms anything into an \Iterator or throws an \InvalidArgumentException
 *
 * @param array|string|\Iterator $iterable
 * @return \Iterator
 * @deprecated Use \Zicht\Itertools\util\Conversions::mixedToIterator, will be removed in version 3.0
 */
function mixedToIterator($iterable) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    return Conversions::mixedToIterator($iterable);
}

/**
 * Try to transforms something into a \Closure
 *
 * @param null|\Closure $closure
 * @return \Closure
 * @deprecated Use \Zicht\Itertools\util\Conversions::mixedToClosure, will be removed in version 3.0
 */
function mixedToClosure($closure) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    return Conversions::mixedToClosure($closure);
}

/**
 * Try to transforms something into a \Closure that gets a value from $strategy
 *
 * @param null|string|\Closure $strategy
 * @return \Closure
 * @deprecated Use \Zicht\Itertools\util\Conversions::mixedToValueGetter, will be removed in version 3.0
 */
function mixedToValueGetter($strategy) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    return Conversions::mixedToValueGetter($strategy);
}

/**
 * Try to transform something into a \Closure
 *
 * @param string|\Closure $closure
 * @return \Closure
 * @deprecated Will be removed in version 3.0, no replacement will be needed
 */
function mixedToOperationClosure($closure) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    if (is_string($closure)) {
        $closure = reductions\get_reduction($closure, $closure);

    }

    if (!($closure instanceof \Closure)) {
        throw new \InvalidArgumentException('Argument $closure must be a \Closure or string (i.e. "add", "join", etc)');
    }

    return $closure;
}

/**
 * Make an iterator that returns accumulated sums
 *
 * If the optional $closure argument is supplied, it should be a string:
 * add, sub, mul, min, or max.  Or it can be a \Closure taking two
 * arguments that will be used to instead of addition.
 *
 * > accumulate([1,2,3,4,5])
 * 1 3 6 10 15
 *
 * > accumulate(['One', 'Two', 'Three'], function ($a, $b) { return $a . $b; })
 * 'One' 'OneTwo' 'OneTwoThree'
 *
 * @param array|string|\Iterator $iterable
 * @param string|\Closure $closure
 * @return AccumulateIterator
 * @deprecated Use iterable($iterable)->accumulate($closure), will be removed in version 3.0
 */
function accumulate($iterable, $closure = 'add')
{
    if (!($iterable instanceof AccumulateInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->accumulate($closure);
}

/**
 * Reduce an iterator to a single value
 *
 * > reduce([1,2,3])
 * 6
 *
 * > reduce([1,2,3], 'max')
 * 3
 *
 * > reduce([1,2,3], 'sub', 10)
 * 4
 *
 * > reduce([], 'min', 1)
 * 1
 *
 * @param array|string|\Iterator $iterable
 * @param string|\Closure $closure
 * @param mixed $initializer
 * @return mixed
 * @deprecated Use iterable($iterable)->reduce($closure, $initializer), will be removed in version 3.0
 */
function reduce($iterable, $closure = 'add', $initializer = null)
{
    if (!($iterable instanceof ReduceInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->reduce($closure, $initializer);
}

/**
 * Collapse a two dimentional iterator into a one dimentional iterator
 *
 * > collapse([1, 2], [3, 4])
 * 1, 2, 3, 4
 *
 * @param array|string|\Iterator $iterable
 * @return lib\CollapseIterator
 * @deprecated Use iterable($iterable)->collapse(), will be removed in version 3.0
 */
function collapse($iterable)
{
    if (!($iterable instanceof CollapseInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->collapse();
}

/**
 * Make an iterator that contains all consecutive elements from all provided iterables.
 *
 * The resulting iterator contains elements from the first iterable in the parameters
 * until it is exhausted, then proceeds to the next iterable in the parameters, until
 * all the iterables are exhausted.  Used for creating consecutive
 * sequences as a single sequence
 *
 * > chain([1, 2, 3], [4, 5, 6])
 * 1 2 3 4 5 6
 *
 * > chain('ABC', 'DEF')
 * A B C D E F
 *
 * @return ChainIterator
 * @deprecated Use iterable($iterable)->chain($iterable, ...), will be removed in version 3.0
 */
function chain()
{
    // note, once we stop supporting php 5.5, we can rewrite the code below
    // to the chain(...$iterables) structure.
    // http://php.net/manual/en/functions.arguments.php#functions.variable-arg-list

    $args = func_get_args();
    if (sizeof($args) > 0) {
        list($iterable) = array_slice($args, 0, 1);
        $iterables = array_slice($args, 1);
    } else {
        $iterable = null;
        $iterables = [];
    }

    if (!($iterable instanceof ChainInterface)) {
        $iterable = iterable($iterable);
    }

    return call_user_func_array([$iterable, 'chain'], $iterables);
}

/**
 * Make an iterator that returns evenly spaced values starting with
 * number $start
 *
 * > count(10)
 * 10 11 12 13 14 ...
 *
 * > count(2.5, 0.5)
 * 2.5 3.0 3.5 4.0 ...
 *
 * @param int|float $start
 * @param int|float $step
 * @return CountIterator
 * @deprecated Use new CountIterator($start, $step), will be removed in version 3.0
 */
function count($start = 0, $step = 1)
{
    if (!(is_int($start) || is_float($start))) {
        throw new \InvalidArgumentException('Argument $start must be an integer or float');
    }

    if (!(is_int($step) || is_float($step))) {
        throw new \InvalidArgumentException('Argument $step must be an integer or float');
    }

    return new CountIterator($start, $step);
}

/**
 * Make an iterator returning elements from the $iterable and saving a
 * copy of each.  When the iterable is exhausted, return elements from
 * the saved copy, repeating indefinitely
 *
 * > cycle('ABCD')
 * A B C D A B C D A B C D ...
 *
 * @param array|string|\Iterator $iterable
 * @return CycleIterator
 * @deprecated Use iterable($iterable)->cycle(), will be removed in version 3.0
 */
function cycle($iterable)
{
    if (!($iterable instanceof CycleInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->cycle();
}

/**
 * Make an iterator returning values from $iterable and keys from
 * $strategy
 *
 * When $strategy is a string, the key is obtained through one of
 * the following:
 * 1. $value->{$strategy}, when $value is an object and
 *    $strategy is an existing property,
 * 2. call $value->{$strategy}(), when $value is an object and
 *    $strategy is an existing method,
 * 3. $value[$strategy], when $value is an array and $strategy
 *    is an existing key,
 * 4. otherwise the key will default to null.
 *
 * Alternatively $strategy can be a closure.  In this case the
 * $strategy closure is called with each value in $iterable and the
 * key will be its return value.
 *
 * > $list = [['id'=>1, 'title'=>'one'], ['id'=>2, 'title'=>'two']]
 * > mapBy('id', $list)
 * 1=>['id'=>1, 'title'=>'one'] 2=>['id'=>2, 'title'=>'two']
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @return MapByIterator
 * @deprecated Use iterable($iterable)->mapBy($strategy), will be removed in version 3.0
 */
function map_by($strategy, $iterable)
{
    // In version 3.0 mapBy and map_by will be removed
    // as its functionality will be merged into map.

    if (!($iterable instanceof MapByInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->mapBy($strategy);
}

/**
 * Make an iterator returning values from $iterable and keys from
 * $strategy
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @return MapByIterator
 * @deprecated Please use map_by, will be removed in version 3.0
 * @deprecated Use iterable($iterable)->mapBy($strategy), will be removed in version 3.0
 */
function mapBy($strategy, $iterable) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    if (!($iterable instanceof MapByInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->mapBy($strategy);}

/**
 * Make an iterator returning values from $iterable and keys from
 * $strategy
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @return MapByIterator
 * @deprecated Use iterable($iterable)->mapBy($strategy), will be removed in version 3.0
 */
function keyCallback($strategy, $iterable) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    return map_by($strategy, $iterable);
}

/**
 * Make an iterator that applies $strategy to every entry in the iterables
 *
 * If one iterable is passed, $strategy is called for each entry in
 * the $iterable, where the first argument is the value and the
 * second argument is the key of the entry
 *
 * If more than one iterable is passed, $strategy is called with the
 * values and the keys from the iterables.  For example, the first
 * call to $strategy will be:
 * $strategy($value_iterable1, $value_iterable2, $key_iterable2, $key_iterable2)
 *
 * With multiple iterables, the iterator stops when the shortest
 * iterable is exhausted.
 *
 * > $minimal = function ($value) { return min(3, $value); };
 * > map($minimal, [1, 2, 3, 4]);
 * 3 3 3 4
 *
 * > $average = function ($value1, $value2) { return ($value1 + $value2) / 2; };
 * > map($average, [1, 2, 3], [4, 5, 6]);
 * 2.5 3.5 4.5
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable Additional $iterable parameters may follow
 * @return MapIterator
 * @deprecated Use iterable($iterable)->map($strategy, [$iterable2, ...]), will be removed in version 3.0
 */
function map($strategy, $iterable)

{
    // note, once we stop supporting php 5.5, we can rewrite the code below
    // to the map(...$iterables) structure.
    // http://php.net/manual/en/functions.arguments.php#functions.variable-arg-list

    if (func_num_args() > 2) {
        $iterables = array_slice(func_get_args(), 2);
    } else {
        $iterables = [];
    }

    if (!($iterable instanceof ChainInterface)) {
        $iterable = iterable($iterable);
    }

    return call_user_func_array([$iterable, 'map'], array_merge([$strategy], $iterables));
}

/**
 * Select values from the iterator by applying a function to each of the iterator values, i.e., mapping it to the
 * value with a strategy based on the input, similar to map_key
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @param bool $flatten
 * @return array|MapIterator
 * @deprecated Use map(...)->values() instead (when flatten true), will be removed in version 3.0
 */
function select($strategy, $iterable, $flatten = true)
{
    if (!is_bool($flatten)) {
        throw new \InvalidArgumentException('Argument $FLATTEN must be a boolean');
    }

    $ret = new MapIterator(
        Conversions::mixedToValueGetter($strategy),
        Conversions::mixedToIterator($iterable)
    );
    if ($flatten) {
        return $ret->values();
    }
    return $ret;
}

/**
 * Make an iterator that returns $mixed over and over again.  Runs
 * indefinitely unless the $times argument is specified
 *
 * > repeat(2)
 * 2 2 2 2 2 ...
 *
 * > repeat(10, 3)
 * 10 10 10
 *
 * @param mixed $mixed
 * @param null|int $times
 * @return RepeatIterator
 * @deprecated Use new RepeatIterator(mixed, $times), will be removed in version 3.0
 */
function repeat($mixed, $times = null)
{
    if (!(is_null($times) || (is_int($times) && $times >= 0))) {
        throw new \InvalidArgumentException('Argument $times must be null or a positive integer');
    }

    return new RepeatIterator($mixed, $times);
}

/**
 * Make an iterator that returns consecutive groups from the
 * $iterable.  Generally, the $iterable needs to already be sorted on
 * the same key function
 *
 * When $strategy is a string, the key is obtained through one of
 * the following:
 * 1. $value->{$strategy}, when $value is an object and
 *    $strategy is an existing property,
 * 2. call $value->{$strategy}(), when $value is an object and
 *    $strategy is an existing method,
 * 3. $value[$strategy], when $value is an array and $strategy
 *    is an existing key,
 * 4. otherwise the key will default to null.
 *
 * Alternatively $strategy can be a closure.  In this case the
 * $strategy closure is called with each value in $iterable and the
 * key will be its return value.  $strategy is called with two
 * parameters: the value and the key of the iterable as the first and
 * second parameter, respectively.
 *
 * The operation of groupBy() is similar to the uniq filter in Unix.
 * It generates a break or new group every time the value of the key
 * function changes (which is why it is usually necessary to have
 * sorted the data using the same key function).  That behavior
 * differs from SQL's GROUP BY which aggregates common elements
 * regardless of their input order.
 *
 * > $list = [['type'=>'A', 'title'=>'one'], ['type'=>'A', 'title'=>'two'], ['type'=>'B', 'title'=>'three']]
 * > groupby('type', $list)
 * 'A'=>[['type'=>'A', 'title'=>'one'], ['type'=>'A', 'title'=>'two']] 'B'=>[['type'=>'B', 'title'=>'three']]
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @param boolean $sort
 * @return GroupbyIterator
 * @deprecated Use iterable($iterable)->groupBy($strategy, $sort), will be removed in version 3.0
 */
function group_by($strategy, $iterable, $sort = true)
{
    if (!($iterable instanceof GroupByInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->groupBy($strategy, $sort);
}

/**
 * Make an iterator that returns consecutive groups from the
 * $iterable.  Generally, the $iterable needs to already be sorted on
 * the same key function
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @param boolean $sort
 * @return GroupbyIterator
 * @deprecated Use iterable($iterable)->groupBy($strategy, $sort), will be removed in version 3.0
 */
function groupBy($strategy, $iterable, $sort = true) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    if (!($iterable instanceof GroupByInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->groupBy($strategy, $sort);
}

/**
 * Make an iterator that returns the values from $iterable sorted by
 * $strategy
 *
 * When determining the order of two entries the $strategy is called
 * twice, once for each value, and the results are used to determine
 * the order.  $strategy is called with two parameters: the value and
 * the key of the iterable as the first and second parameter, respectively.
 *
 * When $reverse is true the order of the results are reversed.
 *
 * The sorted() function is guaranteed to be stable.  A sort is stable
 * if it guarantees not to change the relative order of elements that
 * compare equal.  this is helpful for sorting in multiple passes (for
 * example, sort by department, then by salary grade).  This also
 * holds up when $reverse is true.
 *
 * > $list = [['type'=>'B', 'title'=>'second'], ['type'=>'C', 'title'=>'third'], ['type'=>'A', 'title'=>'first']]
 * > sorted('type', $list)
 * ['type'=>'A', 'title'=>'first'] ['type'=>'B', 'title'=>'second']] ['type'=>'C', 'title'=>'third']
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @param boolean $reverse
 * @return SortedIterator
 * @deprecated Use iterable($iterable)->sorted($strategy, $reverse), will be removed in version 3.0
 */
function sorted($strategy, $iterable, $reverse = false)
{
    if (!($iterable instanceof SortedInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->sorted($strategy, $reverse);
}

/**
 * Make an iterator that returns values from $iterable where the
 * $strategy determines that the values are not empty
 *
 * An optional $strategy may be given, this must be either null,
 * a string, or a \Closure.
 *
 * Following the (optional) $strategy, one or more $iterable instances
 * must be given.  They must be either an array, a string, or an \Iterator.
 *
 * @return FilterIterator
 * @deprecated Use iterable($iterable)->filter($strategy), will be removed in version 3.0
 */
function filter()

{
    // note, once we stop supporting php 5.5, we can rewrite the code below
    // to the filter(...$iterables) structure.
    // http://php.net/manual/en/functions.arguments.php#functions.variable-arg-list

    $args = func_get_args();
    switch (sizeof($args)) {
        case 1:
            $strategy = null;
            $iterable = $args[0];
            break;

        case 2:
            $strategy = $args[0];
            $iterable = $args[1];
            break;

        default:
            throw new \InvalidArgumentException('filter requires either one (iterable) or two (strategy, iterable) arguments');
    }

    if (!($iterable instanceof FilterInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->filter($strategy);
}

/**
 * Make an iterator that returns values from $iterable where the
 * $strategy determines that the values are not empty
 *
 * An $strategy must be given, this must be either null, a string,
 * or a \Closure.
 *
 * Following the $strategy, an optional $closure may be given, this
 * closure is called to determine is the value (which results from
 * $strategy) is or is not filtered.  Note that without providing a
 * $closure, the function !empty(...) is used instead.
 *
 * Following the (optional) $closure, one or more $iterable instances
 * must be given.  They must be either an array, a string, or an \Iterator.
 *
 * @return FilterIterator
 * @deprecated Use iterable($iterable)->filter($strategy), will be removed in version 3.0
 */
function filterBy() // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming
{
    // note, once we stop supporting php 5.5, we can rewrite the code below
    // to the filterBy(...$iterables) structure.
    // http://php.net/manual/en/functions.arguments.php#functions.variable-arg-list

    $args = func_get_args();
    switch (sizeof($args)) {
        case 2:

            $strategy = Conversions::mixedToValueGetter($args[0]);
            $closure = function ($value, $key) use ($strategy) {
                $tempVarPhp54 = call_user_func($strategy, $value, $key);
                return !empty($tempVarPhp54);
            };
            $iterable = Conversions::mixedToIterator($args[1]);
            break;

        case 3:

            $strategy = Conversions::mixedToValueGetter($args[0]);
            $userClosure = $args[1];
            $closure = function ($value, $key) use ($strategy, $userClosure) {
                return call_user_func($userClosure, call_user_func($strategy, $value, $key));
            };
            $iterable = Conversions::mixedToIterator($args[2]);
            break;

        default:
            throw new \InvalidArgumentException('filterBy requires either two (strategy, iterable) or three (strategy, closure, iterable) arguments');
    }

    return new FilterIterator($closure, $iterable);
}

/**
 * Returns an iterator where one or more iterables are zipped together
 *
 * This function returns a list of tuples, where the i-th tuple contains
 * the i-th element from each of the argument sequences or iterables.
 *
 * The returned list is truncated in length to the length of the
 * shortest argument sequence.
 *
 * > zip([1, 2, 3], ['a', 'b', 'c'])
 * [1, 'a'] [2, 'b'] [3, 'c']
 *
 * @param array|string|\Iterator $iterable Additional $iterable parameters may follow
 * @return ZipIterator
 * @deprecated Use iterable($iterable)->zip($iterable2, [$iterable3, ...]), will be removed in version 3.0
 */
function zip($iterable)

{
    // note, once we stop supporting php 5.5, we can rewrite the code below
    // to the zip(...$iterables) structure.
    // http://php.net/manual/en/functions.arguments.php#functions.variable-arg-list

    if (func_num_args() > 1) {
        $iterables = array_slice(func_get_args(), 1);
    } else {
        $iterables = [];
    }

    if (!($iterable instanceof ZipInterface)) {
        $iterable = iterable($iterable);
    }

    return call_user_func_array([$iterable, 'zip'], $iterables);
}

/**
 * Returns an iterable with all the elements from $iterable reversed
 *
 * @param array|string|\Iterator $iterable
 * @return ReversedIterator
 * @deprecated Use iterable($iterable)->reversed(), will be removed in version 3.0
 */
function reversed($iterable)
{
    if (!($iterable instanceof ReversedInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->reversed();
}

/**
 * Returns an iterator where the values from $strategy are unique
 *
 * An optional $strategy may be given to specify the value which is used
 * to determine whether the element is unique.  When no $strategy is
 * given, the identity function is used, i.e. the value of the element
 * itself is used to determine whether the element is unique.
 *
 * Following the optional $strategy, a $iterable must be given.  Otherwise,
 * an \InvalidArgumentException will be raised.
 *
 * > unique([1, 1, 2, 2, 3, 3])
 * 1 2 3
 *
 * > unique('id', [['id' => 1, 'value' => 'a'], ['id' => 1, 'value' => 'b']])
 * ['id' => 1, 'value' => 'a']  # one element in this list
 *
 * @return UniqueIterator
 * @deprecated Use iterable($iterable)->unique($strategy), will be removed in version 3.0
 */
function unique()

{
    $args = func_get_args();
    switch (sizeof($args)) {
        case 1:
            $strategy = null;
            $iterable = $args[0];
            break;

        case 2:
            $strategy = $args[0];
            $iterable = $args[1];
            break;

        default:
            throw new \InvalidArgumentException('unique requires either one (iterable) or two (strategy, iterable) arguments');
    }

    if (!($iterable instanceof UniqueInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->unique($strategy);
}

/**
 * Returns an iterator where the values from $strategy are unique
 *
 * @param null|string|\Closure $strategy
 * @param array|string|\Iterator $iterable
 * @return UniqueIterator
 * @deprecated Use iterable($iterable)->unique($strategy), will be removed in version 3.0
 */
function uniqueBy($strategy, $iterable) // phpcs:ignore Zicht.NamingConventions.Functions.GlobalNaming

{
    $args = func_get_args();
    switch (sizeof($args)) {
        case 1:
            $strategy = null;
            $iterable = $args[0];
            break;

        case 2:
            $strategy = $args[0];
            $iterable = $args[1];
            break;

        default:
            throw new \InvalidArgumentException('unique requires either one (iterable) or two (strategy, iterable) arguments');
    }

    if (!($iterable instanceof UniqueInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->unique($strategy);
}

/**
 * Returns true when one or more element of $iterable is not empty, otherwise returns false
 *
 * An optional $strategy may be given to specify the value which is used
 * to determine weather the element evaluates to true.  When no $strategy is
 * given, the identity function is used, i.e. the value of the element
 * itself is used to determine weather the element evaluates to true.
 *
 * Following the optional $strategy, an $iterable may be given.  Its type may
 * be either array, string, or \Iterator.  When no $iterable is given, false
 * is returned.
 *
 * > any([0, '', false])
 * false
 *
 * > any([1, null, 3])
 * true
 *
 * @return boolean
 * @deprecated Use iterable($iterable)->any($strategy), will be removed in version 3.0
 */
function any()

{
    $args = func_get_args();
    switch (sizeof($args)) {
        case 1:
            $strategy = null;
            $iterable = $args[0];
            break;

        case 2:
            $strategy = $args[0];
            $iterable = $args[1];
            break;

        default:
            throw new \InvalidArgumentException('any requires either one (iterable) or two (strategy, iterable) arguments');
    }

    if (!($iterable instanceof AllInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->any($strategy);
}

/**
 * Returns true when all elements of $iterable are not empty, otherwise returns false
 *
 * An optional $strategy may be given to specify the value which is used
 * to determine weather the element evaluates to true.  When no $strategy is
 * given, the identity function is used, i.e. the value of the element
 * itself is used to determine weather the element evaluates to true.
 *
 * Following the optional $strategy, an $iterable may be given.  Its type may
 * be either array, string, or \Iterator.  When no $iterable is given, true
 * is returned.
 *
 * > all([1, 'hello world', true])
 * true
 *
 * > all([1, null, 3])
 * false
 *
 * @return boolean
 * @deprecated Use iterable($iterable)->all($strategy), will be removed in version 3.0
 */
function all()

{
    $args = func_get_args();
    switch (sizeof($args)) {
        case 1:
            $strategy = null;
            $iterable = $args[0];
            break;

        case 2:
            $strategy = $args[0];
            $iterable = $args[1];
            break;

        default:
            throw new \InvalidArgumentException('all requires either one (iterable) or two (strategy, iterable) arguments');
    }

    if (!($iterable instanceof AllInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->all($strategy);
}

/**
 * Make an iterator that contains a slice of $iterable
 *
 * The parameters $start and $end determine the range that will be taken
 * from the $iterable.  These values may be negative, in which case they
 * will indicate elements in $iterable starting at the end.
 *
 * > slice(['a', 'b', 'c', 'd', 'e', 1]
 * 'b', 'c', 'd', 'e'
 *
 * > slice(['a', 'b', 'c', 'd', 'e', -1]
 * 'e'
 *
 * > slice(['a', 'b', 'c', 'd', 'e', 1, 2]
 * 'b'
 *
 * > slice(['a', 'b', 'c', 'd', 'e', 1, -1]
 * 'b', 'c', 'd'
 *
 * @param array|string|\Iterator $iterable
 * @param int $start
 * @param null|int $end
 * @return SliceIterator
 * @deprecated Use iterable($iterable)->slice($start, $end), will be removed in version 3.0
 */
function slice($iterable, $start, $end = null)
{
    if (!($iterable instanceof SliceInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->slice($start, $end);
}

/**
 * Returns the first element of $iterable or returns $default when $iterable is empty
 *
 * > first([1, 2, 3])
 * 1
 *
 * > first([])
 * null
 *
 * @param array|string|\Iterator $iterable
 * @param mixed $default
 * @return mixed
 * @deprecated Use iterable($iterable)->first($default), will be removed in version 3.0
 */
function first($iterable, $default = null)
{
    if (!($iterable instanceof FirstInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->first($default);
}

/**
 * Returns the key of the first element of $iterable or returns $default when $iterable is empty
 *
 * > first_key([1, 2, 3])
 * 0
 *
 * > first_key([])
 * null
 *
 * @param array|string|\Iterator $iterable
 * @param mixed $default
 * @return mixed
 * @deprecated Use iterable($iterable)->firstKey($default), will be removed in version 3.0
 */
function first_key($iterable, $default = null)
{
    if (!($iterable instanceof FirstInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->firstKey($default);
}

/**
 * Returns the last element of $iterable or returns $default when $iterable is empty
 *
 * > last([1, 2, 3])
 * 3
 *
 * > last([])
 * null
 *
 * @param array|string|\Iterator $iterable
 * @param mixed $default
 * @return mixed
 * @deprecated Use iterable($iterable)->last($default), will be removed in version 3.0
 */
function last($iterable, $default = null)
{
    if (!($iterable instanceof LastInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->last($default);
}

/**
 * Returns the key of the last element of $iterable or returns $default when $iterable is empty
 *
 * > last_key([1, 2, 3])
 * 2
 *
 * > last_key([])
 * null
 *
 * @param array|string|\Iterator $iterable
 * @param mixed $default
 * @return mixed
 * @deprecated Use iterable($iterable)->lastKey($default), will be removed in version 3.0
 */
function last_key($iterable, $default = null)
{
    if (!($iterable instanceof LastInterface)) {
        $iterable = iterable($iterable);
    }

    return $iterable->lastKey($default);
}

/**
 * Returns an FiniteIterableInterface, providing a fluent interface to itertools
 *
 * > iterable([1, 2, 3])->filter(...)->map(...)->first(...)
 *
 * @param array|string|\Iterator $iterable
 * @return FiniteIterableInterface
 */
function iterable($iterable)
{
    if ($iterable instanceof FiniteIterableInterface) {
        return $iterable;
    }

    return new IterableIterator(Conversions::mixedToIterator($iterable));
}

zicht / itertools

Pull Request — master (#64)

itertools.php ➔ accumulate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
