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

Copy
1<?php
2
3/**
4 * PHPのエラーをErrorExceptionとして捕捉し、getTraceAsString() でスタックトレースを表示するサンプルです。
5 *
6 * このコードは、PHPの通常エラー（E_NOTICEなど）を例外に変換し、try-catchブロックで捕捉する方法を示します。
7 * 捕捉されたErrorExceptionオブジェクトからgetTraceAsString()メソッドを使って、
8 * エラーが発生した場所の実行履歴（スタックトレース）を取得し、表示します。
9 */
10
11// 開発環境向けに、全てのエラーを報告し画面に表示する設定
12error_reporting(E_ALL);
13ini_set('display_errors', '1');
14
15/**
16 * PHPの通常エラーをErrorExceptionに変換するためのカスタムエラーハンドラを設定します。
17 * これにより、try-catchブロックでPHPエラーを例外として捕捉できるようになります。
18 *
19 * @param int    $errno   エラーのレベル (例: E_NOTICE, E_WARNING)
20 * @param string $errstr  エラーメッセージ
21 * @param string $errfile エラーが発生したファイル名
22 * @param int    $errline エラーが発生した行番号
23 * @throws \ErrorException PHPエラーをErrorExceptionとしてスローします。
24 */
25set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline) {
26    // error_reporting設定で無視されるべきエラーは、PHPの標準ハンドラに任せる
27    if (!(error_reporting() & $errno)) {
28        return false;
29    }
30    // それ以外のエラーはErrorExceptionとしてスローする
31    throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
32});
33
34try {
35    echo "--- エラー発生を試みます ---\n";
36
37    // 意図的に未定義の変数を使用し、E_NOTICEエラーを発生させます。
38    // set_error_handlerがこのE_NOTICEをErrorExceptionに変換します。
39    echo $someUndefinedVariable;
40
41    echo "この行はエラー発生時に実行されません。\n";
42
43} catch (ErrorException $e) {
44    // ErrorException（PHPエラーから変換された例外）を捕捉した場合の処理
45    echo "\n--- ErrorExceptionを捕捉しました ---\n";
46    echo "メッセージ: " . $e->getMessage() . "\n";
47    echo "ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
48    echo "スタックトレース（getTraceAsString()による）:\n" . $e->getTraceAsString() . "\n";
49} catch (\Throwable $e) {
50    // その他の予期せぬ重大なエラー（例: Errorクラスの例外など）を捕捉する場合
51    // PHP 7以降では、Fatal ErrorなどもThrowableで捕捉できます。
52    echo "\n--- 予期せぬ重大なエラーを捕捉しました ---\n";
53    echo "タイプ: " . get_class($e) . "\n";
54    echo "メッセージ: " . $e->getMessage() . "\n";
55    echo "ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
56    echo "スタックトレース:\n" . $e->getTraceAsString() . "\n";
57} finally {
58    // カスタムエラーハンドラを元のPHPのデフォルト状態に戻します。
59    restore_error_handler();
60}
61
62echo "\n--- スクリプトが終了しました ---\n";
63
64?>

PHPのErrorExceptionクラスに属するgetTraceAsString()メソッドは、引数を取らず、エラーが発生した時点までのプログラムの実行履歴（スタックトレース）を文字列として返します。このスタックトレースは、プログラムがどのような関数やメソッドの呼び出しを経てエラーに至ったかを示す、デバッグに非常に有用な情報です。

提供されたサンプルコードでは、set_error_handler関数を用いてPHPの通常エラー（例: 未定義の変数へのアクセスによるE_NOTICE）をErrorExceptionオブジェクトに変換し、これをtry-catchブロックで捕捉しています。捕捉されたErrorExceptionオブジェクトからgetTraceAsString()メソッドを呼び出すことで、エラー発生時の詳細な実行パス（ファイル名、行番号、関数名など）を文字列形式で取得し、表示しています。

このメソッドが返す文字列は、エラーの根本原因を特定する際に役立ち、システムエンジニアがエラー発生時の状況を正確に把握し、問題を効率的に解決するために活用されます。