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

Copy
1<?php
2
3/**
4 * ゼロ除算を試みる関数。
5 * PHP 8では、0での除算はDivisionByZeroErrorをスローします。
6 *
7 * @param int $numerator 分子
8 * @param int $denominator 分母
9 * @return float 除算の結果
10 * @throws DivisionByZeroError 分母が0の場合
11 */
12function attemptDivision(int $numerator, int $denominator): float
13{
14    return $numerator / $denominator;
15}
16
17/**
18 * DivisionByZeroError が発生し、それが別の例外によってラップされたときに、
19 * getPrevious() メソッドで元のエラーを取得するデモンストレーション関数です。
20 *
21 * システムエンジニアを目指す初心者の方へ：
22 * 例外（Exception）やエラー（Error）が発生した際、
23 * その問題を別の場所で処理するために、元の例外を「原因 (previous)」として
24 * 新しい例外をスローすることがあります。
25 * getPrevious() メソッドは、このようにラップされた元の例外を取り出すために使われます。
26 */
27function demonstrateDivisionByZeroErrorGetPrevious(): void
28{
29    echo "--- DivisionByZeroError と getPrevious() メソッドの利用例 ---" . PHP_EOL;
30
31    try {
32        // 内側のtry-catchブロックでゼロ除算を試みる
33        try {
34            echo "ゼロ除算を試みます: 10 / 0" . PHP_EOL;
35            attemptDivision(10, 0); // ここで DivisionByZeroError が発生
36        } catch (DivisionByZeroError $divisionError) {
37            echo "内側のブロックで DivisionByZeroError を捕捉しました。" . PHP_EOL;
38            echo "捕捉されたエラーメッセージ: " . $divisionError->getMessage() . PHP_EOL;
39
40            // 捕捉した DivisionByZeroError を「前のエラー」として新しい RuntimeException をスロー
41            // これにより、元の DivisionByZeroError がこの新しい例外にラップされます。
42            throw new RuntimeException(
43                "計算中に致命的なエラーが発生しました。",
44                0, // 例外コード（今回は使用しないので0）
45                $divisionError // ここで元の DivisionByZeroError を渡すことが重要
46            );
47        }
48    } catch (RuntimeException $runtimeException) {
49        echo "外側のブロックで RuntimeException を捕捉しました。" . PHP_EOL;
50        echo "捕捉されたRuntimeExceptionメッセージ: " . $runtimeException->getMessage() . PHP_EOL;
51
52        // getPrevious() メソッドを呼び出し、ラップされた元のThrowable（ここではDivisionByZeroError）を取得
53        $previousThrowable = $runtimeException->getPrevious();
54
55        if ($previousThrowable !== null) {
56            echo PHP_EOL . "--- getPrevious() で取得した前のエラー情報 ---" . PHP_EOL;
57            echo "前のエラーのクラス名: " . get_class($previousThrowable) . PHP_EOL;
58            echo "前のエラーメッセージ: " . $previousThrowable->getMessage() . PHP_EOL;
59            echo "前のエラーが発生したファイル: " . $previousThrowable->getFile() . PHP_EOL;
60            echo "前のエラーが発生した行: " . $previousThrowable->getLine() . PHP_EOL;
61        } else {
62            echo "getPrevious() は前のエラーを返しませんでした。" . PHP_EOL;
63        }
64    }
65
66    echo PHP_EOL . "--- デモンストレーション終了 ---" . PHP_EOL;
67}
68
69// 関数を実行してデモンストレーションを開始します
70demonstrateDivisionByZeroErrorGetPrevious();

このサンプルコードは、PHP 8で発生するDivisionByZeroErrorが、別の例外に「原因（previous）」としてラップされた際に、その元のエラー情報を取得するgetPrevious()メソッドの利用方法を示しています。

getPrevious()メソッドは、特定の例外がなぜ発生したのか、その根本原因となった別の例外やエラーを調べたいときに役立ちます。例えば、システム全体のエラーハンドリングを行う際に、具体的なエラー情報を隠蔽しつつ、根本原因の詳細はログなどに残したい場合に利用されます。

サンプルでは、まずゼロ除算によりDivisionByZeroErrorが発生します。このエラーは内側のtry-catchブロックで捕捉され、そのDivisionByZeroErrorを「原因」として、より一般的なRuntimeExceptionが新たにスローされます。外側のtry-catchブロックではこのRuntimeExceptionを捕捉し、getPrevious()メソッドを呼び出します。これにより、RuntimeExceptionの中に包み込まれていた元のDivisionByZeroErrorオブジェクトを取り出すことができます。

getPrevious()メソッドは引数を持ちません。戻り値は?Throwable型で、前の例外が存在する場合はそのThrowableオブジェクト（例：今回のDivisionByZeroError）を返します。もし前の例外が設定されていない場合はnullを返します。この機能により、複数の例外が連鎖して発生した場合でも、根本原因となったエラーを効率的に追跡し、デバッグすることが可能になります。