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

Copy
1<?php
2
3/**
4 * SplTempFileObject を使って fseek メソッドの基本的な使い方を示すサンプルコードです。
5 * fseek はファイルの読み書き位置をバイトオフセットで移動させるために使用されます。
6 * キーワード「line number」に関連付けて、ファイルを読み進めた後で、
7 * 再びファイルの先頭から読み直すシナリオを想定しています。
8 *
9 * @return void
10 */
11function demonstrateFseekWithSplTempFileObject(): void
12{
13    // SplTempFileObject を作成します。
14    // これはメモリ上またはディスク上に一時ファイルとしてデータを保持するファイルオブジェクトです。
15    $file = new SplTempFileObject();
16
17    // 複数行のサンプルデータを一時ファイルに書き込みます。
18    $file->fwrite("PHPは強力なサーバーサイドスクリプト言語です。\n"); // 1行目
19    $file->fwrite("Web開発で広く利用されています。\n");             // 2行目
20    $file->fwrite("バージョン8ではパフォーマンスが向上しています。\n"); // 3行目
21
22    echo "--- ファイルの最初の読み込み ---\n";
23    // ファイルポインタをファイルの先頭にリセットします。
24    // これにより、ファイルポインタがどこにあっても最初から読み込む準備ができます。
25    $file->rewind();
26
27    // 最初の行を読み込み、表示します。
28    echo "最初の行: " . rtrim($file->fgets()) . "\n"; // 現在、ファイルポインタは2行目の先頭に移動
29
30    // 2行目を読み込み、表示します。
31    echo "次の行: " . rtrim($file->fgets()) . "\n";   // 現在、ファイルポインタは3行目の先頭に移動
32
33    echo "\n--- fseek を使ってファイルポインタを先頭に戻す ---\n";
34    // SplTempFileObject::fseek(int $offset, int $whence = SEEK_SET) を使用して、
35    // ファイルポインタをファイルの先頭（0バイト目）に移動します。
36    // $offset: 移動するバイト数（ここでは0）。
37    // $whence: オフセットの基準（SEEK_SET: ファイルの先頭から、SEEK_CUR: 現在位置から、SEEK_END: ファイルの末尾から）。
38    // SEEK_SET はデフォルト値なので、fseek(0) としても同じ結果になります。
39    // fseek は成功した場合に新しいオフセットを返し（ここでは0）、失敗した場合は -1 を返します。
40    $offset = 0;
41    $whence = SEEK_SET;
42    $seekResult = $file->fseek($offset, $whence);
43
44    if ($seekResult === 0) { // fseekが成功し、オフセットが0になった場合
45        echo "ファイルポインタが先頭に戻りました。\n";
46
47        // ファイルの先頭から再度最初の行を読み込み、表示します。
48        // これで、ファイルが最初から読み取り可能になったことを確認できます。
49        echo "先頭から再度読み込んだ最初の行: " . rtrim($file->fgets()) . "\n";
50    } else {
51        echo "fseek の実行に失敗しました。戻り値: " . $seekResult . "\n";
52    }
53
54    echo "\n--- 特定の行まで読み飛ばした後に、fseek で先頭に戻る例 ---\n";
55    // ファイルポインタを再度先頭に戻します。
56    $file->rewind();
57
58    // 最初の2行を読み飛ばします。
59    // fseek はバイトオフセットを操作するため、直接「N行読み飛ばす」ことはできません。
60    // 行を読み飛ばすには、fgets() をループで使うのが一般的です。
61    echo "1行目をスキップ: " . rtrim($file->fgets()) . "\n";
62    echo "2行目をスキップ: " . rtrim($file->fgets()) . "\n";
63
64    // 現在、ファイルポインタは3行目の先頭にあります。
65    echo "スキップ後の現在の行 (3行目): " . rtrim($file->fgets()) . "\n";
66
67    // ここで再び fseek を使ってファイルの先頭に戻り、最初から読み直します。
68    $file->fseek(0, SEEK_SET); // fseek(0) でも可
69
70    echo "fseek でファイルポインタを先頭に戻しました。\n";
71    echo "再び先頭から読み込んだ行: " . rtrim($file->fgets()) . "\n";
72}
73
74// 上記の関数を実行してデモンストレーションを開始します。
75demonstrateFseekWithSplTempFileObject();

このサンプルコードは、PHP 8で提供されるSplTempFileObjectクラスのfseekメソッドの基本的な使い方を解説しています。SplTempFileObjectは、一時的にデータを格納するためのファイルのように振る舞うオブジェクトです。fseekメソッドは、ファイルの読み書き位置を示すファイルポインタを、指定したバイトオフセットに移動させるために使用されます。

fseekメソッドは、int $offsetとint $whenceの二つの引数を取ります。$offsetは移動させるバイト数を指定し、$whenceは移動の基準点を指定します。SEEK_SETはファイルの先頭から、SEEK_CURは現在の位置から、SEEK_ENDはファイルの末尾からのオフセットを示します。SEEK_SETはデフォルト値のため、省略可能です。このメソッドは、ファイルポインタが移動した新しいオフセット位置を整数値で返しますが、失敗した場合は-1を返します。

サンプルコードでは、まず複数行のデータをSplTempFileObjectに書き込み、fgetsで数行読み進めます。その後、fseek(0, SEEK_SET)を使ってファイルポインタをファイルの先頭（0バイト目）に戻しています。これにより、一度ファイルの途中まで読み進めた後でも、再びファイルの先頭からデータを読み直すことが可能になります。これは、特定の行番号から処理を再開する、あるいはファイルを何度も最初から読み込む必要があるシナリオで役立ちます。fseekはバイト単位で位置を操作するため、直接「行番号」を指定するわけではありませんが、ファイルの先頭に戻ることで、再度1行目から処理を始めることができます。