【PHP8.x】LogicException::getFile()メソッドの使い方

Copy
1<?php
2
3/**
4 * 特定の条件下で LogicException をスローする関数
5 *
6 * @param int $divisor 割る数
7 * @return float 商
8 * @throws LogicException 割る数が0の場合
9 */
10function divide(int $dividend, int $divisor): float
11{
12    // プログラムのロジックとして、0での除算は許可しない
13    if ($divisor === 0) {
14        // 論理的なエラーを示す LogicException をスローする
15        throw new LogicException('0で除算することはできません。');
16    }
17
18    return $dividend / $divisor;
19}
20
21try {
22    // 意図的に例外を発生させるために、0で除算を試みる
23    echo "計算を開始します...\n";
24    divide(10, 0);
25    echo "計算は正常に完了しました。\n"; // この行は実行されない
26} catch (LogicException $e) {
27    // スローされた LogicException を捕捉する
28
29    echo "ロジックエラーを検知しました。\n";
30
31    // getFile() メソッドを使い、例外がスローされたファイル名（フルパス）を取得して表示する
32    $errorFile = $e->getFile();
33    echo "エラーが発生したファイル: " . $errorFile . "\n";
34
35    // 補足: getLine() で行番号も取得できる
36    $errorLine = $e->getLine();
37    echo "エラーが発生した行番号: " . $errorLine . "\n";
38
39    // 補足: getMessage() で例外メッセージを取得できる
40    $errorMessage = $e->getMessage();
41    echo "エラーメッセージ: " . $errorMessage . "\n";
42}

このPHPコードは、プログラム実行中に論理的なエラーが発生した際に、そのエラーがどのファイルで起きたかを特定する方法を示しています。LogicException::getFile()メソッドは、try...catch構文で捕捉した例外オブジェクトから、例外が発生したファイルのフルパスを文字列として取得するために使用します。このメソッドに引数は必要ありません。

サンプルコードでは、0での除算をロジックエラーとみなし、意図的にLogicExceptionを発生させるdivide関数を定義しています。tryブロック内でこの関数を呼び出すことで例外を発生させ、続くcatchブロックでその例外オブジェクト（変数$e）を捕捉します。そして、catchブロック内で$e->getFile()を実行し、戻り値であるエラー発生元のファイルパスを変数$errorFileに代入し、画面に出力しています。

このようにgetFile()メソッドを利用することで、エラーの発生箇所を正確に知ることができ、プログラムの問題解決（デバッグ）を効率的に進めるのに役立ちます。コード内の補足にあるように、getLine()でエラー行、getMessage()でエラー内容も併せて取得するのが一般的です。

Copy
1<?php
2
3/**
4 * LogicExceptionから例外が発生したファイル名を取得するサンプルです。
5 */
6function demonstrateGetFileName(): void
7{
8    try {
9        // 意図的にLogicExceptionをスローします。
10        // この例外は、プログラムの論理的な誤りを示すために使用されます。
11        throw new LogicException('テスト用のロジックエラーです。');
12    } catch (LogicException $e) {
13        // スローされた例外をここで捕捉(キャッチ)します。
14        // $e->getFile() を呼び出すと、例外が発生したファイル名が文字列として返されます。
15        $fileName = $e->getFile();
16
17        // 取得したファイル名を出力します。
18        // このコードが記述されているファイル自身のフルパスが表示されます。
19        echo '例外が発生したファイル: ' . $fileName . PHP_EOL;
20    }
21}
22
23// 上記で定義した関数を実行します。
24demonstrateGetFileName();

このPHPサンプルコードは、プログラムの論理的な誤りを示すLogicExceptionが発生した際に、その例外がどのソースコードファイルで発生したかを取得する方法を解説します。

コードはtry...catch構文を使用しています。まず、tryブロックの中でthrow new LogicException()を使い、意図的に例外を発生させます。これは、実際にプログラムのロジックに問題があった状況を再現するためです。

次に、発生した例外はcatch (LogicException $e)ブロックで捕捉されます。捕捉された例外の情報は、変数$e（例外オブジェクト）に格納されます。

この例外オブジェクト$eが持つgetFile()メソッドを呼び出すことで、例外がスローされたファイル名（フルパス）を取得できます。このメソッドに引数は必要ありません。戻り値として、ファイルパスが文字列で返されます。

サンプルコードでは、取得したファイル名をechoで画面に出力しています。これにより、エラーが発生した具体的な場所を特定でき、デバッグ作業を効率的に進めることが可能になります。