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

Copy
1<?php
2
3try {
4    // 例外を発生させる可能性のあるコード
5    throw new Exception("Something went wrong!");
6} catch (Exception $e) {
7    // 例外をキャッチし、スタックトレースを文字列として取得する
8    $traceAsString = $e->getTraceAsString();
9
10    // スタックトレースを画面に出力する
11    echo "Exception caught: " . $e->getMessage() . "\n";
12    echo "Stack trace:\n" . $traceAsString . "\n";
13}
14
15// DOMException を利用した例 (より具体的な getTraceAsString の利用例)
16try {
17    $dom = new DOMDocument();
18    $dom->loadHTML('<p>Hello</p><broken_tag>'); // 意図的に不正なHTML
19} catch (DOMException $e) {
20    echo "DOMException caught: " . $e->getMessage() . "\n";
21    echo "Stack trace:\n" . $e->getTraceAsString() . "\n";
22}

PHP 8 における DOMException クラスの getTraceAsString メソッドは、例外が発生した箇所のスタックトレースを文字列として取得するために使用されます。スタックトレースとは、例外が発生するまでの関数呼び出しの履歴のことで、デバッグを行う際に非常に役立ちます。

上記のサンプルコードでは、まず try-catch ブロックを使用して、例外が発生する可能性のあるコードを囲みます。最初の例では、一般的な Exception クラスを使用し、意図的に例外を発生させています。catch ブロック内で $e->getTraceAsString() を呼び出すことで、例外発生時のスタックトレースを文字列として取得し、画面に出力しています。

次の例では、DOMDocument クラスを使用し、不正なHTMLを読み込ませることで DOMException を発生させています。この例でも同様に、$e->getTraceAsString() を使用してスタックトレースを取得し、表示します。getTraceAsString メソッドは引数を持ちません。戻り値は文字列であり、例外が発生した時点での関数呼び出しの履歴が整形された形で含まれます。この情報は、例外の原因を特定し、コードを修正する上で不可欠です。DOMException のように、特定の状況で発生する例外に対して getTraceAsString を利用することで、より詳細なデバッグが可能になります。