Passed
Pull Request — master (#19)
by
unknown
03:59
created

CycleTrait::cycle()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 2
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 4
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
/**
3
 * @author Boudewijn Schoon <[email protected]>
4
 * @copyright Zicht Online <http://zicht.nl>
5
 */
6
7
namespace Zicht\Itertools\lib\Traits;
8
9
use Zicht\Itertools as iter;
10
11
trait CycleTrait
12
{
13
    /**
14
     * Make an iterator returning elements from this iterable and saving a
15
     * copy of each.  When the iterable is exhausted, return elements from
16
     * the saved copy.  Repeats indefinitely.
17
     *
18
     * > iter\iterable('ABCD')->cycle()
19
     * A B C D A B C D A B C D ...
20
     *
21
     * @return iter\lib\CycleIterator
22
     */
23 1
    public function cycle()
24
    {
25 1
        return iter\cycle($this);
26
    }
27
}
28