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

Copy
1<?php
2
3/**
4 * DOMException のスタックトレース情報を取得するサンプルコード
5 *
6 * このコードは、DOM 操作中に意図的に DOMException を発生させ、
7 * その例外オブジェクトから getTrace() と getTraceAsString() メソッドを使って
8 * スタックトレース情報を取得し、表示する方法を示します。
9 *
10 * getTrace() はスタックトレースを配列形式で、
11 * getTraceAsString() はスタックトレースを読みやすい文字列形式で返します。
12 */
13function demonstrateDomExceptionTrace(): void
14{
15    echo "DOMException のスタックトレース情報を表示します。\n";
16    echo "--- ここから例外発生処理 ---\n";
17
18    try {
19        $dom = new DOMDocument('1.0', 'UTF-8');
20        $dom->preserveWhiteSpace = false;
21        $dom->formatOutput = true;
22
23        // XML の要素名として無効な文字列を使い、DOMException を意図的に発生させます。
24        // この操作は DOMException::INVALID_CHARACTER_ERR (コード 5) をスローします。
25        $dom->createElement('123invalid_element_name');
26
27    } catch (DOMException $e) {
28        echo "--- DOMException をキャッチしました ---\n";
29
30        // キャッチした DOMException のメッセージとコードを表示
31        echo "例外メッセージ: " . $e->getMessage() . " (コード: " . $e->getCode() . ")\n\n";
32
33        // getTrace() メソッドでスタックトレースを配列として取得し、表示します。
34        // 配列形式なので、print_r を使って内容を確認します。
35        echo "=== getTrace() の出力 (配列形式) ===\n";
36        print_r($e->getTrace());
37        echo "\n";
38
39        // getTraceAsString() メソッドでスタックトレースを文字列として取得し、表示します。
40        // 文字列形式なので、echo で直接出力できます。
41        echo "=== getTraceAsString() の出力 (文字列形式) ===\n";
42        echo $e->getTraceAsString();
43        echo "\n";
44
45    } catch (Exception $e) {
46        // DOMException 以外の予期せぬ例外も捕捉できるようにします。
47        echo "予期せぬ例外をキャッチしました: " . $e->getMessage() . "\n";
48    }
49
50    echo "--- 例外処理終了 ---\n";
51}
52
53// サンプル関数を実行して、DOMException のスタックトレースを確認します。
54demonstrateDomExceptionTrace();

このPHPサンプルコードは、DOM操作中に意図的にDOMExceptionを発生させ、その例外のスタックトレース情報を取得・表示する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。ここでは、XMLの要素名として無効な文字列を使用することでDOMExceptionを意図的に発生させ、try-catchブロックで捕捉しています。

捕捉したDOMExceptionオブジェクトからは、二つのメソッドでスタックトレースを取得できます。一つ目のgetTrace()メソッドは、例外が発生するまでの関数の呼び出し履歴を、ファイル名、行番号、関数名などの詳細情報を含むarrayとして返します。このメソッドに引数は必要ありません。返される配列は、デバッグ時にプログラムの実行パスを分析するのに非常に有用で、print_rを使って内容を確認できます。

二つ目のgetTraceAsString()メソッドは、getTrace()と同様のスタックトレース情報を、人間が読みやすい整形済みのstring形式で返します。このメソッドも引数は不要です。この文字列形式の出力は、エラーメッセージと共に表示することで、問題発生箇所を迅速に特定する手助けとなります。これらのメソッドは、プログラムの不具合を解析し、修正する上で不可欠なデバッグツールとして活用されます。