Php/docs/function.iterator-apply
iterator_apply
(PHP 5 >= 5.1.0, PHP 7)
iterator_apply — Call a function for every element in an iterator
Description
iterator_apply
( Traversable $iterator
, callable $function
[, array $args
= NULL
] ) : int
Calls a function for every element in an iterator.
Parameters
iterator
The iterator object to iterate over.
function
The callback function to call on every element. This function only receives the given
args
, so it is nullary by default. Ifcount($args) === 3
, for instance, the callback function is ternary.Note:
The function must return
TRUE
in order to continue iterating over theiterator
.args
An array of arguments; each element of
args
is passed to the callbackfunction
as separate argument.
Return Values
Returns the iteration count.
Examples
Example #1 iterator_apply() example
<?phpfunction print_caps(Iterator $iterator) { echo strtoupper($iterator->current()) . "\n"; return TRUE;}$it = new ArrayIterator(array("Apples", "Bananas", "Cherries"));iterator_apply($it, "print_caps", array($it));?>
The above example will output:
APPLES BANANAS CHERRIES