RecursiveIteratorIterator

class RecursiveIteratorIterator implements OuterIterator (View source)

Can be used to iterate through recursive iterators.

Constants

LEAVES_ONLY

The default. Lists only leaves in iteration.
SELF_FIRST

Lists leaves and parents in iteration with parents coming first.
CHILD_FIRST

Lists leaves and parents in iteration with leaves coming first.
CATCH_GET_CHILD

Special flag: Ignore exceptions thrown in accessing children.

Methods

__construct(Traversable $iterator, int $mode = self::LEAVES_ONLY, int $flags = 0)

Construct a RecursiveIteratorIterator

void
rewind()

Rewind the iterator to the first element of the top level inner iterator

bool
valid()

Check whether the current position is valid

mixed
key()

Access the current key

mixed
current()

Access the current element value

void
next()

Move forward to the next element

int
getDepth()

Get the current depth of the recursive iteration

RecursiveIterator|null
getSubIterator(int $level)

The current active sub iterator

Iterator|null
getInnerIterator()

Get inner iterator

void
beginIteration()

Begin Iteration

void
endIteration()

End Iteration

bool
callHasChildren()

Has children

RecursiveIterator|null
callGetChildren()

Get children

void
beginChildren()

Begin children

void
endChildren()

End children

void
nextElement()

Next element

void
setMaxDepth(int $maxDepth = -1)

Set max depth

int|false
getMaxDepth()

Get max depth

Details

at line 269
__construct(Traversable $iterator, int $mode = self::LEAVES_ONLY, int $flags = 0)

Since: 5.1.3

Construct a RecursiveIteratorIterator

Parameters

Traversable $iterator
int $mode

[optional] The operation mode. See class constants for details.
int $flags

[optional] A bitmask of special flags. See class constants for details.

at line 280
void rewind()

Rewind the iterator to the first element of the top level inner iterator

Return Value

void

Any returned value is ignored.

at line 288
bool valid()

Check whether the current position 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 296
mixed key()

Access the current key

Return Value

mixed

TKey on success, or null on failure.

at line 304
mixed current()

Access the current element value

Return Value

mixed

Can return any type.

at line 312
void next()

Move forward to the next element

Return Value

void

Any returned value is ignored.

at line 320
int getDepth()

Get the current depth of the recursive iteration

Return Value

int

The current depth of the recursive iteration.

at line 329
RecursiveIterator|null getSubIterator(int $level)

The current active sub iterator

Parameters

int $level [optional]

Return Value

RecursiveIterator|null

The current active sub iterator.

at line 337
Iterator|null getInnerIterator()

Get inner iterator

Return Value

Iterator|null

The inner iterator for the current entry.

at line 345
void beginIteration()

Begin Iteration

Return Value

void

at line 353
void endIteration()

End Iteration

Return Value

void

at line 361
bool callHasChildren()

Has children

Return Value

bool

true if the element has children, otherwise false

at line 369
RecursiveIterator|null callGetChildren()

Get children

Return Value

RecursiveIterator|null

A RecursiveIterator.

at line 377
void beginChildren()

Begin children

Return Value

void

at line 385
void endChildren()

End children

Return Value

void

at line 393
void nextElement()

Next element

Return Value

void

at line 405
void setMaxDepth(int $maxDepth = -1)

Set max depth

Parameters

int $maxDepth

[optional]

The maximum allowed depth. Default -1 is used for any depth.

Return Value

void

at line 413
int|false getMaxDepth()

Get max depth

Return Value

int|false

The maximum accepted depth, or false if any depth is allowed.