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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 存在しないメソッド呼び出しをシミュレートするクラス
7 */
8class MessageSender
9{
10    /**
11     * このクラスには `sendLineMessage` というメソッドは存在しないため、
12     * __call マジックメソッドで未定義メソッドの呼び出しをハンドルします。
13     *
14     * @param string $name 呼び出されたメソッド名
15     * @param array $arguments メソッドに渡された引数
16     */
17    public function __call(string $name, array $arguments)
18    {
19        // 意図的に BadMethodCallException をスローします
20        throw new BadMethodCallException("メソッド {$name} は存在しません。");
21    }
22}
23
24/**
25 * 存在しないメソッドを呼び出し、例外を捕捉して行番号を送信（表示）します。
26 */
27function reportErrorWithLineNumber(): void
28{
29    try {
30        $sender = new MessageSender();
31        // 存在しないメソッドを呼び出し、例外を発生させます
32        $sender->sendLineMessage('ユーザーID', 'こんにちは');
33    } catch (BadMethodCallException $e) {
34        // BadMethodCallException を捕捉します
35
36        // getLine() メソッドで例外がスローされた行番号を取得します
37        $errorLine = $e->getLine();
38        $errorMessage = $e->getMessage();
39
40        // 取得した行番号を含むエラー情報を「送信」（この例では画面に出力）します
41        echo "エラーが発生しました。\n";
42        echo "メッセージ: {$errorMessage}\n";
43        echo "発生箇所（__callメソッド内）の行番号: {$errorLine}\n";
44    }
45}
46
47// 関数を実行して結果を確認します
48reportErrorWithLineNumber();

このPHPサンプルコードは、存在しないメソッドが呼び出された際に発生するBadMethodCallExceptionという例外を捕捉し、エラーが発生したソースコードの行番号を取得して表示する方法を解説するものです。

MessageSenderクラスにはsendLineMessageというメソッドが定義されていません。この未定義のメソッドを呼び出すと、__callマジックメソッドが動作し、その内部で意図的にBadMethodCallExceptionがスロー（発生）されます。

try...catch構文のcatchブロックでは、発生した例外を$eという変数で受け取ります。ここで用いる$e->getLine()メソッドが、今回の中心となる機能です。このメソッドは引数を必要とせず、例外がスローされた箇所の行番号を整数(int)で返します。サンプルコードでは、この戻り値を$errorLine変数に格納しています。

最後に、取得した行番号とエラーメッセージを画面に出力します。これは、実際のエラー監視システムで、発生したエラー情報をログファイルや外部サービスに「送信」する処理を模したものです。このようにgetLine()を使うことで、プログラムのどこで問題が起きたかを正確に特定でき、デバッグ作業を効率化できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 意図的に未定義のメソッドを呼び出し、BadMethodCallExceptionを発生させるクラスの例
7 */
8class ApiClient
9{
10    /**
11     * 未定義のインスタンスメソッドが呼び出されたときに自動的に実行されるマジックメソッド
12     *
13     * @param string $name 呼び出されたメソッド名
14     * @param array $arguments メソッドに渡された引数
15     * @throws BadMethodCallException 呼び出されたメソッドが存在しないことを示すためにスローされる
16     */
17    public function __call(string $name, array $arguments)
18    {
19        // 存在しないメソッドが呼び出されたことを示す例外をスローする
20        throw new BadMethodCallException("メソッド '{$name}' は定義されていません。");
21    }
22}
23
24/**
25 * 例外から発生行番号を取得するサンプル関数
26 *
27 * @return void
28 */
29function demonstrate_exception_line_handling(): void
30{
31    // try-catchブロックで例外を捕捉する準備
32    try {
33        $client = new ApiClient();
34
35        // 存在しないメソッド `sendMessage` を呼び出す（この行で例外が発生）
36        $client->sendMessage("こんにちは");
37
38    } catch (BadMethodCallException $e) {
39        // BadMethodCallExceptionを捕捉する
40
41        // ExceptionオブジェクトのgetLine()メソッドで発生箇所の行番号を取得する
42        // これはリファレンス情報の `line` プロパティに相当する
43        $errorLine = $e->getLine();
44        $errorMessage = $e->getMessage();
45        $errorFile = $e->getFile();
46
47        // エラーログを想定した出力
48        // 発生ファイルや行番号をメッセージに含めることで、デバッグが容易になる
49        echo "[エラー発生]" . PHP_EOL;
50        echo "ファイル: " . $errorFile . PHP_EOL;
51        echo "行番号: " . $errorLine . PHP_EOL;
52        echo "メッセージ: " . $errorMessage . PHP_EOL;
53    }
54}
55
56// 関数を実行する
57demonstrate_exception_line_handling();
58

このPHPサンプルコードは、存在しないメソッドを呼び出した際に発生するBadMethodCallExceptionという例外を捕捉し、その例外がソースコードのどの行で発生したかを取得する方法を示しています。

tryブロック内で、ApiClientクラスに定義されていないsendMessageメソッドを意図的に呼び出すことで例外を発生させます。プログラムがエラーで停止する代わりに、catchブロックがこの例外を安全に捕捉します。

catchブロック内では、捕捉した例外オブジェクト（変数$e）のgetLine()メソッドを呼び出しています。このメソッドは、例外がスローされた箇所の行番号を整数(int)型で返します。このメソッドに引数は必要ありません。サンプルでは、$client->sendMessage("こんにちは");が実行された行の番号が取得されます。

最終的に、getFile()で取得したファイル名やgetMessage()で取得したエラーメッセージと共に行番号を出力しています。このようにエラー発生箇所を正確に特定できるため、デバッグ作業を効率的に進めることが可能になります。