MultipleIterator::key
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
Gets the registered iterator instances
Description
MultipleIterator::key(): array
Get the registered iterator instances key() result.
Func
Parameters Parameters
Return Values
An array of all registered iterator instances.
Errors/Exceptions
A RuntimeException if the iterator is invalid (as of PHP 8.1.0), or mode MIT_NEED_ALL is set, and at least one attached iterator is not valid.
Calling this method from control-structures.foreach triggers warning "Illegal type returned".
Changelog
| Version | Description |
|---|---|
| 8.1.0 | A RuntimeException is now thrown if MultipleIterator::key is called on an invalid iterator. Previously, false was returned. |
See Also
MultipleIterator::current