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

Copy
1<?php
2
3/**
4 * ゼロ除算が発生する可能性のある除算処理を実行します。
5 *
6 * @param int $numerator 分子
7 * @param int $denominator 分母
8 * @throws DivisionByZeroError 分母が0の場合にスローされます。
9 */
10function performSafeDivision(int $numerator, int $denominator): void
11{
12    echo "除算を試行: {$numerator} / {$denominator}\n";
13
14    // intdiv() は、ゼロ除算の場合に DivisionByZeroError (ArithmeticErrorのサブクラス) をスローします。
15    $result = intdiv($numerator, $denominator);
16    echo "結果: {$result}\n";
17}
18
19// 例外が発生する可能性のある処理を try-catch ブロックで囲みます。
20try {
21    // ここでゼロ除算を発生させます。
22    performSafeDivision(10, 0);
23} catch (ArithmeticError $e) {
24    // ArithmeticError（またはその子クラス、例: DivisionByZeroError）を捕捉します。
25    echo "--------------------------------------------------\n";
26    echo "ArithmeticError が発生しました。\n";
27    echo "エラーメッセージ: " . $e->getMessage() . "\n";
28    echo "エラーが発生したファイル: " . $e->getFile() . "\n";
29    echo "エラーが発生した行: " . $e->getLine() . "\n";
30
31    // getTraceAsString() メソッドを使用して、エラーのスタックトレースを文字列で取得します。
32    // スタックトレースは、エラーが発生するまでにどのような関数の呼び出しが行われたかを示します。
33    echo "--- スタックトレース（getTraceAsString()）---\n";
34    echo $e->getTraceAsString();
35    echo "--------------------------------------------------\n";
36} catch (Exception $e) {
37    // その他の一般的な例外を捕捉する場合。
38    echo "予期せぬ例外が発生しました: " . $e->getMessage() . "\n";
39}
40
41echo "プログラムは、エラー捕捉後も続行されます。\n";
42
43?>

このPHPサンプルコードは、算術エラーが発生した際の詳細な追跡情報を文字列として取得する ArithmeticError::getTraceAsString() メソッドの使用例です。

コードでは、ゼロ除算エラーを意図的に発生させています。intdiv() 関数で数値を0で割ろうとすると DivisionByZeroError が発生します。このエラーは ArithmeticError の一種であるため、try...catch ブロックの catch (ArithmeticError $e) で捕捉されます。

捕捉したエラーオブジェクト $e に対して getTraceAsString() メソッドを呼び出しています。このメソッドは引数を取らず、戻り値としてエラーが発生するまでに行われた関数の呼び出し履歴（スタックトレース）を、整形された文字列で返します。出力される文字列には、どのファイルの何行目でどの関数が呼び出され、それがどのように連鎖してエラーに至ったかの詳細な情報が含まれます。

getMessage() がエラーメッセージ自体を返すのに対し、getTraceAsString() はエラー発生に至るまでの「道のり」を示してくれるため、プログラムのどこで問題が起きたのかを特定し、デバッグする際に非常に役立ちます。