【PHP8.x】getFileメソッドの使い方

Copy
1<?php
2
3/**
4 * PHPのエラーをErrorExceptionとしてスローするカスタムエラーハンドラを設定します。
5 * これにより、try-catchブロックでWarningやNoticeを捕捉できるようになります。
6 *
7 * @param int    $severity エラーレベル
8 * @param string $message  エラーメッセージ
9 * @param string $file     エラーが発生したファイル名
10 * @param int    $line     エラーが発生した行番号
11 * @throws ErrorException
12 */
13set_error_handler(function (int $severity, string $message, string $file, int $line): void {
14    // error_reportingの設定に従い、抑制されているエラーは無視する
15    if (!(error_reporting() & $severity)) {
16        return;
17    }
18    throw new ErrorException($message, 0, $severity, $file, $line);
19});
20
21/**
22 * エラーを発生させ、その内容を取得して表示する関数。
23 */
24function triggerErrorAndGetFileContent(): void
25{
26    try {
27        // 意図的に警告(Warning)を発生させます。
28        // 未定義の配列キーにアクセスすると E_WARNING が発生します。
29        $array = [];
30        echo $array['undefined_key'];
31    } catch (ErrorException $e) {
32        // ErrorExceptionオブジェクトからエラーが発生したファイルパスを取得します。
33        $errorFilePath = $e->getFile();
34        $errorLine = $e->getLine();
35
36        echo "エラー情報:\n";
37        echo "========================================\n";
38        echo "メッセージ: " . $e->getMessage() . "\n";
39        echo "ファイル: " . $errorFilePath . "\n";
40        echo "行番号: " . $errorLine . "\n";
41        echo "========================================\n\n";
42
43        // getFile()で取得したパスを使い、file_get_contents()でファイル内容を取得します。
44        if (file_exists($errorFilePath)) {
45            $fileContent = file_get_contents($errorFilePath);
46            $lines = explode("\n", $fileContent);
47
48            // エラーが発生した行のコードを取得して表示します（行番号は1から始まるため-1する）。
49            $errorLineContent = $lines[$errorLine - 1] ?? '[エラー行の取得に失敗しました]';
50
51            echo "エラーが発生したファイルの該当箇所のコード:\n";
52            echo "----------------------------------------\n";
53            echo "{$errorLine}: " . trim($errorLineContent) . "\n";
54            echo "----------------------------------------\n";
55        } else {
56            echo "エラーが発生したファイルが見つかりませんでした: {$errorFilePath}\n";
57        }
58    } finally {
59        // スクリプトの他の部分に影響を与えないよう、エラーハンドラを元に戻します。
60        restore_error_handler();
61    }
62}
63
64// 関数を実行します。
65triggerErrorAndGetFileContent();

このPHPサンプルコードは、ErrorExceptionクラスのgetFileメソッドの利用例を示しています。getFileメソッドは、例外が発生したファイルの名前をフルパスの文字列として取得します。このメソッドに引数は必要ありません。

コードの前半ではset_error_handler関数を使用し、PHPの警告（Warning）や通知（Notice）といった通常のエラーを、捕捉可能なErrorExceptionという例外に変換するよう設定しています。これにより、try-catch構文でエラーを処理できるようになります。

tryブロックの中で意図的に未定義の配列キーへアクセスし、警告を発生させます。この警告は設定したエラーハンドラによってErrorExceptionとしてスローされ、続くcatchブロックで捕捉されます。

catchブロック内では、捕捉した例外オブジェクト$eに対して$e->getFile()を呼び出しています。これにより、エラーが発生したファイルの絶対パスが文字列として返されます。サンプルコードでは、この返されたパスをfile_get_contents関数に渡し、ファイルの内容を読み込んでいます。そして、同じくErrorExceptionが持つgetLineメソッドで取得した行番号と組み合わせることで、エラー箇所のソースコードを特定し表示するという、より詳細なデバッグ情報を生成しています。

Copy
1<?php
2
3/**
4 * ErrorException::getFile() メソッドの動作をデモンストレーションします。
5 * このメソッドは、エラーが発生したファイルの名前（パスを含む）を文字列で返します。
6 *
7 * ErrorException は通常、PHP 内部で発生したエラー（警告、非推奨など）を
8 * set_error_handler() 関数などでオブジェクトとして扱う際に利用されます。
9 * ここでは、デモンストレーションのために直接インスタンス化しています。
10 */
11function demonstrateErrorExceptionGetFile(): void
12{
13    // ErrorException のインスタンスを生成します。
14    // 第4引数にファイル名、第5引数に行番号を指定します。
15    // __FILE__ は現在のスクリプトのファイルパスを、__LINE__ はこの行番号を返します。
16    $errorMessage = "テスト用のカスタムエラーが発生しました。";
17    $errorCode = 1; // 任意のエラーコード
18    $errorSeverity = E_USER_ERROR; // エラーの重大度 (例: E_ERROR, E_WARNING)
19    $filename = __FILE__; // エラーが発生したファイルとして現在のファイル名を指定
20    $lineNumber = __LINE__; // エラーが発生した行として現在の行番号を指定
21
22    $errorException = new ErrorException(
23        $errorMessage,
24        $errorCode,
25        $errorSeverity,
26        $filename,
27        $lineNumber
28    );
29
30    // getFile() メソッドを呼び出し、エラーが発生したファイル名を取得します。
31    echo "エラーが発生したファイル: " . $errorException->getFile() . PHP_EOL;
32    echo "エラーが発生した行番号: " . $errorException->getLine() . PHP_EOL;
33    echo "エラーメッセージ: " . $errorException->getMessage() . PHP_EOL;
34}
35
36// 関数を実行してデモンストレーションを表示します。
37demonstrateErrorExceptionGetFile();

ErrorException::getFile()メソッドは、PHPでエラーが発生した際に、そのエラーが発生したファイルの名前（パスを含む）を文字列として取得するために利用されます。このErrorExceptionクラスは、通常、set_error_handler()関数などを通じて、PHP内部で発生した警告や非推奨といったエラーをオブジェクトとして扱う際に利用される特別な例外クラスです。引数はなく、戻り値はエラー発生箇所のファイルパスを示す文字列です。

このサンプルコードでは、ErrorExceptionの動作をデモンストレーションするために、エラーメッセージ、コード、重大度、そしてエラーが発生したファイル名（現在のスクリプトのパス）と行番号を指定して、直接ErrorExceptionのインスタンスを生成しています。

生成された$errorExceptionオブジェクトに対してgetFile()メソッドを呼び出すと、インスタンス生成時に渡されたファイルパスが正確に文字列として返されます。これにより、どのファイルでエラーが発生したかをプログラム的に把握することが可能になります。サンプルコードでは、このファイルパスの取得と合わせて、getLine()メソッドでエラー発生行番号を、getMessage()メソッドでエラーメッセージも取得できることを示し、ErrorExceptionが提供する詳細なエラー情報へのアクセス方法を紹介しています。