Php/docs/class.limititerator
(PHP 5 >= 5.1.0, PHP 7)
Introduction
The LimitIterator class allows iteration over a limited subset of items in an Iterator.
Class synopsis
LimitIterator extends IteratorIterator implements OuterIterator {
public __construct
( Iterator $iterator
[, int $offset = 0
[, int $count = -1
]] )
public getInnerIterator ( ) : Iterator
public getPosition ( ) : int
public next ( ) : void
public rewind ( ) : void
public seek
( int $position
) : int
public valid ( ) : bool
}
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
- LimitIterator::__construct — Construct a LimitIterator
- LimitIterator::current — Get current element
- LimitIterator::getInnerIterator — Get inner iterator
- LimitIterator::getPosition — Return the current position
- LimitIterator::key — Get current key
- LimitIterator::next — Move the iterator forward
- LimitIterator::rewind — Rewind the iterator to the specified starting offset
- LimitIterator::seek — Seek to the given position
- LimitIterator::valid — Check whether the current element is valid
/* Methods */