Zicht\Itertools\lib\Traits\MapByTrait

Complexity

Total Complexity

1

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	mapBy()	0	4	1

<?php
/**
 * @author Boudewijn Schoon <boudewijn@zicht.nl>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Itertools\lib\Traits;

use Zicht\Itertools as iter;

trait MapByTrait
{
    /**
     * Make an iterator returning values from  this 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']]
     * > iter\iterable($list)->mapBy('id')
     * 1=>['id'=>1, 'title'=>'one'] 2=>['id'=>2, 'title'=>'two']
     *
     * @param string|\Closure $strategy
     * @return iter\lib\MapByIterator
     */
    public function mapBy($strategy)
    {
        return iter\mapBy($strategy, $this);
    }
}