【PHP8.x】SplFileObject::seek()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplFileObject::seek メソッドを使用して、ファイルの最終行に移動し内容を読み込むサンプルコードです。
5 * ファイルが存在しない場合は作成し、実行後には削除します。
6 */
7
8// 一時ファイル名
9$filename = 'seek_example.txt';
10
11// サンプルデータを含む一時ファイルを作成
12// SplFileObject::seek は0-indexedの行番号で動作するため、
13// count() で得られる総行数から1を引いた値が最終行のインデックスになります。
14$fileContent = "This is line 0.\n";
15$fileContent .= "This is line 1.\n";
16$fileContent .= "This is line 2.\n";
17$fileContent .= "This is the final line, line 3.\n";
18file_put_contents($filename, $fileContent);
19
20try {
21    // SplFileObject のインスタンスを作成
22    // 'r' モードで読み込み用にファイルを開きます
23    $file = new SplFileObject($filename, 'r');
24
25    // ファイルの総行数を取得
26    // SplFileObject は Countable インターフェースを実装しており、count() で行数を取得できます。
27    $totalLines = count($file);
28
29    echo "ファイル総行数: " . $totalLines . "行\n";
30
31    if ($totalLines > 0) {
32        // 最終行のインデックスを計算
33        // seek は0-indexed (最初の行が0、2番目の行が1...) で行を指定します。
34        // count() は総行数を返すため、最終行のインデックスは「総行数 - 1」です。
35        $lastLineIndex = $totalLines - 1;
36
37        // seek メソッドで最終行にファイルポインタを移動
38        $file->seek($lastLineIndex);
39        echo "ファイルポインタを最終行 (インデックス: " . $lastLineIndex . ") に移動しました。\n";
40
41        // 現在のファイルポインタの位置から行を読み込み
42        $contentOfLastLine = $file->fgets();
43        echo "最終行の内容: " . trim($contentOfLastLine) . "\n";
44    } else {
45        echo "ファイルは空です。\n";
46    }
47
48} catch (RuntimeException $e) {
49    // ファイルが開けない場合などのエラーを捕捉
50    echo "エラーが発生しました: " . $e->getMessage() . "\n";
51} finally {
52    // 使用した一時ファイルを削除
53    if (file_exists($filename)) {
54        unlink($filename);
55        echo "一時ファイル '" . $filename . "' を削除しました。\n";
56    }
57}

このPHPのサンプルコードは、SplFileObjectクラスが提供するseekメソッドを用いて、ファイルポインタをファイル内の特定の行へ移動させる方法を解説しています。SplFileObjectは、ファイルをオブジェクト指向で操作するためのPHPの組み込みクラスです。

seekメソッドは、引数として整数型の$lineを取ります。この$lineには、ファイルの先頭から数えて移動したい行のインデックス（番号）を指定します。重要な点として、この行番号は「0」から始まる0-indexedであるため、ファイルの最初の行はインデックス「0」、2番目の行は「1」となります。このメソッドは何も値を返しません。

サンプルコードでは、まず一時的なテキストファイルを作成し、いくつかの行を書き込みます。次に、このファイルをSplFileObjectとして読み込みモードで開きます。SplFileObjectはCountableインターフェースを実装しているため、count()関数を使用することでファイル全体の総行数を簡単に取得できます。ファイルの最終行へ移動する例を示すため、総行数から1を引いた値（$totalLines - 1）をseekメソッドに渡しています。これにより、ファイルポインタが最終行の先頭に移動し、その後fgets()メソッドを使って最終行の内容を読み込むことができます。処理が完了した後、作成した一時ファイルは確実に削除されます。ファイルが開けないなどのエラーが発生した場合は、try-catchブロックで適切に処理されるようになっています。