CallbackFilterIterator

Since: 5.4

class CallbackFilterIterator extends FilterIterator (View source)

Filtered iterator using the callback to determine which items are accepted or rejected.

Methods

__construct(Traversable $iterator, callable $callback)

Creates a filtered iterator using the callback to determine which items are accepted or rejected.

Iterator|null
getInnerIterator()

Get the inner iterator

from  FilterIterator
void
rewind()

Rewind the iterator

from  FilterIterator
bool
valid()

Check whether the current element is valid

from  FilterIterator
mixed
key()

Get the current key

from  FilterIterator
mixed
current()

Get the current element value

from  FilterIterator
void
next()

Move the iterator forward

from  FilterIterator
bool
accept()

This method calls the callback with the current value, current key and the inner iterator.

Details

at line 162
__construct(Traversable $iterator, callable $callback)

Creates a filtered iterator using the callback to determine which items are accepted or rejected.

Parameters

Traversable $iterator
callable $callback

The callback, which should return TRUE to accept the current item or FALSE otherwise. May be any valid callable value. The callback should accept up to three arguments: the current item, the current key and the iterator, respectively. function my_callback($current, $key, $iterator)

in FilterIterator at line 566
Iterator|null getInnerIterator()

Get the inner iterator

Return Value

Iterator|null

The inner iterator for the current entry.

in FilterIterator at line 529
void rewind()

Rewind the iterator

Return Value

void

Any returned value is ignored.

in FilterIterator at line 537
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.

in FilterIterator at line 544
mixed key()

Get the current key

Return Value

mixed

TKey on success, or null on failure.

in FilterIterator at line 551
mixed current()

Get the current element value

Return Value

mixed

Can return any type.

in FilterIterator at line 558
void next()

Move the iterator forward

Return Value

void

Any returned value is ignored.

at line 170
bool accept()

This method calls the callback with the current value, current key and the inner iterator.

The callback is expected to return TRUE if the current item is to be accepted, or FALSE otherwise.

Return Value

bool

true if the current element is acceptable, otherwise false.