MultipleIterator (class)
The MultipleIterator class
Introduction
(PHP 5 >= 5.3.0, PHP 7)
An Iterator that sequentially iterates over all attached iterators
Class synopsis
MultipleIterator implements Iterator {
/* Constants */
const integer MIT_NEED_ANY = 0 ;
const integer MIT_NEED_ALL = 1 ;
const integer MIT_KEYS_NUMERIC = 0 ;
const integer MIT_KEYS_ASSOC = 2 ;
/* Methods */
public __construct ( int $flags = MultipleIterator::MIT_NEED_ALL|MultipleIterator::MIT_KEYS_NUMERIC )
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
← LimitIterator::valid
MultipleIterator::attachIterator →
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
