The RecursiveArrayIterator class

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

    Introduction

    This iterator allows for unsetting and modifying 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 */
    public const int ArrayIterator::STD_PROP_LIST;
    public const int ArrayIterator::ARRAY_AS_PROPS;
    /* Constants */
    public const int CHILD_ARRAYS_ONLY;
    /* Methods */
    public getChildren(): ?RecursiveArrayIterator
    public hasChildren(): bool
    /* Inherited methods */
    public ArrayIterator::__construct(array|object $array = [], int $flags = 0)
    public ArrayIterator::append(mixed $value): void
    public ArrayIterator::asort(int $flags = SORT_REGULAR): true
    public ArrayIterator::count(): int
    public ArrayIterator::current(): mixed
    public ArrayIterator::getArrayCopy(): array
    public ArrayIterator::getFlags(): int
    public ArrayIterator::key(): string|int|null
    public ArrayIterator::ksort(int $flags = SORT_REGULAR): true
    public ArrayIterator::natcasesort(): true
    public ArrayIterator::natsort(): true
    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): true
    public ArrayIterator::uksort(callable $callback): true
    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

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top