The MultipleIterator class

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

Introduction

An Iterator that sequentially iterates over all attached iterators

Class synopsis

classMultipleIteratorimplementsIterator {
publicconstintMIT_NEED_ANY;
publicconstintMIT_NEED_ALL;
publicconstintMIT_KEYS_ASSOC;
public__construct(int$flags = MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC)
publicattachIterator(Iterator$iterator, string|int|null$info = null): void
publiccontainsIterator(Iterator$iterator): bool
publiccurrent(): array
publicdetachIterator(Iterator$iterator): void
publicgetFlags(): int
publickey(): array
publicnext(): void
publicrewind(): void
publicsetFlags(int$flags): void
publicvalid(): bool
}

Predefined Constants

MultipleIterator::MIT_NEED_ANY

Do not require all sub iterators to be valid in iteration.

MultipleIterator::MIT_NEED_ALL

Require all sub iterators to be valid in iteration.

MultipleIterator::MIT_KEYS_NUMERIC

Keys are created from the sub iterators position.

MultipleIterator::MIT_KEYS_ASSOC

Keys are created from sub iterators associated information.

Table of Contents

To Top