【PHP8.x】fileプロパティの使い方

Copy
1<?php
2
3/**
4 * ファイルの内容を読み込み、RequestParseBodyExceptionが発生した場合にファイル名をログに出力する例
5 *
6 * @return void
7 */
8function processFile(): void
9{
10    $filename = 'example.txt';
11
12    try {
13        $content = file_get_contents($filename); // ファイルの内容を読み込む
14
15        if ($content === false) {
16            throw new Exception("ファイルの読み込みに失敗しました。");
17        }
18
19        echo "ファイルの内容: " . $content . PHP_EOL;
20
21    } catch (Exception $e) {
22        //RequestParseBodyException は継承元のExceptionで代用
23        error_log("ファイル " . $filename . " の処理中にエラーが発生しました: " . $e->getMessage());
24    }
25}
26
27// 関数の実行
28processFile();

RequestParseBodyExceptionのfileプロパティについて解説します。このプロパティは、PHPがHTTPリクエストのボディ部分を解析する際に問題が発生した場合にスローされる、RequestParseBodyExceptionという特殊な例外オブジェクトに含まれる情報です。

fileプロパティは、エラーの原因となった一時ファイルのパスを文字列（string型）で返します。このプロパティは値を取得するだけで、呼び出す際に引数は必要ありません。主に、ファイルアップロード処理などで不正なデータが送信された際に、どのファイルが問題を引き起こしたのかを特定し、デバッグやログ記録に役立てるために使用されます。

サンプルコードは、ファイル処理における一般的なエラーハンドリングの考え方を示しています。file_get_contents関数でファイルを読み込む処理をtryブロック内に記述し、もし読み込みに失敗して例外が発生した場合にはcatchブロックで処理を続行します。その際、エラーが発生したファイル名（変数 $filename）をエラーメッセージに含めてログに出力しています。RequestParseBodyExceptionのfileプロパティも、これと同様に例外オブジェクトから直接エラー原因のファイルパスを取得し、問題解決に活用するために使われます。

Copy
1<?php
2
3// 例外をキャッチして、エラー情報をファイルに書き込むサンプル
4try {
5    // 何らかのエラーが発生する可能性のある処理
6    $data = file_get_contents('non_existent_file.txt');
7    echo $data;
8
9} catch (Exception $e) {
10    // 例外が発生した場合、RequestParseBodyException が発生していなくても、
11    // 例外オブジェクトからファイル名を取得してログに記録する。
12
13    // エラーメッセージとファイル名を取得
14    $errorMessage = $e->getMessage();
15    // RequestParseBodyException の場合、file プロパティが存在するはずだが、
16    // 他の例外の場合も考慮してプロパティの存在を確認する。
17    $file = property_exists($e, 'file') ? $e->file : 'unknown';
18
19    // ログファイルにエラー情報を書き込む
20    $logMessage = sprintf(
21        "Error: %s in %s on line %d\n",
22        $errorMessage,
23        $file,
24        $e->getLine()
25    );
26    file_put_contents('error.log', $logMessage, FILE_APPEND);
27
28    echo "エラーが発生しました。詳細は error.log を確認してください。\n";
29}

このサンプルコードは、PHPで例外処理を行い、発生したエラーに関する情報をログファイルに書き出す例を示しています。try-catchブロックを使用し、エラーが発生する可能性のある処理をtryブロック内に記述します。もしtryブロック内で例外が発生した場合、catchブロックが実行されます。

このコードでは、file_get_contents関数を使って存在しないファイルを読み込もうとしているため、例外が発生します。catchブロックでは、発生した例外オブジェクト $e から、エラーメッセージ ($e->getMessage()) と、エラーが発生したファイル名 ($e->file)、そして行番号 ($e->getLine()) を取得しています。

RequestParseBodyException クラスの file プロパティは、エラーが発生したファイル名を文字列で返します。ただし、他の種類の例外が発生した場合、fileプロパティが存在しない可能性があるため、property_exists関数を使ってプロパティの存在を確認しています。もしプロパティが存在しない場合は、ファイル名として 'unknown' が使用されます。

取得したエラー情報 (エラーメッセージ、ファイル名、行番号) は、sprintf関数を使って整形され、file_put_contents関数によって error.log ファイルに追記されます。FILE_APPEND フラグを使用することで、ログファイルにエラー情報が追記されるようになります。最後に、エラーが発生したことをユーザーに知らせるメッセージが表示されます。このサンプルは、エラー発生時のデバッグを容易にするための、基本的なログ出力処理を理解するのに役立ちます。