Iterators
PHP Manual

The LimitIterator class

Introduction

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

Class synopsis

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

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 only
foreach (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 apple
foreach (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