MultipleIterator (class)

The MultipleIterator class

Introduction

(PHP 5 >= 5.3.0, PHP 7)

An Iterator that sequentially iterates over all attached iterators

Class synopsis

public void attachIterator ( Iterator $iterator [, string $infos ] )

public bool containsIterator ( Iterator $iterator )

public int countIterators ( void )

public array current ( void )

public void detachIterator ( Iterator $iterator )

public int getFlags ( void )

public array key ( void )

public void next ( void )

public void rewind ( void )

public void setFlags ( int $flags )

public bool valid ( void )

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