Zicht\Itertools\lib\Traits\CycleTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	21
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	cycle()	0	8	2

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

namespace Zicht\Itertools\lib\Traits;

use Zicht\Itertools\lib\CycleIterator;

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.
     *
     * > iterable('ABCD')->cycle()
     * A B C D A B C D A B C D ...
     *
     * @return CycleIterator
     */
    public function cycle()
    {
        if ($this instanceof \Iterator) {
            return new CycleIterator($this);
        }

        return null;
    }
}