php8.5
Home/ Manual/ spl / appenditerator/ AppendIterator::getIteratorIndex

AppendIterator::getIteratorIndex

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

Gets an index of iterators

Description

AppendIterator::getIteratorIndex(): int|null

Gets the index of the current inner iterator.

Parameters Parameters

Return Values

Returns the zero-based, integer index of the current inner iterator if it exists, or null otherwise.

Examples

AppendIterator.getIteratorIndex basic example

php
<?php
$array_a = new ArrayIterator(array('a' => 'aardwolf', 'b' => 'bear', 'c' => 'capybara'));
$array_b = new ArrayIterator(array('apple', 'orange', 'lemon'));

$iterator = new AppendIterator;
$iterator->append($array_a);
$iterator->append($array_b);

foreach ($iterator as $key => $current) {
    echo $iterator->getIteratorIndex() . '  ' . $key . ' ' . $current . PHP_EOL;
}
?>

The above example will output:

output
0  a aardwolf
0  b bear
0  c capybara
1  0 apple
1  1 orange
1  2 lemon

See Also

  • AppendIterator::getInnerIterator
  • AppendIterator::getArrayIterator

Source: reference/spl/appenditerator/getiteratorindex.xml · from the official PHP manual (php/doc-en)