SeekableIterator::seek

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

SeekableIterator::seek位置を移動する

説明

public SeekableIterator::seek(int $offset): void

イテレータ内の指定した位置に移動します。

パラメータ

offset

移動先の位置。

戻り値

値を返しません。

エラー / 例外

offset に移動できない場合、 OutOfBoundsException をスローするよう実装しなければなりません。

例1 SeekableIterator::seek() の例

イテレータの 3 番目の位置に移動します (ArrayIteratorSeekableIterator を実装しています)。

<?php
$array 
= array("apple""banana""cherry""damson""elderberry");
$iterator = new ArrayIterator($array);
$iterator->seek(3);
echo 
$iterator->current();
?>

上の例の出力は、 たとえば以下のようになります。

damson

関連キーワード:  移動, 位置, SeekableIterator, offset, 例外, 実装, public, int, パラメータ, エラー