Zicht\Itertools\lib\Traits\CycleTrait

Complexity

Total Complexity

1

Size/Duplication

Total Lines	17
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	cycle()	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 CycleTrait
{
    /**
     * Make an iterator returning elements from this iterable and saving a
     * copy of each.  When the iterable is exhausted, return elements from
     * the saved copy.  Repeats indefinitely.
     *
     * > iter\iterable('ABCD')->cycle()
     * A B C D A B C D A B C D ...
     *
     * @return iter\lib\CycleIterator
     */
    public function cycle()
    {
        return iter\cycle($this);
    }
}