FilterIterator

abstract class FilterIterator extends IteratorIterator (View source)

This abstract iterator filters out unwanted values. This class should be extended to implement custom iterator filters. The FilterIterator::accept must be implemented in the subclass.

Methods

__construct(Traversable $iterator)

Construct a filterIterator

Iterator|null
getInnerIterator()

Get the inner iterator

void
rewind()

Rewind the iterator

bool
valid()

Check whether the current element is valid

TKey|null
key()

Get the current key

TValue
current()

Get the current element value

void
next()

Move the iterator forward

bool
accept()

Check whether the current element of the iterator is acceptable

Details

at line 556
__construct(Traversable $iterator)

Construct a filterIterator

Parameters

Traversable $iterator

at line 608
Iterator|null getInnerIterator()

Get the inner iterator

Return Value

Iterator|null

The inner iterator for the current entry.

at line 563
void rewind()

Rewind the iterator

Return Value

void

Any returned value is ignored.

at line 572
bool valid()

Check whether the current element is valid

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 581
TKey|null key()

Get the current key

Return Value

TKey|null

TKey on success, or null on failure.

at line 590
TValue current()

Get the current element value

Return Value

TValue

Can return any type.

at line 599
void next()

Move the iterator forward

Return Value

void

Any returned value is ignored.

at line 547
abstract bool accept()

Check whether the current element of the iterator is acceptable

Return Value

bool

true if the current element is acceptable, otherwise false.