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

getTraceAsStringメソッドは、例外が発生した時点のスタックトレースを、人間が読みやすい形式の文字列として取得するために実行するメソッドです。スタックトレースとは、プログラムが例外の発生地点に至るまでに、どの関数やメソッドがどの順番で呼び出されたかの履歴情報です。この情報には、各呼び出しが行われたファイル名、行番号、そして呼び出された関数名やクラス名、メソッド名が含まれます。このメソッドが返す文字列は、エラーの原因を特定するデバッグ作業において非常に重要な手がかりとなります。プログラムのどこで、どのような実行経路を辿って問題が発生したのかを正確に把握できるため、開発者は迅速に問題を解決できます。このメソッドは引数を取らず、戻り値として整形済みのスタックトレースを単一の文字列で返します。この文字列は、ログファイルへの記録や、開発中の画面表示に利用されることが一般的です。getTraceAsStringメソッドは、すべての例外クラスの基底となるExceptionクラスで定義されているため、RangeExceptionだけでなく、PHPにおけるほとんどの例外オブジェクトで使用することが可能です。

Copy
1<?php
2try {
3    throw new RangeException('範囲外の例外が発生しました。');
4} catch (RangeException $e) {
5    // スタックトレースを文字列として取得します。
6    $trace = $e->getTraceAsString();
7    echo $trace;
8}
9?>

引数なし

引数はありません

string

例外発生時のコールスタック（関数呼び出し履歴）を文字列形式で取得します。