The RecursiveArrayIterator class

The RecursiveArrayIterator class

Introduction

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

This iterator allows to unset and modify values and keys while iterating over Arrays and Objects in the same way as the ArrayIterator. Additionally it is possible to iterate over the current iterator entry.

Class synopsis

class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {

/* Inherited constants */

const int STD_PROP_LIST = 1;

const int ARRAY_AS_PROPS = 2;

/* Constants */

const int CHILD_ARRAYS_ONLY = 4;

/* Methods */

public getChildren(): ?RecursiveArrayIterator

public hasChildren(): bool

/* Inherited methods */

public ArrayIterator::append(mixed $value): void

public ArrayIterator::asort(int $flags = SORT_REGULAR): bool

public ArrayIterator::count(): int

public ArrayIterator::current(): mixed

public ArrayIterator::getArrayCopy(): array

public ArrayIterator::getFlags(): int

public ArrayIterator::key(): mixed

public ArrayIterator::ksort(int $flags = SORT_REGULAR): bool

public ArrayIterator::natcasesort(): bool

public ArrayIterator::natsort(): bool

public ArrayIterator::next(): void

public ArrayIterator::offsetExists(mixed $key): bool

public ArrayIterator::offsetGet(mixed $key): mixed

public ArrayIterator::offsetSet(mixed $key, mixed $value): void

public ArrayIterator::offsetUnset(mixed $key): void

public ArrayIterator::rewind(): void

public ArrayIterator::seek(int $offset): void

public ArrayIterator::serialize(): string

public ArrayIterator::setFlags(int $flags): void

public ArrayIterator::uasort(callable $callback): bool

public ArrayIterator::uksort(callable $callback): bool

public ArrayIterator::unserialize(string $data): void

public ArrayIterator::valid(): bool

}

Predefined Constants

RecursiveArrayIterator Flags

RecursiveArrayIterator::CHILD_ARRAYS_ONLY

Treat only arrays (not objects) as having children for recursive iteration.

Table of Contents

• RecursiveArrayIterator::getChildren — Returns an iterator for the current entry if it is an array or an object
• RecursiveArrayIterator::hasChildren — Returns whether current entry is an array or an object

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