【PHP8.x】BadFunctionCallException::lineプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 例外が発生した行番号を取得し、エラー情報を送信（ここでは画面に出力）する。
7 *
8 * この関数は、意図的にBadFunctionCallExceptionを発生させ、
9 * catchブロックで例外オブジェクトから発生箇所の行番号を取得し、
10 * その情報を画面に出力します。
11 *
12 * @return void
13 */
14function reportErrorLine(): void
15{
16    try {
17        // BadFunctionCallExceptionを意図的に発生させます。
18        // 例えば、存在しない関数をcall_user_funcで呼び出そうとするとこの例外がスローされます。
19        call_user_func('this_function_does_not_exist');
20
21    } catch (BadFunctionCallException $e) {
22        // スローされたBadFunctionCallExceptionオブジェクトをキャッチします。
23
24        // $e->getLine()メソッドで、例外がスローされた行番号を取得します。
25        // これはBadFunctionCallExceptionクラスが継承するExceptionクラスのプロパティ(line)に対応します。
26        $errorLine = $e->getLine();
27
28        // 組み立てるエラーメッセージ。本来はログファイルや監視サービスに送信します。
29        $errorMessage = sprintf(
30            "致命的なエラーがファイル '%s' の %d 行目で発生しました: %s",
31            $e->getFile(),
32            $errorLine, // 取得した行番号をメッセージに含める
33            $e->getMessage()
34        );
35
36        // エラー情報を「送信」します（この例では画面に出力）。
37        // エラーログに出力する場合は error_log($errorMessage); を使用します。
38        header('Content-Type: text/plain; charset=UTF-8');
39        echo $errorMessage;
40    }
41}
42
43// 関数を実行して動作を確認します。
44reportErrorLine();

このサンプルコードは、PHPで不正な関数呼び出しが行われた際に発生するBadFunctionCallExceptionから、エラーが発生したソースコードの行番号を取得し、その情報を活用する方法を示しています。

コード内のtryブロックでは、call_user_func()を用いて存在しない関数を呼び出すことで、意図的にBadFunctionCallExceptionを発生させています。発生した例外はcatchブロックで捕捉され、例外オブジェクトが変数$eに代入されます。

ここで利用しているのが$e->getLine()メソッドです。このメソッドは、例外オブジェクトが持つlineプロパティの値を取得します。lineプロパティには、例外がスローされたソースコードの行番号が整数(int)で格納されています。getLine()メソッドは引数を取らず、この行番号を戻り値として返します。

コードでは、取得した行番号を$e->getFile()で得られるファイル名などと組み合わせて、開発者がエラー箇所を特定しやすい詳細なメッセージを生成しています。最後に、このメッセージを画面に出力することで、エラー情報をログファイルや外部サービスに「送信」する処理を簡易的に表現しています。このようにlineプロパティは、エラーの発生箇所を正確に特定し、迅速な問題解決を行うために不可欠な情報を提供します。

Copy
1<?php
2
3/**
4 * BadFunctionCallException を捕捉し、例外が発生した行番号 (line) を取得します。
5 *
6 * このサンプルでは、意図的に無効な関数を呼び出すことで
7 * BadFunctionCallException を発生させています。
8 * catchブロックでは、例外オブジェクトの getLine() メソッドを使い、
9 * どのコード行で問題が発生したかを取得し、エラーハンドリングと連携（この場合は表示）します。
10 */
11function demonstrate_bad_function_call_line(): void
12{
13    echo "無効な関数呼び出しを試みます...\n";
14
15    try {
16        // 存在しない関数を call_user_func で呼び出すと
17        // BadFunctionCallException がスローされます。
18        call_user_func('this_function_does_not_exist');
19    } catch (BadFunctionCallException $e) {
20        // 例外を捕捉し、関連情報を表示します。
21        echo "エラー: BadFunctionCallException が捕捉されました。\n";
22
23        // getMessage() でエラーメッセージを取得します。
24        echo "メッセージ: " . $e->getMessage() . "\n";
25
26        // getLine() で例外が発生したファイル内の行番号を取得します。
27        // これにより、開発者はエラーの原因箇所を正確に特定できます。
28        echo "発生行 (line): " . $e->getLine() . "\n";
29
30        // getFile() で例外が発生したファイルパスを取得します。
31        echo "ファイル: " . $e->getFile() . "\n";
32    } finally {
33        echo "処理が終了しました。\n";
34    }
35}
36
37// 関数を実行します。
38demonstrate_bad_function_call_line();

このPHPサンプルコードは、BadFunctionCallExceptionというエラーが発生した際に、その原因となったソースコードの行番号を取得する方法を示しています。BadFunctionCallExceptionは、コールバック関数が無効であるなど、関数呼び出しに問題があった場合に発生する例外です。

コード内のtryブロックでは、call_user_func()関数を使って意図的に存在しない関数を呼び出し、BadFunctionCallExceptionを発生させています。catchブロックでは、発生した例外オブジェクトを$eという変数で受け取ります。

ここで重要なのが$e->getLine()メソッドです。このメソッドは引数を取らず、例外がスローされたソースコードの行番号を整数(int)で返します。この戻り値を利用することで、開発者はエラーの原因箇所を正確に特定でき、デバッグ作業を効率的に進めることが可能になります。サンプルでは取得した行番号を画面に表示していますが、実際のエラー処理では、この情報をエラーログに記録するなど、他のシステムと連携させることで、より高度なエラーハンドリングを実現します。