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

Copy
1<?php
2
3/**
4 * 意図的に未定義のメソッドを呼び出すためのクラスです。
5 */
6class ExampleClass
7{
8    // このクラスにはメソッドが定義されていません。
9}
10
11/**
12 * 例外を発生させ、スタックトレースを取得する関数です。
13 */
14function causeBadMethodCall(): void
15{
16    $object = new ExampleClass();
17    // 存在しないメソッド 'undefinedMethod' を呼び出し、
18    // BadMethodCallException を発生させます。
19    $object->undefinedMethod();
20}
21
22try {
23    // 例外が発生する可能性のあるコードを実行します。
24    causeBadMethodCall();
25} catch (BadMethodCallException $e) {
26    // 発生した BadMethodCallException をキャッチします。
27
28    // getTraceAsString() メソッドを使用して、例外が発生するまでの
29    // 呼び出し履歴（スタックトレース）を文字列として取得します。
30    $stackTrace = $e->getTraceAsString();
31
32    // 取得したスタックトレースの文字列を出力します。
33    // これにより、どのファイルの何行目で、どの関数呼び出しが
34    // 例外の原因となったかを追跡できます。
35    // 出力内容は実行環境によって多少異なります。
36    echo "--- Stack Trace as String ---\n";
37    echo $stackTrace;
38}

BadMethodCallExceptionクラスのgetTraceAsString()メソッドは、存在しないメソッドが呼び出された場合などに発生する例外の呼び出し履歴（スタックトレース）を、人間が読みやすい形式の文字列として取得するために使用します。プログラムのどこで問題が起きたかを調査するデバッグ作業で非常に役立ちます。

このメソッドは引数を必要としません。戻り値として、例外が発生するまでの関数やメソッドの呼び出し順序、ファイル名、行番号などが含まれた一つの文字列（string）を返します。この情報により、エラーの原因となったコードの箇所を正確に追跡することが可能になります。

サンプルコードでは、意図的に定義されていないメソッドundefinedMethod()を呼び出し、BadMethodCallExceptionを発生させています。try...catch構文でこの例外を捕捉し、catchブロック内でgetTraceAsString()メソッドを実行しています。これにより取得したスタックトレースの文字列を出力することで、どのファイルのどの行で不正なメソッド呼び出しが行われたかを特定し、問題解決の手がかりとすることができます。