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

Copy
1<?php
2
3/**
4 * SplFileObject::rewind() メソッドのサンプルコード
5 *
6 * このコードは、SplFileObject がファイルポインタを巻き戻せるイテレータとして機能することを示します。
7 * SplFileObject は、ファイルをメモリ全体にロードせずに行単位で処理できるため、PHP のジェネレータと似た
8 * メモリ効率の良いデータ処理が可能です。さらに、rewind() メソッドにより、ファイル読み込みの
9 * ポインタを先頭に戻して、複数回イテレーションを実行できる（rewindable）点が特徴です。
10 * 一般的な PHP のジェネレータは一度イテレーションが終了すると巻き戻せないため、この点は重要な違いです。
11 */
12
13// 一時ファイルを作成し、サンプルデータを書き込む
14$tempFile = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'sample_data.txt';
15file_put_contents($tempFile, "Line 1\nLine 2\nLine 3\n");
16
17// SplFileObject のインスタンスを作成
18// 'r' モードでファイルを開き、イテレータとして使用可能にする
19try {
20    $file = new SplFileObject($tempFile, 'r');
21} catch (RuntimeException $e) {
22    // ファイルが開けない場合のエラーハンドリング
23    echo "ファイルを開けませんでした: " . $e->getMessage() . "\n";
24    exit(1);
25}
26
27echo "--- 1回目のファイル読み込み ---\n";
28// SplFileObject を foreach ループでイテレートし、ファイルの内容を1行ずつ読み込む
29foreach ($file as $lineNumber => $line) {
30    echo sprintf("Line %d: %s", $lineNumber + 1, trim($line)) . "\n";
31}
32
33// rewind() メソッドを呼び出し、ファイルポインタをファイルの先頭に戻す
34// これにより、SplFileObject を再度先頭からイテレートできるようになります。
35$file->rewind();
36
37echo "\n--- 2回目のファイル読み込み (rewind() 後) ---\n";
38// ファイルポインタが先頭に戻ったので、再度ファイルの内容を読み込む
39foreach ($file as $lineNumber => $line) {
40    echo sprintf("Line %d: %s", $lineNumber + 1, trim($line)) . "\n";
41}
42
43// プログラム終了前に一時ファイルを削除
44unlink($tempFile);
45

SplFileObjectは、ファイルをメモリに全て読み込むことなく、行単位で効率的に処理するためのPHPの組み込みクラスです。これにより、メモリ使用量を抑えながら大きなファイルの内容にアクセスできます。SplFileObject::rewind()メソッドは、このオブジェクトが現在指しているファイル内の読み込み位置（ファイルポインタ）をファイルの先頭に戻す役割を持ちます。このメソッドに引数はなく、戻り値もありません。

rewind()メソッドを使用することで、一度読み込みが完了したファイルを、再度最初から読み直すことが可能になります。一般的なPHPのジェネレータは一度最後まで処理を進めると巻き戻せませんが、SplFileObjectはrewind()メソッドを持つため、繰り返しデータにアクセスできる「巻き戻し可能なイテレータ」として機能します。

サンプルコードでは、一時ファイルに書き込んだデータをSplFileObjectで一度読み込んだ後、rewind()メソッドを呼び出してファイルポインタを先頭に戻し、再度同じファイルを最初から読み込んでいます。これは、ファイルの内容を複数回処理する必要がある場面で非常に有効な機能です。

Copy
1<?php
2
3/**
4 * SplFileObject::rewind() メソッドのデモンストレーション。
5 * このメソッドは、ファイルポインタをファイルの先頭に戻します。
6 * ファイルを複数回読み込みたい場合などに使用します。
7 */
8function demonstrateSplFileObjectRewind(): void
9{
10    // 1. 一時ファイルを作成し、内容を書き込む
11    // tempnam() で一時ファイルのパスを取得し、file_put_contents() で内容を書き込みます。
12    // スクリプト終了時に手動で削除する必要があるため、注意が必要です。
13    $tempFilePath = tempnam(sys_get_temp_dir(), 'php_rewind_');
14
15    if ($tempFilePath === false) {
16        echo "エラー: 一時ファイルの作成に失敗しました。\n";
17        return;
18    }
19
20    $contents = "Line 1: First line of text.\nLine 2: Second line example.\nLine 3: Third line for demonstration.\n";
21    file_put_contents($tempFilePath, $contents);
22
23    echo "--- 一時ファイルに内容を書き込みました ---\n";
24    echo "ファイルパス: " . $tempFilePath . "\n\n";
25
26    // 2. SplFileObject を使用してファイルを開く
27    // 'r' モードで読み込み専用として開きます。
28    // SplFileObject はファイルの内容を行ごとにイテレートするのに便利です。
29    $file = new SplFileObject($tempFilePath, 'r');
30
31    echo "--- 1回目のファイル読み込み ---\n";
32    // ファイルから行ごとに読み込み、ファイルポインタを進めます。
33    foreach ($file as $lineNum => $line) {
34        echo "行 " . ($lineNum + 1) . ": " . trim($line) . "\n";
35    }
36
37    echo "\n--- SplFileObject::rewind() の呼び出し ---\n";
38    // SplFileObject::rewind() メソッドを呼び出し、ファイルポインタをファイルの先頭に戻します。
39    // このメソッドは引数を受け取らず、戻り値もありません。
40    $file->rewind();
41    echo "ファイルポインタがファイルの先頭に戻されました。\n";
42
43    echo "\n--- 2回目のファイル読み込み (rewind() 後) ---\n";
44    // ファイルポインタが先頭に戻ったことを確認するため、再度ファイルから読み込みます。
45    // rewind() が正しく機能していれば、1回目と同じ内容が再度表示されます。
46    foreach ($file as $lineNum => $line) {
47        echo "行 " . ($lineNum + 1) . ": " . trim($line) . "\n";
48    }
49
50    // 3. 使用した一時ファイルを削除する
51    // tempnam() で作成したファイルは自動で削除されないため、明示的に削除します。
52    unlink($tempFilePath);
53    echo "\n--- 一時ファイルを削除しました ---\n";
54}
55
56// 関数を実行
57demonstrateSplFileObjectRewind();
58
59?>

PHPのSplFileObject::rewind()メソッドは、ファイルを開いているSplFileObjectインスタンスのファイルポインタを、ファイルの先頭に戻すための機能を提供します。このメソッドは引数を一切受け取らず、特定の戻り値もありません。

サンプルコードでは、まず一時ファイルを作成し、「Line 1」「Line 2」といった複数の行を書き込んでいます。次に、この一時ファイルをSplFileObjectとして読み込み専用で開き、foreachループを使ってファイルの内容を1行ずつ読み込み、表示しています。これにより、ファイルポインタはファイルの終端まで進みます。

ファイルの内容を一度読み終えた後、再度ファイルの先頭から読み直したい場合にrewind()メソッドが役立ちます。コードでは、$file->rewind();と呼び出すことで、ファイルポインタをファイルの先頭位置に戻しています。その後、再度foreachループを使ってファイルを読み込むと、1回目と同じ内容が最初から表示され、rewind()が正しく機能していることを確認できます。この機能は、ファイルを複数回処理する必要がある場面で非常に便利です。最後に、作成した一時ファイルを適切に削除しています。