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

getTraceAsStringメソッドは、例外がスローされた時点でのスタックトレースを、整形された文字列として取得するメソッドです。このメソッドは、PHPの全ての例外およびエラーの基底となるThrowableインターフェースで定義されているため、InvalidArgumentExceptionクラスを含む全ての例外オブジェクトから呼び出すことが可能です。スタックトレースとは、プログラムが例外を発生させるまでに、どのファイルのどの行で、どのような関数やメソッドが、どの順番で呼び出されたかを示す詳細な履歴情報のことです。このメソッドを利用することで、例外が発生した際のプログラムの実行経路を時系列で正確に追跡できます。そのため、エラーの原因を特定するデバッグ作業において非常に重要な役割を果たします。一般的には、try...catchブロックで例外を捕捉した際に、このメソッドが返すスタックトレース文字列をログファイルに記録したり、開発環境で画面に出力したりするために使用されます。これにより、問題の箇所を迅速に特定し、修正作業を効率的に進めることができます。

Copy
1<?php
2
3function processValue(int $value)
4{
5    if ($value < 0) {
6        throw new InvalidArgumentException("Value cannot be a negative number.");
7    }
8    // ...
9}
10
11try {
12    processValue(-100);
13} catch (InvalidArgumentException $e) {
14    // 例外のスタックトレースを文字列として取得します。
15    $traceString = $e->getTraceAsString();
16    echo $traceString;
17}
18
19?>

引数なし

引数はありません

string

例外発生時のスタックトレースを文字列形式で取得できます。