php8.5
Home/ Manual/ spl / limititerator/ LimitIterator::getPosition

LimitIterator::getPosition

PHP function Edit on GitHub ✎

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

Return the current position

Description

LimitIterator::getPosition(): int

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

Parameters Parameters

Return Values

The current position.

Examples

LimitIterator::getPosition() example

php
<?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:

output
2 cherry
3 damson
4 elderberry

See Also

  • FilterIterator::key

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