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

Copy
1<?php
2
3/**
4 * PHPのSEEK_END定数を使用してファイルポインタを操作する例。
5 *
6 * SEEK_ENDはfseek関数と共に使用され、ファイルポインタをファイルの末尾からの
7 * 相対位置に設定します。主にファイルの最後の部分を読み書きする際に役立ちます。
8 *
9 * システムエンジニアを目指す初心者の方へ:
10 * ファイルの特定の場所を指す「ファイルポインタ」を操作する際に使われる定数です。
11 * SEEK_ENDは「ファイルの終わり」を意味し、ここからどれくらい前（または後）に
12 * ポインタを移動するかを指定できます。
13 */
14function demonstrateSeekEndUsage(): void
15{
16    // 1. デモンストレーション用の一時ファイルを作成し、内容を書き込む
17    // sys_get_temp_dir(): OSが提供する一時ディレクトリのパスを取得
18    // tempnam(): ユニークなファイル名で一時ファイルを作成
19    $tempFilePath = tempnam(sys_get_temp_dir(), 'seek_end_demo_');
20    if ($tempFilePath === false) {
21        echo "エラー: 一時ファイルの作成に失敗しました。\n";
22        return;
23    }
24
25    $initialContent = "Hello, PHP World!\nThis is a sample file content for SEEK_END demonstration.\n";
26    // file_put_contents(): ファイルに文字列を書き込む
27    if (file_put_contents($tempFilePath, $initialContent) === false) {
28        echo "エラー: ファイルへの書き込みに失敗しました。\n";
29        unlink($tempFilePath); // 失敗時も一時ファイルを削除
30        return;
31    }
32
33    echo "--- デモンストレーション用ファイルの内容 ---\n";
34    echo $initialContent;
35    echo "------------------------------------------\n\n";
36
37    // 2. ファイルを読み書きモードで開く
38    // fopen(): ファイルを開く。'r+' は読み書きモードで、ポインタはファイルの先頭に設定されます。
39    $fileHandle = fopen($tempFilePath, 'r+');
40    if ($fileHandle === false) {
41        echo "エラー: ファイルを開けませんでした。\n";
42        unlink($tempFilePath);
43        return;
44    }
45
46    // ftell(): 現在のファイルポインタの位置を取得
47    echo "現在のファイルポインタ位置: " . ftell($fileHandle) . " (初期状態は0、ファイルの先頭)\n";
48
49    // 3. fseek() 関数と SEEK_END 定数を使ってファイルポインタを操作
50
51    // 例1: ファイルの末尾に移動する
52    // fseek(ファイルハンドル, オフセット, 基点)
53    // SEEK_END を基点とし、オフセット0なので、ファイルポインタはファイルの最終バイトの直後（ファイルのサイズ）に設定されます。
54    fseek($fileHandle, 0, SEEK_END);
55    echo "fseek(\$fileHandle, 0, SEEK_END) 後: " . ftell($fileHandle) . " (ファイルの末尾)\n";
56
57    // 例2: ファイルの末尾から10バイト手前に移動し、その位置からデータを読み込む
58    // 対象の文字列: "demonstration.\n" の最後の10文字 ("stration.\n")
59    // ファイルの内容の末尾が "demonstration.\n" (15文字) であるとします。
60    // その中の "stration.\n" (10文字) を読み込むには、末尾から10バイト手前にポインタを移動します。
61    $offsetFromEnd = -10; // ファイルの末尾から10バイト「手前」に移動するため負の値を指定
62    $bytesToRead = 10;    // 移動した位置から10バイト読み込む
63
64    if (fseek($fileHandle, $offsetFromEnd, SEEK_END) === 0) {
65        echo "fseek(\$fileHandle, " . $offsetFromEnd . ", SEEK_END) 後: " . ftell($fileHandle) . " (末尾から10バイト手前)\n";
66        $readData = fread($fileHandle, $bytesToRead); // fread(): ファイルからデータを読み込む
67        echo "読み込んだデータ: '" . $readData . "'\n"; // "stration.\n" が表示されるはず
68    } else {
69        echo "エラー: ファイルポインタの移動に失敗しました。\n";
70    }
71
72    // 例3: ファイルの先頭近くの特定の文字列を、末尾からのオフセットで読み込む
73    // 文字列 "PHP" を読み込むことを考えます。
74    // "Hello, PHP World!\n..." の "PHP" は、ファイルの先頭から8バイト目から始まります。(インデックスは7)
75    // 全体のバイト数は strlen($initialContent) で得られます。（この例では83バイト）
76    // ファイル先頭から7バイト目 = 末尾から (全体のバイト数 - 7) バイト手前
77    // 83 - 7 = 76 バイト手前
78    $offsetForPHP = -(strlen($initialContent) - 7); // 'P' の位置まで末尾から移動するオフセット
79    $bytesForPHP = 3;                               // "PHP" の3バイトを読み込む
80
81    if (fseek($fileHandle, $offsetForPHP, SEEK_END) === 0) {
82        echo "fseek(\$fileHandle, " . $offsetForPHP . ", SEEK_END) 後: " . ftell($fileHandle) . " (末尾から " . abs($offsetForPHP) . " バイト手前)\n";
83        $readPHP = fread($fileHandle, $bytesForPHP);
84        echo "読み込んだデータ: '" . $readPHP . "'\n"; // "PHP" が表示されるはず
85    } else {
86        echo "エラー: ファイルポインタの移動に失敗しました。\n";
87    }
88
89    // 4. ファイルを閉じ、一時ファイルを削除
90    fclose($fileHandle); // fclose(): ファイルハンドルを閉じる
91    // unlink(): ファイルを削除する
92    if (unlink($tempFilePath)) {
93        echo "\n一時ファイル '" . $tempFilePath . "' を削除しました。\n";
94    } else {
95        echo "\n一時ファイル '" . $tempFilePath . "' の削除に失敗しました。\n";
96    }
97}
98
99// デモンストレーション関数を実行
100demonstrateSeekEndUsage();
101
102?>

PHPのSEEK_ENDは、ファイル操作においてファイルポインタの位置を決定するための定数です。この定数は、主にfseek関数と組み合わせて使用されます。fseek関数は、ファイルハンドル、オフセット値、そして基点（どこを基準にオフセットを適用するか）の3つの引数を取ります。SEEK_ENDを基点として指定すると、ファイルポインタの移動が「ファイルの末尾」を基準に行われます。

具体的には、fseek関数でSEEK_ENDを指定し、オフセットを0に設定すると、ファイルポインタはファイルの最終バイトの直後、つまりファイルの末尾に移動します。また、オフセットに負の値を指定することで、ファイルの末尾から指定されたバイト数だけ手前にポインタを移動させることができます。これにより、ファイルの最後の部分を読み込んだり、上書きしたりする際に、ファイル全体のサイズを知ることなく相対的な位置指定が可能となります。

例えば、ファイルの末尾から特定のデータを読み込みたい場合や、ファイルに新しい内容を追記する前に末尾にポインタを移動させたい場合にSEEK_ENDは非常に有効です。SEEK_END定数自体は引数を持たず、内部的にはint型の整数値を返します。ファイルの一部を効率的に操作する上で重要な役割を果たす定数と言えます。

Copy
1<?php
2
3/**
4 * fseek() 関数と SEEK_END 定数を使ってファイルポインタを操作する例。
5 *
6 * SEEK_END は fseek() 関数の引数として使用され、ファイルポインタを
7 * ファイルの末尾からの相対位置に設定するための定数です。
8 * 例えば、ファイルの末尾から0のオフセットは、ファイルの最後の位置を指します。
9 *
10 * @return void
11 */
12function demonstrateFseekSeekEnd(): void
13{
14    // 一時ファイルの名前と内容を定義します。
15    $fileName = 'example_seek_file.txt';
16    $fileContent = "Hello, PHP!\nThis is a test file for fseek and SEEK_END.\n";
17
18    // 1. ファイルを作成し、内容を書き込みます。
19    // 'w+' モードでファイルを開くと、ファイルがなければ作成され、
20    // 既に存在する場合は内容が空になり、読み書き両用でアクセスできます。
21    $fileHandle = fopen($fileName, 'w+');
22    if (!$fileHandle) {
23        echo "エラー: ファイル '$fileName' を開けませんでした。\n";
24        return;
25    }
26
27    fwrite($fileHandle, $fileContent);
28    echo "ファイル '$fileName' に内容を書き込みました。\n";
29    echo "ファイルの内容:\n---\n" . $fileContent . "---\n";
30
31    // 2. fseek() と SEEK_END を使って、ファイルポインタをファイルの末尾に移動させます。
32    // オフセット 0 は、ファイルの末尾から0バイトの位置、つまりファイルの終端です。
33    fseek($fileHandle, 0, SEEK_END);
34    echo "ファイルポインタをファイルの末尾に移動しました (fseek(\$fileHandle, 0, SEEK_END)).\n";
35
36    // 3. 現在のファイルポインタの位置を確認します。
37    // ftell() は現在のファイルポインタの位置をバイト数で返します。
38    $currentPosition = ftell($fileHandle);
39    echo "現在のファイルポインタの位置: $currentPosition バイト。\n";
40    echo "この位置はファイルの総バイト数 (" . strlen($fileContent) . " バイト) と等しいはずです。\n";
41
42    // 4. SEEK_END を使って、ファイルの末尾から特定のオフセットに移動し、そこから読み込む例。
43    // 例えば、末尾から10バイト手前に移動してみます。
44    $offsetFromEnd = -10; // 末尾から10バイト手前
45    if (strlen($fileContent) >= abs($offsetFromEnd)) { // ファイルの内容が十分な長さか確認
46        fseek($fileHandle, $offsetFromEnd, SEEK_END);
47        echo "ファイルポインタを末尾から $offsetFromEnd バイトの位置に移動しました (fseek(\$fileHandle, $offsetFromEnd, SEEK_END)).\n";
48
49        $currentPositionAfterSeek = ftell($fileHandle);
50        echo "現在のファイルポインタの位置: $currentPositionAfterSeek バイト。\n";
51
52        // その位置から残りの内容を読み込みます。
53        $remainingContent = fread($fileHandle, 1024); // 最大1024バイトまで読み込みます
54        echo "その位置から読み込んだ内容: '{$remainingContent}'\n";
55    } else {
56        echo "ファイルの内容が短いため、末尾から $offsetFromEnd バイト手前への移動はスキップします。\n";
57    }
58
59    // 5. ファイルを閉じます。
60    fclose($fileHandle);
61    echo "ファイルを閉じました。\n";
62
63    // 6. 後処理として一時ファイルを削除します。
64    if (file_exists($fileName)) {
65        unlink($fileName);
66        echo "一時ファイル '$fileName' を削除しました。\n";
67    }
68}
69
70// 関数を実行します。
71demonstrateFseekSeekEnd();

PHPのSEEK_END定数は、ファイルポインタを操作するfseek()関数の第三引数として用いられる整数型の定数です。この定数を指定すると、fseek()関数はファイルポインタの移動基準を「ファイルの末尾」とします。例えば、オフセットに0を指定しfseek($handle, 0, SEEK_END)と記述すると、ファイルポインタはファイルの最終位置に移動します。

サンプルコードでは、まずexample_seek_file.txtという一時ファイルを作成し、内容を書き込んでいます。その後、fseek($fileHandle, 0, SEEK_END)を使ってファイルポインタをファイルの末尾に移動させ、ftell()関数でその位置がファイルの総バイト数と一致することを確認しています。ftell()は現在のファイルポインタの位置をバイト数で返します。さらに、fseek($fileHandle, -10, SEEK_END)のようにオフセットに負の値を指定することで、ファイルの末尾から10バイト手前など、相対的な位置への移動も可能です。これは、ファイルの最終部分だけを読み込んだり、ファイルの末尾に新しいデータを追記したりする際に非常に便利な機能です。一連の処理の最後にファイルは閉じられ、作成した一時ファイルは削除されます。このように、SEEK_END定数を使うことで、ファイルの末尾を基準とした柔軟なファイルポインタ操作が可能になります。