【PHP8.x】getTraceAsStringメソッドの使い方

getTraceAsStringメソッドは、JsonExceptionが発生した際に、その例外のスタックトレースを整形された文字列として取得する処理を実行するメソッドです。スタックトレースとは、プログラムが例外の発生地点に至るまでに、どのような関数やメソッドをどのような順番で呼び出してきたかを示す履歴情報のことです。具体的には、どのファイルの何行目でどの関数が呼び出され、次にどの関数が呼び出されたか、といった一連の流れが含まれています。このメソッドを利用することで、json_encode()やjson_decode()といったJSON関連の処理でエラーが発生した際に、その原因がプログラムのどこにあるのかを特定しやすくなります。通常、try-catchブロックでJsonExceptionオブジェクトを捕捉し、デバッグやエラーログの記録のためにこのメソッドを呼び出します。取得した文字列をログファイルに出力したり、開発中に画面へ表示したりすることで、エラーの原因調査を効率的に進めることができます。

Copy
1<?php
2
3try {
4    // 不正なJSON文字列をデコードしようとすると JsonException がスローされます
5    json_decode("{'invalid'}", flags: JSON_THROW_ON_ERROR);
6} catch (JsonException $e) {
7    // 例外のスタックトレースを文字列として取得し、出力します
8    echo $e->getTraceAsString();
9}

引数なし

引数はありません

string

このメソッドは、例外発生時のコールスタック情報を文字列として返します。