The RecursiveIteratorIterator class

(PHP 5, PHP 7, PHP 8)

Introduction

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 {

/* Constants */

public const int LEAVES_ONLY;

public const int SELF_FIRST;

public const int CHILD_FIRST;

public const int CATCH_GET_CHILD;

/* Methods */

public function __construct(Traversable $iterator, int $mode = RecursiveIteratorIterator::LEAVES_ONLY, int $flags = 0)

public function beginChildren(): void

public function beginIteration(): void

public function callGetChildren(): ?RecursiveIterator

public function callHasChildren(): bool

public function current(): mixed

public function endChildren(): void

public function endIteration(): void

public function getDepth(): int

public function getInnerIterator(): RecursiveIterator

public function getMaxDepth(): int|false

public function getSubIterator(?int $level = null): ?RecursiveIterator

public function key(): mixed

public function next(): void

public function nextElement(): void

public function rewind(): void

public function setMaxDepth(int $maxDepth = -1): void

public function valid(): bool

}

Predefined Constants

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

Changelog

Version	Description
8.4.0	The class constants are now typed.

RecursiveIteratorIterator::beginChildren — Begin children
RecursiveIteratorIterator::beginIteration — Begin Iteration
RecursiveIteratorIterator::callGetChildren — Get children
RecursiveIteratorIterator::callHasChildren — Has children
RecursiveIteratorIterator::__construct — Construct a RecursiveIteratorIterator
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

The RecursiveIteratorIterator class

Introduction

Class synopsis

Predefined Constants

Changelog

Table of Contents