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

LimitIterator::seek

PHP function Edit on GitHub ✎

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

Seek to the given position

Description

LimitIterator::seek(int $offset): int

Moves the iterator to the offset specified by offset.

Parameters

offset

The position to seek to.

Return Values

Returns the offset position after seeking.

Errors/Exceptions

Throws an OutOfBoundsException if the position is outside of the limits specified in LimitIterator::__construct.

See Also

  • LimitIterator::current
  • LimitIterator::key
  • LimitIterator::rewind
  • LimitIterator::next
  • LimitIterator::valid

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