MultipleIterator::attachIterator
Attaches iterator information
Description
public void MultipleIterator::attachIterator(Iterator $iterator, stringintnull $info = null)
Attaches an iterator, together with its associated information. Attached
iterators are iterated over in the order in which they were attached.
If iterator is already attached, its associated
information is replaced with info, unless
info is identical to the information it already has.
Parameters
-
iterator
-
The new iterator to attach.
-
info
-
The associated information for the iterator, which must be an
int, a string, or
null. With
MultipleIterator::MIT_KEYS_ASSOC, it is used as the
key of the iterator's values in the arrays returned by
MultipleIterator::current and
MultipleIterator::key.
Return Values
No value is returned.
Errors/Exceptions
Throws an InvalidArgumentException if
info is not null and is identical to the
information associated with an iterator that is already attached.
See Also
- MultipleIterator::detachIterator
- MultipleIterator::containsIterator
- MultipleIterator::__construct