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

Copy
1<?php
2
3/**
4 * この関数は、意図的に UnhandledMatchError を発生させます。
5 * match 式がすべての可能性を網羅していない場合に発生するエラーです。
6 *
7 * @param int $value 判定する値
8 */
9function triggerUnhandledMatchError(int $value): void
10{
11    // match 式は PHP 8 以降で導入されました。
12    // $value が 1 または 2 の場合は処理されますが、
13    // 他の値（例: 3）の場合は UnhandledMatchError が発生します。
14    match ($value) {
15        1 => print "値は1です。\n",
16        2 => print "値は2です。\n",
17        // デフォルトケース (_ => ...) がないため、他の値でエラーが発生します。
18    };
19}
20
21// UnhandledMatchError を捕捉するために try-catch ブロックを使用します。
22try {
23    // 意図的に UnhandledMatchError が発生するような値を渡します。
24    triggerUnhandledMatchError(3);
25} catch (UnhandledMatchError $e) {
26    // エラーが捕捉されたことを表示します。
27    echo "UnhandledMatchError が捕捉されました！\n\n";
28
29    // --- getTrace() の使用例 ---
30    // getTrace() メソッドは、エラーが発生した時点のスタックトレースを
31    // 配列（array）形式で返します。
32    // 各要素は、呼び出し元ファイル、行番号、関数名などの情報を持つ配列です。
33    echo "--- getTrace() で取得したスタックトレース (配列形式) ---\n";
34    print_r($e->getTrace());
35    echo "\n";
36
37    // --- getTraceAsString() の使用例 ---
38    // キーワードに関連する getTraceAsString() メソッドも紹介します。
39    // このメソッドは、スタックトレースを人間が読みやすい文字列形式で返します。
40    // getTrace() で得られる情報を整形して表示する際に便利です。
41    echo "--- getTraceAsString() で取得したスタックトレース (文字列形式) ---\n";
42    echo $e->getTraceAsString();
43}
44
45?>

このPHPコードは、PHP 8で導入されたUnhandledMatchErrorというエラーの捕捉と、そのエラー情報を取得する方法を示しています。UnhandledMatchErrorは、match式が評価するすべてのケースを網羅していない場合に発生するエラーです。

サンプルコードでは、triggerUnhandledMatchError関数で意図的にこのエラーを発生させ、try-catchブロックでUnhandledMatchErrorを捕捉しています。エラーが捕捉された後、$eというエラーオブジェクトから呼び出せるgetTrace()メソッドについて解説します。

getTrace()メソッドは引数を取らず、エラーが発生した時点の関数の呼び出し履歴、つまり「スタックトレース」を配列（array）形式で返します。この配列には、エラーが発生するまでの各ステップにおけるファイル名、行番号、関数名などの詳細な情報が含まれており、エラーの原因を特定する際に非常に役立ちます。

また、関連するgetTraceAsString()メソッドも紹介しています。このメソッドもスタックトレースを返しますが、getTrace()がプログラムで処理しやすい配列形式であるのに対し、getTraceAsString()は人間が読みやすい整形された文字列形式で返します。デバッグ時にスタックトレースを直接表示する際に便利です。