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

Copy
1<?php
2
3/**
4 * 未定義のメソッド呼び出しを試みるクラス
5 */
6class MethodCaller
7{
8    /**
9     * 内部で未定義のメソッドを呼び出し、BadMethodCallExceptionを発生させます。
10     */
11    public function execute(): void
12    {
13        // このクラスには 'undefinedMethod' という名前のメソッドは存在しません。
14        // そのため、この呼び出しは BadMethodCallException をスローします。
15        $this->undefinedMethod();
16    }
17}
18
19/**
20 * 例外を捕捉し、スタックトレースを表示する関数
21 */
22function main(): void
23{
24    try {
25        // 例外が発生する可能性のあるコードを実行します。
26        $caller = new MethodCaller();
27        $caller->execute();
28    } catch (BadMethodCallException $e) {
29        // BadMethodCallExceptionを捕捉します。
30        echo "エラー: " . $e->getMessage() . PHP_EOL . PHP_EOL;
31
32        // getTrace()メソッドを使って、例外発生時点でのバックトレース（関数の呼び出し履歴）を配列で取得します。
33        // この配列には、どのファイルの何行目で、どの関数/メソッドが呼び出されたかの情報が含まれています。
34        $trace = $e->getTrace();
35
36        echo "--- スタックトレース ---" . PHP_EOL;
37        print_r($trace);
38        echo "----------------------" . PHP_EOL;
39    }
40}
41
42// 処理を実行します。
43main();
44
45?>

このサンプルコードは、例外が発生した際の呼び出し履歴（スタックトレース）を取得するgetTrace()メソッドの使い方を示しています。

getTrace()メソッドは、例外オブジェクトから呼び出すことができるメソッドで、例外が発生するに至った関数やメソッドの呼び出し経路を配列として取得します。このメソッドに引数は必要ありません。戻り値は、呼び出し履歴の情報を含む多次元配列です。配列の各要素には、ファイル名、行番号、呼び出された関数名などのデバッグに役立つ情報が格納されています。

コードでは、まずMethodCallerクラス内で存在しないメソッドundefinedMethod()を呼び出し、意図的にBadMethodCallExceptionを発生させます。次にtry-catch構文でこの例外を捕捉し、例外オブジェクト$eに対して$e->getTrace()を実行します。これにより、エラー発生時点までの処理の流れが配列として取得され、print_r()で画面に出力されます。この出力結果を見ることで、どのファイルのどの処理で問題が起きたのかを正確に追跡でき、エラーの原因調査に非常に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 存在しないメソッドが呼び出されたときに
7 * BadMethodCallException をスローするデモ用のクラスです。
8 */
9class Service
10{
11    /**
12     * このマジックメソッドは、オブジェクトのコンテキストで
13     * アクセス不能なメソッドを呼び出したときにトリガーされます。
14     *
15     * @param string $name 呼び出されたメソッド名
16     * @param array $arguments メソッドに渡された引数
17     * @throws BadMethodCallException 存在しないメソッドが呼ばれたことを示すためにスローされます
18     */
19    public function __call(string $name, array $arguments): void
20    {
21        throw new BadMethodCallException("Method {$name} does not exist.");
22    }
23}
24
25/**
26 * 例外を発生させ、スタックトレースを取得する処理を実行します。
27 */
28function main(): void
29{
30    $service = new Service();
31
32    try {
33        // 意図的に存在しないメソッドを呼び出し、例外を発生させます。
34        $service->callNonExistentMethod();
35    } catch (BadMethodCallException $e) {
36        // 捕捉した例外オブジェクトからスタックトレースを配列として取得します。
37        // getTrace()は、例外がスローされた時点までのコールスタックの履歴を
38        // 配列形式で返します。
39        $trace = $e->getTrace();
40
41        // 取得した配列の内容を分かりやすく表示します。
42        echo "--- Stack Trace (from getTrace) ---" . PHP_EOL;
43        print_r($trace);
44
45        // 参考: getTraceAsString() は、同様の情報を整形された文字列として返します。
46        echo PHP_EOL . "--- Stack Trace (from getTraceAsString) ---" . PHP_EOL;
47        echo $e->getTraceAsString();
48    }
49}
50
51// 処理を実行します。
52main();

BadMethodCallExceptionクラスのgetTrace()メソッドは、例外が発生した時点までのプログラムの実行経路、すなわちスタックトレースを配列として取得するために使用されます。このメソッドは、PHPの全ての例外クラスが継承しているThrowableインターフェースで定義されているため、他の種類の例外オブジェクトからも呼び出すことが可能です。

このメソッドは引数を必要としません。戻り値は、スタックトレースの情報が格納された多次元配列です。この配列の各要素には、呼び出された関数やメソッドに関する詳細情報（ファイル名、行番号、クラス名、関数名など）が含まれており、例外発生の原因を詳細に調査する際に役立ちます。

サンプルコードでは、Serviceクラスに存在しないcallNonExistentMethodを呼び出すことで、意図的にBadMethodCallExceptionを発生させています。try...catchブロックでこの例外を捕捉し、例外オブジェクト$eに対して$e->getTrace()を呼び出しています。これにより取得したスタックトレースの配列をprint_r()で出力し、プログラムがどのような順序で実行されて例外に至ったかを確認できます。

参考として示されているgetTraceAsString()メソッドは、同じ情報を人間が読みやすい整形済みの文字列として返すため、両者の違いを理解する上で役立ちます。