The MultipleIterator class

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

Introduction

An Iterator that iterates over all attached iterators in parallel. At each step, it yields an array containing the current element of each attached iterator, and moves all of them forward together.

Class synopsis

class MultipleIterator implements Iterator {
/* Constants */
public const int MIT_NEED_ANY;
public const int MIT_NEED_ALL;
public const int MIT_KEYS_NUMERIC;
public const int MIT_KEYS_ASSOC;
/* Methods */
public function __construct(int $flags = MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC)
public function attachIterator(Iterator $iterator, string|int|null $info = null): void
public function containsIterator(Iterator $iterator): bool
public function countIterators(): int
public function current(): array
public function detachIterator(Iterator $iterator): void
public function getFlags(): int
public function key(): array
public function next(): void
public function rewind(): void
public function setFlags(int $flags): void
public function valid(): 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.

Changelog

Version Description
8.4.0 The class constants are now typed.

Table of Contents