LimitIterator::getPosition

(PHP 5 >= 5.1.0, PHP 7)

Return the current position

public int LimitIterator::getPosition ( void )

Gets the current zero-based position of the inner Iterator.

Returns:

The current position.

Examples:

LimitIterator::getPosition() example

<?php
$fruits = array(
    'a' => 'apple',
    'b' => 'banana',
    'c' => 'cherry',
    'd' => 'damson',
    'e' => 'elderberry'
);
$array_it = new ArrayIterator($fruits);
$limit_it = new LimitIterator($array_it, 2, 3);
foreach ($limit_it as $item) {
    echo $limit_it->getPosition() . ' ' . $item . "\n";
}
?>

The above example will output:

2 cherry
3 damson
4 elderberry