The LimitIterator class

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

Introduction

The LimitIterator class allows iteration over a limited subset of items in an Iterator.

Class synopsis

class LimitIterator extends IteratorIterator {
/* Methods */
public __construct(Iterator $iterator, int $offset = 0, int $limit = -1)
public current(): mixed
public getPosition(): int
public key(): mixed
public next(): void
public rewind(): void
public seek(int $offset): int
public valid(): bool
/* Inherited methods */
}

Examples

Example #1 LimitIterator usage example

<?php// Create an iterator to be limited$fruits = new ArrayIterator(array(    'apple',    'banana',    'cherry',    'damson',    'elderberry'));// Loop over first three fruits onlyforeach (new LimitIterator($fruits, 0, 3) as $fruit) {    var_dump($fruit);}echo "\n";// Loop from third fruit until the end// Note: offset starts from zero for appleforeach (new LimitIterator($fruits, 2) as $fruit) {    var_dump($fruit);}?>

The above example will output:

string(5) "apple"
string(6) "banana"
string(6) "cherry"

string(6) "cherry"
string(6) "damson"
string(10) "elderberry"

Table of Contents