SplFileObject::seek

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

SplFileObject::seek — ファイルポインタを指定行に移動させる

説明

public SplFileObject::seek(int $line): void

ファイルポインタを指定行に移動させます。

パラメータ

line: ゼロを起点とした移動させる行数。

戻り値

値を返しません。

エラー / 例外

line が負の値の場合、LogicException がスローされます。

例

例1 SplFileObject::seek() の例

この例はポジション 2 で見つかるスクリプトの第 3 行目を出力します。

<?php
$file = new SplFileObject(__FILE__);
$file->seek(2);
echo $file->current();
?>

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

$file->seek(2);

参考

SplFileObject::current() - ファイルの現在の行を取得する
SplFileObject::key() - 行番号を取得する
SplFileObject::next() - 次の行を読み出す
SplFileObject::rewind() - ファイルポインタを先頭に巻き戻す
SplFileObject::valid() - ファイル終端でないかチェックする

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

info at inatica dot com ¶

3 years ago

there is a bug using fseek on previos versions of PHP8.0.1
See:

https://bugs.php.net/bug.php?id=46569

https://3v4l.org/O89dJ

I solved it with a function:

<?php
/**
* SEEK an Spl object
* There is a bug in php for seeking files
* seems solved php_version > PHP8.0.1
* See https://bugs.php.net/bug.php?id=46569
* & https://3v4l.org/O89dJ
*
* $Spl->seek() Works ok in all versions with offset 0 (first row)
* On PHP_VERSION < 8.0.1:
*  - Offset 1: seek() cannot seek at row 1. It will be done manually, rewind file and reading first row
*  - Rest of Offsets: The cursor remains at next row of $Offset
*
* @param SplObject $Spl
* @param int $Offset
*/

function seek_spl($Spl, $Offset){
    if (version_compare(PHP_VERSION, '8.0.1', '>=') || $Offset == 0) {
        $Spl->seek($Offset);
    } else {
        if( $Offset == 1 ){
            $Spl->rewind(); // Ensure to go at first row before exit
            $Spl->fgets(); // Read line 0. Cursor remains now at line 1
        } else {
            $Spl->seek($Offset-1);
        }
    }
}?>

down

ahmad_maqsood at waku-2 dot com ¶

7 years ago

A sleek way of counting the number of lines in a file can be like below

$file = new \SplFileObject('file.extension', 'r');
$file->seek(PHP_INT_MAX);

echo $file->key() + 1;

＋add a note