Zicht\Itertools\lib\Traits\MapTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	map()	0	19	3

<?php
/**
 * @copyright Zicht Online <http://zicht.nl>
 */

// phpcs:disable Zicht.Commenting.FunctionComment.ExtraParamComment

namespace Zicht\Itertools\lib\Traits;

use Zicht\Itertools\conversions;
use Zicht\Itertools\lib\MapIterator;

trait MapTrait
{
    /**
     * Make an iterator that applies $strategy to every entry in this iterable
     *
     * If additional iterables are 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 additional iterables are 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); };
     * > iter\iterable([1, 2, 3, 4])->map($minimal);
     * 3 3 3 4
     *
     * > $average = function ($value1, $value2) { return ($value1 + $value2) / 2; };
     * > iter\iterable([1, 2, 3])->map($average, [4, 5, 6]);
     * 2.5 3.5 4.5
     *
     * @param null|string|\Closure $strategy
     * @param array|string|\Iterator $iterable

There is no parameter named $iterable. Was it maybe removed?

     * @param array|string|\Iterator $iterable2

There is no parameter named $iterable2. Was it maybe removed?

     * @return MapIterator
     */
    public function map($strategy /*, $iterable, $iterable2, ... */)
    {
        if ($this instanceof \Iterator) {
            if (func_num_args() > 1) {
                $iterables = array_map(
                    '\Zicht\Itertools\conversions\mixed_to_iterator',
                    array_slice(func_get_args(), 1)
                );
            } else {
                $iterables = [];
            }
            $reflectorClass = new \ReflectionClass('\Zicht\Itertools\lib\MapIterator');
            return $reflectorClass->newInstanceArgs(
                array_merge([conversions\mixed_to_value_getter($strategy), $this], $iterables)

The function Zicht\Itertools\conversions\mixed_to_value_getter() has been deprecated with message: Use \Zicht\Itertools\util\Conversions::mixedToClosure, will be removed in version 3.0

            );
        }

        return null;
    }
}