RecursiveFilterIterator

abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator (View source)

This abstract iterator filters out unwanted values for a RecursiveIterator.

This class should be extended to implement custom filters. The RecursiveFilterIterator::accept must be implemented in the subclass.

Methods

__construct(Traversable $iterator)

Create a RecursiveFilterIterator from a RecursiveIterator

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()

Check whether the current element of the iterator is acceptable

from  FilterIterator
bool
hasChildren()

Check whether the inner iterator's current element has children

RecursiveIterator|null
getChildren()

Return the inner iterator's children contained in a RecursiveFilterIterator

Details

at line 582
__construct(Traversable $iterator)

Create a RecursiveFilterIterator from a RecursiveIterator

Parameters

Traversable $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.

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

at line 589
bool hasChildren()

Check whether the inner iterator's current element has children

Return Value

bool

true if the current entry can be iterated over, otherwise returns false.

at line 597
RecursiveIterator|null getChildren()

Return the inner iterator's children contained in a RecursiveFilterIterator

Return Value

RecursiveIterator|null

An iterator for the current entry.