The MultipleIterator class
From Get docs
Php/docs/latest/class.multipleiterator
The MultipleIterator class
Introduction
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
An Iterator that sequentially iterates over all attached iterators
Class synopsis
class MultipleIterator implements Iterator {
const int MIT_NEED_ANY
= 0;
const int MIT_NEED_ALL
= 1;
const int MIT_KEYS_NUMERIC
= 0;
const int MIT_KEYS_ASSOC
= 2;
/* Methods */
public __construct(int $flags
= MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC)
public attachIterator(Iterator $iterator, string|int|null $info = null): void
public containsIterator(Iterator $iterator): bool
public countIterators(): int
public current(): array|false
public detachIterator(Iterator $iterator): void
public getFlags(): int
public key(): array|false
public next(): void
public rewind(): void
public setFlags(int $flags): void
public 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.
Table of Contents
- MultipleIterator::attachIterator — Attaches iterator information
- MultipleIterator::__construct — Constructs a new MultipleIterator
- MultipleIterator::containsIterator — Checks if an iterator is attached
- MultipleIterator::countIterators — Gets the number of attached iterator instances
- MultipleIterator::current — Gets the registered iterator instances
- MultipleIterator::detachIterator — Detaches an iterator
- MultipleIterator::getFlags — Gets the flag information
- MultipleIterator::key — Gets the registered iterator instances
- MultipleIterator::next — Moves all attached iterator instances forward
- MultipleIterator::rewind — Rewinds all attached iterator instances
- MultipleIterator::setFlags — Sets flags
- MultipleIterator::valid — Checks the validity of sub iterators
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.multipleiterator.php
/* Constants */