Zicht\Itertools\lib\Traits\UniqueTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	unique()	0	11	2

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

namespace Zicht\Itertools\lib\Traits;

use Zicht\Itertools\conversions;
use Zicht\Itertools\lib\UniqueIterator;

trait UniqueTrait
{
    /**
     * Returns an iterator where the values from $strategy are unique
     *
     * The $strategy is used to get values for every element in this iterable,
     * when this value has already been encountered the element is not
     * part of the returned iterator
     *
     * > iter\iterable([1, 1, 2, 2, 3, 3])->unique()
     * 1 2 3
     *
     * > iter\iterable([['id' => 1, 'value' => 'a'], ['id' => 1, 'value' => 'b']])->unique('id')
     * ['id' => 1, 'value' => 'a']  # one element in this list
     *
     * @param null|string|\Closure $strategy
     * @return UniqueIterator
     */
    public function unique($strategy = null)
    {
        if ($this instanceof \Iterator) {
            return new UniqueIterator(
                conversions\mixed_to_value_getter($strategy),

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

                $this
            );
        }

        return null;
    }
}