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

getTraceAsStringメソッドは、例外のスタックトレースを文字列として取得するために実行するメソッドです。スタックトレースとは、プログラムが例外の発生地点に至るまでに、どのファイルの何行目で、どの関数がどのような順番で呼び出されたかという実行経路の履歴情報です。このメソッドは、その複雑なトレース情報を、人間が読みやすい形式に整形された一つの文字列として返します。主にデバッグの際に使用され、エラーログに出力したり画面に表示したりすることで、なぜ例外が発生したのか、その原因を特定するための重要な手がかりとなります。例えば、空のデータ構造から値を取り出そうとしてUnderflowExceptionが発生した場合、このメソッドを呼び出すことで、その不正な操作を呼び出した処理の流れを簡単に追跡できます。このメソッドは、UnderflowExceptionが継承しているThrowableインターフェースで定義されているため、PHPのほぼ全ての例外オブジェクトで共通して利用することができます。

Copy
1<?php
2
3$stack = new SplStack();
4
5try {
6    // 空のスタックから要素を取り出そうとして例外を発生させる
7    $stack->pop();
8} catch (UnderflowException $e) {
9    // スタックトレースを文字列として取得する
10    $trace = $e->getTraceAsString();
11    echo $trace;
12}

引数なし

引数はありません

string

例外発生時のスタックトレース（処理がどの順番で実行されたかの記録）を文字列として返します。