LimitIterator::__construct
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
LimitIterator::__construct — Construct a LimitIterator
Description
Constructs a new LimitIterator from an
iterator
with a given starting
offset
and maximum limit
.
Parameters
-
iterator
-
The Iterator to limit.
-
offset
-
Optional offset of the limit.
-
limit
-
Optional count of the limit.
Errors/Exceptions
Throws a ValueError
if the offset
is less than 0
or the limit
is less than -1
.
Changelog
Version | Description |
---|---|
8.0.0 |
Now throws a ValueError if
offset is less than 0 ;
previously it threw a RuntimeException.
|
8.0.0 |
Now throws a ValueError if
limit is less than -1 ;
previously it threw a RuntimeException.
|
Examples
Example #1 LimitIterator::__construct() example
<?php
$ait = new ArrayIterator(array('a', 'b', 'c', 'd', 'e'));
$lit = new LimitIterator($ait, 1, 3);
foreach ($lit as $value) {
echo $value . "\n";
}
?>
The above example will output:
b c d