Home/ Manual/ reference / spl/ The RecursiveIteratorIterator class

The RecursiveIteratorIterator class

Guide Edit on GitHub ✎

Can be used to iterate through recursive iterators.

Intro

Can be used to iterate through recursive iterators.

Calls to methods that RecursiveIteratorIterator does not have are forwarded to the iterator at the current depth, as returned by RecursiveIteratorIterator::getSubIterator. This does not use __call().

Class synopsis

class RecursiveIteratorIterator implements OuterIterator { }

Predefined Constants

RecursiveIteratorIterator::LEAVES_ONLY
RecursiveIteratorIterator::SELF_FIRST
RecursiveIteratorIterator::CHILD_FIRST
RecursiveIteratorIterator::CATCH_GET_CHILD

Changelog

Version	Description

Recursiveiteratoriterator

In this section

RecursiveIteratorIterator::__construct

Construct a RecursiveIteratorIterator

RecursiveIteratorIterator::beginChildren

Begin children

RecursiveIteratorIterator::beginIteration

Begin Iteration

RecursiveIteratorIterator::callGetChildren

Get children

RecursiveIteratorIterator::callHasChildren

Has children

RecursiveIteratorIterator::current

Access the current element value

RecursiveIteratorIterator::endChildren

End children

RecursiveIteratorIterator::endIteration

End Iteration

RecursiveIteratorIterator::getDepth

Get the current depth of the recursive iteration

RecursiveIteratorIterator::getInnerIterator

Get inner iterator

RecursiveIteratorIterator::getMaxDepth

Get max depth

RecursiveIteratorIterator::getSubIterator

The current active sub iterator

RecursiveIteratorIterator::key

Access the current key

RecursiveIteratorIterator::next

Move forward to the next element

RecursiveIteratorIterator::nextElement

Next element

RecursiveIteratorIterator::rewind

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

RecursiveIteratorIterator::setMaxDepth

Set max depth

RecursiveIteratorIterator::valid

Check whether the current position is valid

Source: reference/spl/recursiveiteratoriterator.xml · from the official PHP manual (php/doc-en)