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

Copy
1<?php
2
3/**
4 * SplFileObject::fread メソッドの基本的な使い方を示す関数です。
5 * ファイルから指定されたバイト数のデータを読み込みます。
6 */
7function demonstrateSplFileObjectFread(): void
8{
9    // 1. テスト用のファイルパスと内容を準備します
10    $filePath = 'example_file_for_fread.txt';
11    $content = "Hello, PHP 8!\nThis is a sample file for fread method.\n";
12
13    // テストファイルを作成し、データを書き込みます。
14    // ファイル作成に失敗した場合は処理を終了します。
15    if (file_put_contents($filePath, $content) === false) {
16        echo "エラー: テストファイルの作成に失敗しました。\n";
17        return;
18    }
19    echo "テストファイル '{$filePath}' を作成しました。\n";
20
21    try {
22        // 2. SplFileObject のインスタンスを作成し、読み込みモード ('r') でファイルを開きます。
23        // ファイルが開けない場合は RuntimeException がスローされます。
24        $file = new SplFileObject($filePath, 'r');
25        echo "\n'{$filePath}' を SplFileObject で開きました。\n";
26
27        // 3. fread() を使ってファイルから最初の10バイトを読み込みます。
28        // freadは指定されたバイト数だけ読み込み、ファイルポインタを移動させます。
29        $lengthToReadFirst = 10;
30        echo "\nファイルから最初の {$lengthToReadFirst} バイトを読み込みます...\n";
31        $data1 = $file->fread($lengthToReadFirst);
32
33        // 読み込みが成功したかを確認します。失敗した場合は false が返されます。
34        if ($data1 !== false) {
35            echo "読み込んだデータ (1回目): \"{$data1}\"\n";
36            // 現在のファイルポインタの位置を表示し、読み込みによってポインタが移動したことを示します。
37            echo "現在のファイルポインタ位置: " . $file->ftell() . "バイト\n";
38        } else {
39            echo "エラー: 1回目のファイルの読み込みに失敗しました。\n";
40        }
41
42        // 4. ファイルポインタは前回の読み込みによって移動しています。
43        //    続けて次の15バイトを読み込みます。
44        $lengthToReadSecond = 15;
45        echo "\n続けて次の {$lengthToReadSecond} バイトを読み込みます...\n";
46        $data2 = $file->fread($lengthToReadSecond);
47
48        if ($data2 !== false) {
49            echo "読み込んだデータ (2回目): \"{$data2}\"\n";
50            echo "現在のファイルポインタ位置: " . $file->ftell() . "バイト\n";
51        } else {
52            echo "エラー: 2回目のファイルの読み込みに失敗しました。\n";
53        }
54
55        // 5. ファイルの終端 (EOF: End Of File) に到達したか確認します。
56        // EOFに到達していれば true、まだであれば false を返します。
57        if ($file->eof()) {
58            echo "\nファイルの終端 (EOF) に到達しました。\n";
59        } else {
60            echo "\nまだファイルの終端ではありません。\n";
61        }
62
63    } catch (RuntimeException $e) {
64        // ファイルが見つからない、読み込み権限がないなどのエラーを捕捉します。
65        echo "エラー: ファイル操作中に問題が発生しました - " . $e->getMessage() . "\n";
66    } finally {
67        // 6. 処理の最後に、作成したテストファイルを削除してクリーンアップします。
68        if (file_exists($filePath)) {
69            unlink($filePath);
70            echo "\nテストファイル '{$filePath}' を削除しました。\n";
71        }
72    }
73}
74
75// 関数を実行します
76demonstrateSplFileObjectFread();

SplFileObject::fread() メソッドは、PHPでファイルの内容を読み込む際に使用される重要な機能です。このメソッドは、SplFileObject クラスのインスタンスが表す開かれたファイルから、指定したバイト数分のデータを取得します。

引数 $length には、ファイルから読み込みたいバイト数を整数で指定します。例えば $file->fread(10) とすると、現在のファイルポインタの位置から 10 バイトのデータを読み込もうとします。読み込みに成功した場合、そのデータは文字列として返されますが、ファイルの終端に達した場合や読み込みエラーが発生した場合は false が戻り値となります。

このメソッドの大きな特徴は、データを読み込んだ後、ファイルポインタが自動的に読み込んだバイト数分だけ先に進むことです。これにより、続けて fread() を呼び出すと、前回の読み込みの続きからデータを取得でき、ファイルを順番に処理していくことが可能になります。

サンプルコードでは、テストファイルを作成し、SplFileObject で読み込みモードで開いた後、この fread() メソッドを複数回使用しています。最初に 10 バイト、次に 15 バイトを読み込むことで、ファイルポインタが移動し、その都度異なる部分のデータが取得される様子が具体的に示されています。このように、fread() はファイルの内容を必要な分だけ細かく読み進める際に非常に役立ちます。エラーハンドリングやファイルのクリーンアップも適切に行われています。

Copy
1<?php
2
3// このスクリプトは、SplFileObject::fread メソッドを使用して
4// ファイルからバイト単位でデータを読み込み、
5// 読み込んだデータの中から改行コードを検出して行として処理する方法を示します。
6
7// 一時ファイルを作成し、サンプルデータを書き込みます。
8$filename = 'sample_file.txt';
9$content_to_write = "Hello PHP!\nThis is the second line.\nAnd the last line.";
10file_put_contents($filename, $content_to_write);
11
12try {
13    // SplFileObject を読み込みモード ('r') で開きます。
14    $file = new SplFileObject($filename, 'r');
15    
16    $buffer = ''; // 読み込んだデータを一時的に保持するバッファ
17    $lineNumber = 1; // 行番号をカウントするための変数
18    
19    echo "--- SplFileObject::fread を使ってファイルを行ごとに読み込みます ---\n";
20
21    // ファイルの終端 (EOF) に達するまでループします。
22    while (!$file->eof()) {
23        // fread を使ってファイルから指定したバイト数 (ここでは10バイト) を読み込みます。
24        // fread はバイト単位で読み込むため、直接「1行」を読み込むわけではありません。
25        $chunk = $file->fread(10);
26        
27        // 読み込みに失敗した場合 (例: ファイルが開かれていない、読み取り権限がないなど)
28        if ($chunk === false) {
29            echo "エラー: ファイルの読み込みに失敗しました。\n";
30            break; // ループを終了します
31        }
32        
33        // 読み込んだチャンクをバッファに追加します。
34        $buffer .= $chunk;
35
36        // バッファ内に改行コード (LF) が存在するかをチェックします。
37        while (($pos = strpos($buffer, "\n")) !== false) {
38            // 改行コードまでの部分を1行として取り出します。
39            // $pos + 1 は改行コードを含めるためです。
40            $line = substr($buffer, 0, $pos + 1);
41            
42            // 読み込んだ行を表示します。rtrim で末尾の改行コードを削除して表示します。
43            echo "行 " . $lineNumber++ . ": " . rtrim($line, "\n") . "\n";
44            
45            // 処理した行をバッファから削除し、残りのデータを次の処理に回します。
46            $buffer = substr($buffer, $pos + 1);
47        }
48    }
49
50    // ファイルの終端に達した後、バッファに残っているデータがあれば、それが最後の行です。
51    // (例: ファイルが改行で終わっていない場合)
52    if (!empty($buffer)) {
53        echo "行 " . $lineNumber++ . ": " . rtrim($buffer, "\n") . "\n";
54    }
55    
56} catch (RuntimeException $e) {
57    // SplFileObject の操作で発生した例外をキャッチします。
58    echo "ファイル操作中にエラーが発生しました: " . $e->getMessage() . "\n";
59} finally {
60    // スクリプト終了後、作成した一時ファイルを削除します。
61    if (file_exists($filename)) {
62        unlink($filename);
63    }
64}

PHPのSplFileObject::freadメソッドは、ファイルから指定されたバイト数（$length）のデータを読み込む際に使用します。読み込みに成功すると、読み込んだデータを文字列として返しますが、ファイルの終端に達した場合や、何らかの理由で読み込みに失敗した場合はfalseを返します。

このサンプルコードは、freadがバイト単位でデータを読み込む特性を利用して、ファイルを行単位で処理する方法を示しています。まず一時ファイルを作成し、複数行のサンプルデータを書き込みます。その後、SplFileObjectを読み込みモードで開き、ファイルの終端に達するまでループ処理を行います。ループ内でfreadを呼び出し、指定されたバイト数（ここでは10バイト）のデータをファイルから読み込み、それを一時的なバッファに追記します。バッファ内に改行コード（\n）が見つかった場合、その改行コードまでの部分を1行として切り出し、行番号とともに表示します。

freadは直接1行を読み込むのではなく、指定されたバイト数だけを読み込むため、このようにバッファリングと改行コードの検出を組み合わせることで、バイト単位の読み込みから行単位の処理を実現しています。ファイル終端に達した後もバッファに残っているデータがあれば、それが最後の行として処理されます。また、ファイル操作中に発生する可能性のあるエラーはtry-catchブロックで適切に処理され、使用した一時ファイルはスクリプトの最後に削除されるようになっています。