The RecursiveIteratorIterator class

From Get docs
Php/docs/latest/class.recursiveiteratoriterator


The RecursiveIteratorIterator class

Introduction

(PHP 5, PHP 7, PHP 8)

Can be used to iterate through recursive iterators.

Class synopsis

class RecursiveIteratorIterator implements OuterIterator {

/* Constants */

const int LEAVES_ONLY = 0;

const int SELF_FIRST = 1;

const int CHILD_FIRST = 2;

const int CATCH_GET_CHILD = 16;

/* Methods */

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

public beginChildren(): void
public beginIteration(): void
public callGetChildren(): ?RecursiveIterator
public callHasChildren(): ?bool
public current(): mixed
public endChildren(): void
public endIteration(): void
public getDepth(): int
public getInnerIterator(): RecursiveIterator
public getMaxDepth(): int|false
public getSubIterator(?int $level = null): ?RecursiveIterator
public key(): mixed
public next(): void
public nextElement(): void
public rewind(): void
public setMaxDepth(int $maxDepth = -1): void
public valid(): bool

/* Inherited methods */

public OuterIterator::getInnerIterator(): ?Iterator

}

Predefined Constants

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

Table of Contents


© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.recursiveiteratoriterator.php