Documentation

TakeIter extends LimitIterator
in package
implements Countable Uses IterTrait

Tags
template

TKey

template

TVal

extends

LimitIterator<TKey, TVal, Iterator<TKey, TVal>>

Table of Contents

Interfaces

Countable

Methods

__construct()  : mixed
all()  : bool
any()  : bool
chunkBy()  : ChunkByIter<TKey, TVal>
collect()  : object
concat()  : ConcatIter<TKey, TVal>
consume()  : void
Iterates over this without doing anything else.
count()  : int
countUntil()  : int
cycle()  : CycleIter<TKey, TVal>
dedup()  : DedupIter<TKey, TVal>
dedupBy()  : DedupByIter<TKey, TVal>
each()  : EachIter<TKey, TVal>
enumerate()  : EnumerateIter<TKey, TVal>
filter()  : FilterIter<TKey, TVal>
find()  : Option<string|int, TVal>
findKey()  : Option<string|int, TVal>
findLast()  : Option<string|int, TVal>
findLastKey()  : Option<string|int, TVal>
flatMap()  : FlatMapIter<UKey, UVal>
flatten()  : FlattenIter
Flattens one level of an iterator of iterators.
fold()  : U
isEmpty()  : bool
join()  : string
keys()  : KeysIter<TKey, TVal>
last()  : Option<string|int, TVal>
map()  : MapIter<TVal, UVal>
max()  : Option<string|int, TVal>
min()  : Option<string|int, TVal>
nth()  : Option<string|int, TVal>
position()  : Option<string|int, int>
reduce()  : Option<string|int, U>
reject()  : FilterIter<TKey, TVal>
skip()  : SkipIter<TKey, TVal>
skipEvery()  : SkipEveryIter<TKey, TVal>|EmptyIter<TKey, TVal>
skipWhile()  : SkipWhileIter<TKey, TVal>
slice()  : SliceIter<TKey, TVal>
sorted()  : SortedIter<TKey, TVal>
take()  : TakeIter<TKey, TVal>
takeEvery()  : TakeEveryIter<TKey, TVal>|EmptyIter<TKey, TVal>
takeRandom()  : array<string|int, TVal>
takeWhile()  : TakeWhileIter<TKey, TVal>
toArray()  : array<string|int, TVal>
toList()  : array<int, TVal>
toSortedArray()  : array<string|int, TVal>
toSortedList()  : array<int, TVal>
tryCollect()  : Result<object, Throwable>
unique()  : UniqueIter<TKey, TVal>
uniqueBy()  : UniqueByIter<TKey, TVal>
unzip()  : array<string|int, mixed>
values()  : ValuesIter<TKey, TVal>
zip()  : ZipIter<UKey, UVal>
zipMultiple()  : ZipMultipleIter
getIter()  : Iterator

Methods

__construct()

public __construct(Iterator<TKey, TVal> $iterable, int $takeAmount) : mixed
Parameters
$iterable : Iterator<TKey, TVal>
$takeAmount : int

all()

public all(callable $predicate) : bool
Parameters
$predicate : callable
Return values
bool

any()

public any(callable $predicate) : bool
Parameters
$predicate : callable
Return values
bool

chunkBy()

public chunkBy(callable $f[, bool $preserveKeys = false ]) : ChunkByIter<TKey, TVal>
Parameters
$f : callable
$preserveKeys : bool = false
Return values
ChunkByIter<TKey, TVal>

collect()

public collect(D> $dest) : object
Parameters
$dest : D>
Tags
template

D of FromIterator

psalm-return

D

psalm-suppress

MixedInferredReturnType

Return values
object

concat()

public concat(Iterator<TKey, TVal>|Iter<TKey, TVal> ...$iterators) : ConcatIter<TKey, TVal>
Parameters
$iterators : Iterator<TKey, TVal>|Iter<TKey, TVal>
Tags
psalm-suppress

MixedReturnTypeCoercion

Return values
ConcatIter<TKey, TVal>

consume()

Iterates over this without doing anything else.

public consume() : void

count()

public count() : int
Return values
int

countUntil()

public countUntil(int $limit) : int
Parameters
$limit : int
Return values
int

find()

public find(callable $predicate) : Option<string|int, TVal>
Parameters
$predicate : callable
Tags
psalm-suppress

MixedReturnTypeCoercion

Return values
Option<string|int, TVal>

findKey()

public findKey(callable $predicate) : Option<string|int, TVal>
Parameters
$predicate : callable
Tags
psalm-suppress

MixedReturnTypeCoercion

Return values
Option<string|int, TVal>

findLast()

public findLast(callable $predicate) : Option<string|int, TVal>
Parameters
$predicate : callable
Return values
Option<string|int, TVal>

findLastKey()

public findLastKey(callable $predicate) : Option<string|int, TVal>
Parameters
$predicate : callable
Return values
Option<string|int, TVal>

flatMap()

public flatMap(callable $f) : FlatMapIter<UKey, UVal>
Parameters
$f : callable
Tags
template

UKey

template

UVal

Return values
FlatMapIter<UKey, UVal>

flatten()

Flattens one level of an iterator of iterators.

public flatten() : FlattenIter
Tags
psalm-suppress

MixedArgumentTypeCoercion

Return values
FlattenIter

fold()

public fold(U $initialValue, callable $f) : U
Parameters
$initialValue : U
$f : callable
Tags
template

U

Return values
U

isEmpty()

public isEmpty() : bool
Return values
bool

join()

public join([string $separator = "" ]) : string
Parameters
$separator : string = ""
Return values
string

map()

public map(callable $f) : MapIter<TVal, UVal>
Parameters
$f : callable
Tags
template

UVal

Return values
MapIter<TVal, UVal>

max()

public max(callable|null $comparator) : Option<string|int, TVal>
Parameters
$comparator : callable|null
Tags
psalm-suppress

MixedArgumentTypeCoercion

Return values
Option<string|int, TVal>

min()

public min(callable|null $comparator) : Option<string|int, TVal>
Parameters
$comparator : callable|null
Tags
psalm-suppress

MixedArgumentTypeCoercion

Return values
Option<string|int, TVal>

nth()

public nth(int $n) : Option<string|int, TVal>
Parameters
$n : int
Tags
psalm-suppress

MixedReturnTypeCoercion

Return values
Option<string|int, TVal>

position()

public position(callable $predicate) : Option<string|int, int>
Parameters
$predicate : callable
Return values
Option<string|int, int>

reduce()

public reduce(callable $f) : Option<string|int, U>
Parameters
$f : callable
Tags
template

U

psalm-suppress

InvalidReturnType, MixedArgumentTypeCoercion, PossiblyInvalidArgument

Return values
Option<string|int, U>

slice()

public slice(int $start[, int $amount = -1 ]) : SliceIter<TKey, TVal>
Parameters
$start : int
$amount : int = -1
Return values
SliceIter<TKey, TVal>

sorted()

public sorted(callable $comparator[, bool $preserveKeys = true ]) : SortedIter<TKey, TVal>
Parameters
$comparator : callable
$preserveKeys : bool = true
Return values
SortedIter<TKey, TVal>

takeRandom()

public takeRandom([int $count = 1 ][, bool $preserveKeys = false ]) : array<string|int, TVal>
Parameters
$count : int = 1
$preserveKeys : bool = false
Tags
psalm-return

list<TVal>

psalm-suppress

MixedArgumentTypeCoercion, MixedAssignment, MixedArrayOffset, MoreSpecificReturnType, InvalidArrayOffset

Return values
array<string|int, TVal>

toArray()

public toArray() : array<string|int, TVal>
Return values
array<string|int, TVal>

toList()

public toList() : array<int, TVal>
Tags
psalm-return

list<TVal>

Return values
array<int, TVal>

toSortedArray()

public toSortedArray(callable $comparator) : array<string|int, TVal>
Parameters
$comparator : callable
Return values
array<string|int, TVal>

toSortedList()

public toSortedList(callable $comparator) : array<int, TVal>
Parameters
$comparator : callable
Tags
psalm-return

list<TVal>

Return values
array<int, TVal>

tryCollect()

public tryCollect(D> $dest) : Result<object, Throwable>
Parameters
$dest : D>
Tags
template

D of TryFromIterator

psalm-return

Result<D, Throwable>

psalm-suppress

MixedInferredReturnType, InvalidReturnType

Return values
Result<object, Throwable>

unzip()

public unzip() : array<string|int, mixed>
Tags
psalm-suppress

MixedReturnTypeCoercion, MixedAssignment

Return values
array<string|int, mixed>

zip()

public zip(Iterator<UKey, UVal>|Iter<UKey, UVal> $iterator) : ZipIter<UKey, UVal>
Parameters
$iterator : Iterator<UKey, UVal>|Iter<UKey, UVal>
Tags
template

UKey

template

UVal

psalm-suppress

InvalidReturnType

Return values
ZipIter<UKey, UVal>

getIter()

protected getIter() : Iterator
Tags
inheritDoc
Return values
Iterator 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results