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

Copy
1<?php
2
3/**
4 * ファイルポインタ操作で SEEK_SET 定数を使用するサンプルコード。
5 *
6 * SEEK_SET は、fseek() 関数の第3引数に指定することで、
7 * ファイルの先頭から指定されたオフセット（バイト数）の位置に
8 * ファイルポインタを移動させることを意味します。
9 */
10function demonstrateSeekSet(): void
11{
12    // 一時ファイルの名前を定義します。
13    $filePath = 'seek_set_example.txt';
14    // ファイルに書き込む内容を準備します。
15    $fileContent = "Hello PHP Seek_Set!\nThis is a test line.";
16
17    // ファイルを書き込み/読み込みモードで開きます。
18    // 'w+' モードはファイルが存在しない場合は作成し、存在する場合は内容を上書きします。
19    $fileHandle = fopen($filePath, 'w+');
20
21    if ($fileHandle === false) {
22        echo "エラー: ファイル '{$filePath}' を開けませんでした。\n";
23        return;
24    }
25
26    // ファイルに内容を書き込みます。
27    fwrite($fileHandle, $fileContent);
28    echo "ファイルに以下の内容を書き込みました:\n\"" . $fileContent . "\"\n\n";
29
30    // fseek() を使用してファイルポインタを移動させます。
31    // 第2引数はオフセット（バイト数）、第3引数は基準位置です。
32    // SEEK_SET はファイルの先頭を基準とします。
33    // 例えば、オフセット 6 は 'H'(0), 'e'(1), 'l'(2), 'l'(3), 'o'(4), ' '(5), 'P'(6) なので、'P' の位置からになります。
34    $offset = 6;
35    echo "SEEK_SET を使用してファイルポインタを先頭から {$offset} バイト目に移動します...\n";
36
37    if (fseek($fileHandle, $offset, SEEK_SET) === 0) {
38        echo "ファイルポインタが正常に移動しました。\n";
39
40        // ポインタが移動した位置から残りの内容を読み込みます。
41        $readContent = fread($fileHandle, 1024); // 最大1024バイト読み込む
42        echo "移動後のファイルポインタから読み込んだ内容:\n\"" . $readContent . "\"\n";
43    } else {
44        echo "エラー: ファイルポインタの移動に失敗しました。\n";
45    }
46
47    // ファイルを閉じます。
48    fclose($fileHandle);
49
50    // 作業終了後、一時ファイルを削除します。
51    if (unlink($filePath)) {
52        echo "\n一時ファイル '{$filePath}' を削除しました。\n";
53    } else {
54        echo "\nエラー: 一時ファイル '{$filePath}' の削除に失敗しました。\n";
55    }
56}
57
58// 関数を実行します。
59demonstrateSeekSet();

PHPのSEEK_SETは、ファイル操作においてファイルポインタの位置を制御するための組み込み定数です。主にfseek()関数と組み合わせて使用され、ファイルポインタを「ファイルの先頭」を基準として移動させたい場合に指定します。SEEK_SET自体は引数を取らず、整数値（int）として定義されています。

提供されたサンプルコードでは、まず一時ファイルを作成し、任意の文字列を書き込んでいます。その後、fseek($fileHandle, $offset, SEEK_SET)という形でSEEK_SET定数が利用されています。ここでfseek()関数の第2引数$offsetに指定されたバイト数が、SEEK_SETで指定された基準位置、つまりファイルの先頭から数えられ、ファイルポインタはそのバイト数だけ移動します。サンプルコードでは、ファイルの先頭から6バイト目にポインタを移動させ、その位置からファイルを読み出すことで、SEEK_SETが正しく機能していることを実証しています。これにより、ファイルの任意の位置から読み書きを開始できるようになり、ファイル内の特定のデータに直接アクセスするような処理を効率的に実装できます。

Copy
1<?php
2
3/**
4 * ファイルポインタ操作の定数 (SEEK_SET, SEEK_CUR, SEEK_END) の使用例を示します。
5 * fseek() 関数とこれらの定数の動作を、システムエンジニアを目指す初心者にも分かりやすく解説します。
6 *
7 * SEEK_SET: ファイルの先頭からのオフセットを設定します。
8 * SEEK_CUR: 現在のファイルポインタの位置からのオフセットを設定します。
9 * SEEK_END: ファイルの末尾からのオフセットを設定します (通常、負のオフセットを使用)。
10 */
11function demonstrateFileSeekConstants(): void
12{
13    // 一時ファイルを作成し、テスト用の内容を書き込む
14    $tempFile = tempnam(sys_get_temp_dir(), 'php_seek_');
15    if ($tempFile === false) {
16        echo "エラー: 一時ファイルの作成に失敗しました。\n";
17        return;
18    }
19
20    $fileContent = "Hello, PHP Seek Example!";
21    file_put_contents($tempFile, $fileContent);
22
23    // ファイルを読み書きモードで開く
24    $fp = fopen($tempFile, 'r+');
25    if ($fp === false) {
26        echo "エラー: ファイルを開くのに失敗しました: " . $tempFile . "\n";
27        unlink($tempFile); // エラー時は一時ファイルを削除
28        return;
29    }
30
31    echo "=== ファイルポインタ操作のデモンストレーション ===\n";
32    echo "ファイル内容: \"" . $fileContent . "\"\n";
33    echo "ファイルパス: " . $tempFile . "\n\n";
34
35    // 1. SEEK_SET の使用例: ファイルの先頭から指定した位置へ移動
36    echo "--- 1. SEEK_SET (先頭からのオフセット) ---\n";
37    echo "現在のポインタ位置: " . ftell($fp) . " (初期位置)\n"; // 初期位置は0
38
39    // ファイルの先頭から5バイト目 (0-indexed) に移動
40    fseek($fp, 5, SEEK_SET);
41    echo "fseek(\$fp, 5, SEEK_SET) 後、ポインタ位置: " . ftell($fp) . "\n";
42    // 移動した位置から5文字読み込む
43    echo "読み込んだ文字: \"" . fread($fp, 5) . "\"\n\n"; // " PHP " を読み込む
44
45    // 2. SEEK_CUR の使用例: 現在のポインタ位置から指定した分だけ移動
46    echo "--- 2. SEEK_CUR (現在位置からのオフセット) ---\n";
47    echo "現在のポインタ位置: " . ftell($fp) . "\n"; // SEEK_SET と fread() 後
48
49    // 現在の位置からさらに3バイト進む
50    fseek($fp, 3, SEEK_CUR);
51    echo "fseek(\$fp, 3, SEEK_CUR) 後、ポインタ位置: " . ftell($fp) . "\n";
52    // 新しい位置から5文字読み込む
53    echo "読み込んだ文字: \"" . fread($fp, 5) . "\"\n\n"; // "Examp" を読み込む
54
55    // 3. SEEK_END の使用例: ファイルの末尾から指定した分だけ移動 (通常は負のオフセット)
56    echo "--- 3. SEEK_END (末尾からのオフセット) ---\n";
57    echo "現在のポインタ位置: " . ftell($fp) . "\n"; // SEEK_CUR と fread() 後
58
59    // ファイルの末尾から5バイト手前に移動
60    fseek($fp, -5, SEEK_END);
61    echo "fseek(\$fp, -5, SEEK_END) 後、ポインタ位置: " . ftell($fp) . "\n";
62    // 末尾から5バイトを読み込む
63    echo "読み込んだ文字: \"" . fread($fp, 5) . "\"\n\n"; // "ample" を読み込む
64
65    // ファイルを閉じる
66    fclose($fp);
67
68    // デモンストレーションで使用した一時ファイルを削除
69    unlink($tempFile);
70    echo "一時ファイル \"" . $tempFile . "\" を削除しました。\n";
71    echo "=== デモンストレーション終了 ===\n";
72}
73
74// 関数を実行し、デモンストレーションを開始
75demonstrateFileSeekConstants();

PHPのSEEK_SET、SEEK_CUR、SEEK_ENDは、ファイル内の読み書き位置（ファイルポインタ）を操作する際にfseek()関数と組み合わせて使用する定数です。これらの定数は、fseek()関数の第三引数に指定することで、ファイルポインタをどこを基準に移動させるかを決定します。

具体的に、SEEK_SETはファイルの先頭を基準点とし、指定されたオフセット（バイト数）だけポインタを移動させます。例えば、fseek($fp, 10, SEEK_SET)はファイルの先頭から10バイト目の位置にポインタを移動します。SEEK_CURは現在のファイルポインタの位置を基準とし、指定されたオフセット分だけポインタを移動させます。例えば、現在位置から5バイト先に進みたい場合はfseek($fp, 5, SEEK_CUR)と記述します。また、SEEK_ENDはファイルの末尾を基準とし、通常は負のオフセットを指定して末尾から手前に移動する際に用います。

これらの定数自体は引数を取らず、PHPの内部で定義された整数値（int型）として扱われます。サンプルコードでは、一時ファイルを作成し、fseek()関数と各定数を活用してファイルポインタを移動させ、その位置からデータを読み取る一連の流れが示されています。これにより、ファイル全体を読み込むことなく、特定の箇所に直接アクセスし、必要なデータだけを効率的に読み書きする処理が実現できます。