(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::fseek — ファイルポインタを移動させる
$offset
, int $whence
= SEEK_SET
): int
offset
を whence
で指定される位置に追加することで、ファイルの始めからバイト単位でファイルポイントを移動させます。
offset
オフセットです。負の値はポインタを戻すために使うことができます。これは SEEK_END が whence
の値として使われるときに便利です。
whence
whence
の値は次のようなものになります:
SEEK_SET
- offset
バイトに等しい位置にセットします。SEEK_CUR
- 現在の位置に offset
を加えた位置にセットします。SEEK_END
- 終端に offset
を加えた位置にセットします。
whence
が指定されない場合、SEEK_SET
が前提になります。
探索が成功した場合は 0、そうでなければ -1 が返されます。終端より先の位置を探索してもエラーにならないことにご注意してください。
例1 SplFileObject::fseek() の例
<?php
$file = new SplFileObject("somefile.txt");
// 最初の行を読み込む
$data = $file->fgets();
// ファイルの最初に戻る
// $file->rewind(); と同じ
$file->fseek(0);
?>