【PHP8.x】fopen()関数の使い方

Copy
1<?php
2
3/**
4 * Shift_JISでエンコードされたファイルを読み込み、UTF-8に変換して出力します。
5 *
6 * このサンプルは、fopen()で開いたファイルリソースに対して
7 * ストリームフィルターを適用し、読み込み時に文字コードを自動変換する方法を示します。
8 *
9 * @return void
10 */
11function readSjisFileAsUtf8(): void
12{
13    $filename = 'sjis_sample.txt';
14    $originalContent = "こんにちは、世界！\nこれはShift_JISのテキストです。\n";
15
16    // --- 準備: Shift_JISのサンプルファイルを作成 ---
17    // このサンプルを単体で動作させるための準備です。
18    // UTF-8の文字列をShift_JIS (Windowsで一般的なCP932) に変換してファイルに保存します。
19    $sjisContent = mb_convert_encoding($originalContent, 'SJIS-win', 'UTF-8');
20    file_put_contents($filename, $sjisContent);
21
22    // --- 本題: fopenとストリームフィルターによる文字コード変換 ---
23
24    // 'r'モード（読み込み専用）でファイルを開きます。
25    // ファイルが開けない場合は、処理を中断します。
26    $handle = fopen($filename, 'r');
27    if ($handle === false) {
28        echo "エラー: ファイル '{$filename}' を開けませんでした。\n";
29        // 作成したファイルを削除して終了
30        unlink($filename);
31        return;
32    }
33
34    // ストリームフィルターを追加して、読み込み時に文字コードを変換します。
35    // 'convert.iconv.【変換元】/【変換先】' という形式で指定します。
36    // これにより、fgets()などで読み込むデータが自動的にUTF-8に変換されます。
37    stream_filter_append($handle, 'convert.iconv.sjis-win/utf-8');
38
39    echo "--- ファイルから読み込んだ内容 (UTF-8に変換済み) ---\n";
40
41    // ファイルの終端まで1行ずつ読み込んで出力します。
42    while (($line = fgets($handle)) !== false) {
43        // 読み込んだ$lineは、フィルターによって既にUTF-8になっています。
44        echo $line;
45    }
46    echo "--------------------------------------------------\n";
47
48    // ファイルポインタを必ず閉じます。
49    fclose($handle);
50
51    // --- 後片付け: 作成したサンプルファイルを削除 ---
52    unlink($filename);
53}
54
55// 作成した関数を実行します。
56readSjisFileAsUtf8();
57

fopenは、ファイルを開いて操作するための準備をするPHPの基本的な関数です。

第一引数にファイル名、第二引数にどのような目的でファイルを開くかを示す「モード」を文字列で指定します。このサンプルコードでは、読み込み専用を意味する 'r' を指定しています。処理が成功すると、後続のファイル操作で必要となる特別な値「リソース（ファイルハンドル）」を返します。もしファイルが存在しないなどの理由で失敗した場合は false を返すため、エラー処理を行うことが重要です。

このサンプルコードの大きな特徴は、fopenで取得したリソースに対してstream_filter_append関数を使い、文字コードを変換するフィルターを追加している点です。'convert.iconv.sjis-win/utf-8'と指定することで、ファイルからデータを読み込む際にShift_JISからUTF-8へ自動的に変換されるようになります。これにより、fgets関数でファイルの内容を1行ずつ読み込むだけで、手軽にUTF-8エンコーディングの文字列としてデータを扱うことができます。

ファイルの操作が完了したら、最後にfclose関数を使ってリソースを解放し、ファイルを閉じることが推奨されます。

Copy
1<?php
2
3/**
4 * PHPのfopen関数を使用してファイルに書き込むシンプルなサンプルコードです。
5 * 'w' モードは、ファイルが存在しない場合は新規作成し、
6 * 存在する場合は既存の内容をすべてクリアして新しい内容を書き込みます。
7 */
8
9// 1. 書き込みたいファイル名と内容を準備します。
10$filename = 'example_output.txt';
11$content = "これはPHPのfopen関数を使って書き込まれたテストデータです。\n";
12$content .= "新しい行を追加しています。\n";
13$content .= "ファイルが存在する場合は、この内容で上書きされます。\n";
14
15echo "ファイル '{$filename}' への書き込みを開始します...\n";
16
17// 2. ファイルを書き込みモード ('w') で開きます。
18// fopen() は成功するとファイルリソースを返し、失敗すると false を返します。
19$fileHandle = fopen($filename, 'w');
20
21// 3. ファイルが開けたか確認します。
22if ($fileHandle === false) {
23    // ファイルを開けなかった場合、エラーメッセージを表示して処理を中断します。
24    die("エラー: ファイル '{$filename}' を開けませんでした。書き込み権限を確認してください。\n");
25}
26
27// 4. ファイルにデータを書き込みます。
28// fwrite() は書き込んだバイト数を返します。失敗すると false を返します。
29$bytesWritten = fwrite($fileHandle, $content);
30
31// 5. 書き込みが成功したか確認します。
32if ($bytesWritten === false) {
33    echo "エラー: ファイルへの書き込み中に問題が発生しました。\n";
34} else {
35    echo "ファイル '{$filename}' に {$bytesWritten} バイト書き込みました。\n";
36    echo "--- ファイル内容のプレビュー ---\n";
37    echo $content;
38    echo "-------------------------------\n";
39}
40
41// 6. ファイルを閉じます。
42// ファイルリソースを解放し、リソースリークを防ぐために重要です。
43fclose($fileHandle);
44
45echo "ファイル操作が完了しました。\n";
46echo "生成されたファイルは現在のディレクトリにあります。\n";
47
48?>

このサンプルコードは、PHPのfopen関数を使用してファイルにテキストを書き込む基本的な手順を示しています。fopen関数は、第1引数で指定したファイル（$filename）を、第2引数で指定したモード（$mode）で開きます。今回のモード'w'は書き込み専用を意味し、ファイルが存在しない場合は新規作成します。もしファイルが既に存在する場合、その中身はすべて消去されてから新しい内容が書き込まれる点に注意が必要です。fopenは、成功するとファイル操作に使う「リソース」という識別子を返し、失敗した場合はfalseを返します。そのため、サンプルコードのようにif文で戻り値をチェックし、エラー処理を行うことが推奨されます。ファイルが開けたら、fwrite関数を使って、fopenが返したリソースを対象に実際のデータ書き込みを行います。最後に、ファイル操作が完了したら必ずfclose関数でリソースを解放します。ファイルを閉じ忘れると予期せぬ問題の原因となるため、この「開く、書き込む、閉じる」という一連の処理はセットで覚えることが重要です。

Copy
1<?php
2
3/**
4 * 指定されたファイルに文字列を追記します。
5 * ファイルが存在しない場合は新規作成されます。
6 *
7 * @param string $filename 追記対象のファイル名
8 * @param string $content 追記する文字列
9 * @return bool 追記処理が成功した場合は true、失敗した場合は false
10 */
11function appendToFile(string $filename, string $content): bool
12{
13    // 'a' モードでファイルを開く
14    // 'a': 書き込み用にオープンし、ファイルポインタをファイルの終端に置きます。
15    //      ファイルが存在しない場合は作成を試みます。
16    //      PHP 8では、fopenの戻り値はresource型かfalseです。
17    $fileHandle = fopen($filename, 'a');
18
19    // ファイルのオープンに失敗した場合
20    if ($fileHandle === false) {
21        echo "エラー: ファイル '{$filename}' を開けませんでした。\n";
22        return false;
23    }
24
25    // ファイルに内容を書き込む
26    // fwriteは書き込んだバイト数を返すか、エラー時にfalseを返します。
27    if (fwrite($fileHandle, $content) === false) {
28        echo "エラー: ファイル '{$filename}' への書き込みに失敗しました。\n";
29        fclose($fileHandle); // エラー時でもファイルを閉じる
30        return false;
31    }
32
33    // ファイルを閉じる
34    // ファイル操作の後は必ず閉じることが重要です。
35    fclose($fileHandle);
36
37    return true;
38}
39
40// --- 使用例 ---
41$logFilename = 'application_log.txt';
42$logContent1 = date('Y-m-d H:i:s') . " - ユーザーがシステムにログインしました。\n";
43$logContent2 = date('Y-m-d H:i:s') . " - ユーザーがデータ更新を行いました。\n";
44
45// 最初のログメッセージを追記
46if (appendToFile($logFilename, $logContent1)) {
47    echo "ログファイル '{$logFilename}' に最初の内容を追記しました。\n";
48} else {
49    echo "ログファイル '{$logFilename}' への追記に失敗しました。\n";
50}
51
52// さらに別のログメッセージを追記
53// この関数を複数回呼び出すことで、同じファイルに内容がどんどん追加されていきます。
54if (appendToFile($logFilename, $logContent2)) {
55    echo "ログファイル '{$logFilename}' に2番目の内容を追記しました。\n";
56} else {
57    echo "ログファイル '{$logFilename}' への追記に失敗しました。\n";
58}
59
60// このスクリプトを実行すると、'application_log.txt' というファイルが作成（または更新）され、
61// 実行ごとに新しいログ行が追記されます。

PHPのfopen関数は、ファイルを開いて読み書きなどの操作を行うための基本的な機能を提供します。特に「追記」は、既存のファイルに新しい情報を追加したい場合によく使用され、システムログの記録などで役立ちます。

fopen関数は、第一引数に操作対象のファイルパスを、第二引数にファイルのアクセスモードを指定します。追記を行うには、モードとして'a'を指定します。この'a'モードは、ファイルが存在しない場合は新規作成を試み、ファイルが存在する場合はその内容の末尾に書き込みが行われるようにファイルポインタを設定します。

関数が成功すると、ファイル操作に利用する「リソース」（ファイルハンドル）が返されます。このリソースは、ファイルの読み書きを行うfwriteなどの関数で必要となります。ファイルを開くことに失敗した場合はfalseが返されるため、プログラムで必ずエラーチェックを行い、適切に処理を分岐させることが重要です。

サンプルコードでは、appendToFile関数がfopenを'a'モードで使用し、指定された文字列をファイルに追記しています。書き込みが完了した後、fclose関数で開いたファイルを閉じることで、リソースの解放とデータの確実な保存が行われます。これにより、同じファイルに対して繰り返し情報を追加していくことが可能になります。