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

Copy
1<?php
2
3/**
4 * SplFileObject::getCurrentLine() メソッドの基本的な使用例を示す関数。
5 *
6 * この関数は一時的なテキストファイルを作成し、その内容を SplFileObject を使って読み込みます。
7 * ファイルを一行ずつ処理しながら getCurrentLine() メソッドを呼び出し、
8 * 現在の行の内容を取得して表示します。
9 * これはファイルから特定の行の内容を取得する際の標準的なパターンです。
10 */
11function demonstrateSplFileObjectGetCurrentLine(): void
12{
13    // 一時ファイルに書き込むサンプルデータ
14    $fileContent = [
15        "これは一行目のテキストです。",
16        "二行目にはこの情報が含まれます。",
17        "そして、これが最後の三行目です。"
18    ];
19
20    // 一時ファイルのパスを生成（システムの一時ディレクトリを使用）
21    $tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'spl_file_object_example_' . uniqid() . '.txt';
22
23    // 一時ファイルにデータを書き込む
24    // PHP_EOL はOSに応じた改行コードを表します
25    file_put_contents($tempFilePath, implode(PHP_EOL, $fileContent));
26
27    echo "--- ファイル内容の読み込み開始 ---" . PHP_EOL;
28
29    try {
30        // SplFileObject のインスタンスを作成し、読み込みモード ('r') でファイルを開く
31        $file = new SplFileObject($tempFilePath, 'r');
32
33        // ファイルの終端まで一行ずつ反復処理する
34        // SplFileObject は Iterator インターフェースを実装しているため、foreach で直接処理できます
35        foreach ($file as $lineNumber => $line) {
36            // getCurrentLine() メソッドを使用して現在の行の生の内容（改行文字含む）を取得
37            $currentLineContent = $file->getCurrentLine();
38
39            // 行番号と取得した内容を表示 (trim() で末尾の改行文字を削除)
40            echo "行 " . ($lineNumber + 1) . ": " . trim($currentLineContent) . PHP_EOL;
41        }
42
43    } catch (RuntimeException $e) {
44        // ファイルが見つからない、読み込み権限がないなどのエラーを捕捉
45        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
46    } finally {
47        // スクリプトの実行終了後、作成した一時ファイルを確実に削除する
48        if (file_exists($tempFilePath)) {
49            unlink($tempFilePath);
50            echo "一時ファイル '" . $tempFilePath . "' を削除しました。" . PHP_EOL;
51        }
52    }
53
54    echo "--- ファイル内容の読み込み終了 ---" . PHP_EOL;
55}
56
57// 関数を実行して SplFileObject::getCurrentLine() の動作を確認
58demonstrateSplFileObjectGetCurrentLine();

PHP 8のSplFileObject::getCurrentLine()メソッドは、ファイルの内容をオブジェクトとして扱うためのSplFileObjectクラスに属し、現在処理中の行の内容を取得するために使用されます。このメソッドは引数を必要とせず、現在読み込まれている行の生のテキストデータを文字列（string）としてそのまま返します。この際、行末の改行コードも含まれて返されるのが特徴です。

提供されたサンプルコードは、このメソッドの基本的な使い方を示しています。まず、プログラムが一時的なテキストファイルを作成し、そこに数行のサンプルデータを書き込みます。次に、SplFileObjectのインスタンスを生成してこの一時ファイルを開き、foreachループを使ってファイルの内容を一行ずつ反復処理します。ループ内で$file->getCurrentLine()を呼び出すことで、現在処理している行のテキストを確実に取得し、行番号とともに表示しています。これにより、ファイルから特定の行の内容を読み取り、それをプログラム内で利用する際の一般的なパターンを理解できます。また、ファイル操作におけるエラーへの対応や、使用後に作成した一時ファイルを確実に削除する方法も含まれており、堅牢なファイル処理の基本を学ぶことができます。