【PHP8.x】SEEK_CUR定数の使い方

Copy
1<?php
2
3// このサンプルコードは、PHPのSEEK_CUR定数の使い方を実演します。
4// SEEK_CURは、fseek()関数などでファイルポインタを現在の位置から相対的に移動させる際に使用されます。
5// システムエンジニアを目指す初心者の方にも理解しやすいよう、基本的なファイル操作を含みます。
6
7// 1. 一時ファイル名と書き込む内容を定義します。
8$tempFileName = 'seek_cur_example.txt';
9$fileContent = "Hello World! This is an example string.";
10
11// 2. ファイルを読み書きモード ('w+') でオープンします。
12// 'w+' は、ファイルが存在すれば内容を切り詰め、なければ新規作成し、読み書きを許可します。
13$fileHandle = fopen($tempFileName, 'w+');
14
15if (!$fileHandle) {
16    // ファイルのオープンに失敗した場合のエラーハンドリング
17    die("エラー: ファイル '{$tempFileName}' を開けませんでした。\n");
18}
19
20// 3. ファイルに内容を書き込みます。
21fwrite($fileHandle, $fileContent);
22echo "ファイルに書き込みました: '{$fileContent}'\n";
23
24// 4. ファイルポインタをファイルの先頭に戻します。
25// SEEK_SETは、ファイルの先頭からのオフセットを指定するために使用されます。
26fseek($fileHandle, 0, SEEK_SET);
27echo "ファイルポインタをファイルの先頭に戻しました。\n";
28
29// 5. ファイルの先頭から5バイトを読み込みます。
30// ポインタは読み込み後、"Hello" の次 (oの直後) に移動します。
31$readData1 = fread($fileHandle, 5);
32echo "最初の5バイトを読み込みました: '{$readData1}' (現在ポインタは " . (ftell($fileHandle)) . " バイト目)\n";
33
34// 6. SEEK_CUR定数を使用して、現在のファイルポインタ位置から3バイト進めます。
35// "Hello" の 'o' の次から3バイト進むと、" Wo" をスキップし 'r' の位置に来ます。
36// 元の文字列: H e l l o   W o r l d !  ...
37//             ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
38// ポインタ位置:0 1 2 3 4 5 6 7 8 9 10
39// SEEK_SETで0に移動 -> "Hello" 読み込み (5バイト) -> ポインタは5 (' 'スペース)
40// fseek($fileHandle, 3, SEEK_CUR) -> ポインタは 5 + 3 = 8 ('r') に移動
41fseek($fileHandle, 3, SEEK_CUR);
42echo "現在のファイルポインタ位置から3バイト進めました (SEEK_CURを使用)。現在ポインタは " . (ftell($fileHandle)) . " バイト目\n";
43
44// 7. 現在の位置からさらに5バイトを読み込みます。
45// ポインタは現在 'r' の位置にあるため、"rld! " が読み込まれます。
46$readData2 = fread($fileHandle, 5);
47echo "さらに5バイトを読み込みました: '{$readData2}' (現在ポインタは " . (ftell($fileHandle)) . " バイト目)\n";
48
49// 8. ファイルポインタを閉じます。
50fclose($fileHandle);
51echo "ファイルを閉じました。\n";
52
53// 9. 作成した一時ファイルを削除します。
54if (file_exists($tempFileName)) {
55    unlink($tempFileName);
56    echo "一時ファイル '{$tempFileName}' を削除しました。\n";
57}
58
59?>

PHPのSEEK_CURは、ファイル操作においてファイルポインタの位置を制御するための定数です。主にfseek()関数と共に用いられ、ファイルポインタを「現在の位置」から指定されたバイト数だけ相対的に移動させる際に使用されます。

このサンプルコードでは、まず一時ファイルを作成し、文字列を書き込みます。その後、fseek()関数とSEEK_SET定数を使ってファイルポインタをファイルの先頭に戻し、最初の5バイトを読み込みます。この時点でファイルポインタは5バイト目に位置します。

次に、fseek($fileHandle, 3, SEEK_CUR)のようにSEEK_CURを使用すると、現在のファイルポインタの位置である5バイト目からさらに3バイト進み、合計8バイト目の位置にファイルポインタが移動します。これにより、読み飛ばしたい部分を効率的にスキップできます。その後、この新しい位置から再度5バイトを読み込むことで、期待通りのデータが取得されます。

SEEK_CURは定数であるため、引数を持ちませんし、特定の戻り値もありません。ファイル内の特定の箇所に素早く移動し、必要なデータにアクセスするための重要な機能を提供します。ファイルサイズが大きい場合や、部分的なデータ処理を行う際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * ファイルポインタの現在位置からの相対的な移動（SEEK_CUR）を実演する関数。
5 * システムエンジニアを目指す初心者向けに、ファイル操作の基本を分かりやすく示します。
6 */
7function demonstrateSeekCur(): void
8{
9    $fileName = 'sample.txt';
10    // サンプルとしてファイルに書き込む内容
11    $fileContent = "Hello World!\nThis is a test file.\nPHP is great.";
12
13    // 1. サンプルファイルを作成し、内容を書き込む
14    // file_put_contents はファイルを新規作成または上書きし、データを書き込みます。
15    file_put_contents($fileName, $fileContent);
16    echo "--- ファイル準備 ---\n";
17    echo "ファイルを作成しました: '{$fileName}'\n";
18    echo "ファイル内容:\n\"{$fileContent}\"\n\n";
19
20    // 2. ファイルを読み込みモードで開く
21    // fopen はファイルを開き、そのファイルに対するハンドル（参照）を返します。
22    // 'r' モードは読み込み専用でファイルを開きます。
23    $fileHandle = fopen($fileName, 'r');
24    if (!$fileHandle) {
25        echo "エラー: ファイル '{$fileName}' を開けませんでした。\n";
26        return;
27    }
28
29    echo "--- SEEK_CUR の動作確認 ---\n";
30    // ftell() は現在のファイルポインタの位置をバイト単位で返します。
31    echo "初期ファイルポインタ位置: " . ftell($fileHandle) . " バイト (ファイルの先頭)\n"; // 0
32
33    // 3. fseek() を使ってファイルポインタを移動させる
34    // 最初の fseek は、第3引数を指定しない場合、SEEK_SET（ファイルの先頭から）として扱われます。
35    // 「Hello World!\n」は13バイトなので、その直後に移動します。
36    fseek($fileHandle, 13);
37    echo "fseek(\$fileHandle, 13) で移動後: " . ftell($fileHandle) . " バイト\n"; // 13
38
39    // 4. SEEK_CUR を使って、現在のファイルポインタ位置からさらに移動させる
40    // 現在のポインタ位置は 13 バイト目です。
41    // fseek の第3引数に SEEK_CUR を指定すると、第2引数のオフセット（5）が現在の位置に加算されます。
42    // 13 + 5 = 18 バイト目 に移動します。
43    // (Hello World!\nThis is a test file.\nPHP is great.)
44    //              ^ (13バイト目)
45    //                   ^ (18バイト目、's' の位置)
46    fseek($fileHandle, 5, SEEK_CUR);
47    echo "fseek(\$fileHandle, 5, SEEK_CUR) で移動後: " . ftell($fileHandle) . " バイト\n"; // 18
48
49    // 5. 新しいファイルポインタの位置から内容を読み込む
50    // fread は指定されたバイト数だけファイルからデータを読み込みます。
51    // 現在ポインタは 18 バイト目にあるので、「s is a test f」が読み込まれるはずです。
52    $readContent = fread($fileHandle, 10); // 10バイト読み込む
53    echo "現在の位置から 10 バイト読み込んだ内容: \"{$readContent}\"\n\n";
54
55    // 6. ファイルを閉じる
56    // fclose は開いたファイルを閉じ、システムリソースを解放します。
57    fclose($fileHandle);
58
59    // 7. クリーンアップ：作成したサンプルファイルを削除する
60    unlink($fileName);
61    echo "--- クリーンアップ ---\n";
62    echo "作成したファイル '{$fileName}' を削除しました。\n";
63}
64
65// 関数を実行します
66demonstrateSeekCur();

PHPのSEEK_CURは、ファイル操作においてファイルポインタの移動基準を指定するための定数です。主にfseek()関数と組み合わせて使用され、ファイルポインタを「現在の位置」から指定されたバイト数だけ前後に移動させたい場合に役立ちます。SEEK_CUR自体に引数や戻り値はありませんが、fseek()関数の第3引数として渡すことで、その挙動を制御します。

このサンプルコードでは、SEEK_CURを使ったファイルポインタの相対移動の仕組みを実演しています。まずfile_put_contents()関数で「sample.txt」というファイルを作成し、テストデータを書き込みます。次にfopen()でファイルを読み込みモードで開き、ftell()でファイルポインタの初期位置（0バイト目）を確認します。

コードの重要な部分はfseek()関数の使い方です。最初はfseek($fileHandle, 13)のようにオフセットのみを指定して、ファイルの先頭から13バイト目までポインタを移動させます。その後、fseek($fileHandle, 5, SEEK_CUR)という形でSEEK_CURを使用します。これにより、現在のファイルポインタ位置（13バイト目）からさらに5バイト先に移動し、合計で18バイト目の位置にポインタが移動します。ftell()でこの移動後の位置を再度確認し、fread()で新しいポインタ位置から10バイトのデータを読み込むことで、SEEK_CURによる相対移動が正しく行われたことを示しています。最後にfclose()でファイルを閉じ、unlink()で作成したファイルを削除しクリーンアップしています。SEEK_CURを用いることで、ファイル内の現在位置からの柔軟なポインタ調整が可能となります。