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

Copy
1<?php
2
3/**
4 * 例外チェインの仕組みとErrorException::getPrevious() メソッドの利用例。
5 *
6 * この関数は、何らかの処理中に発生した内部的な問題を
7 * RuntimeException としてスローし、それを捕捉した上で、
8 * より上位のシステムレベルの ErrorException として再スローします。
9 * この際、元の RuntimeException を ErrorException の「前の例外」として設定します。
10 */
11function performOperationWithPossibleError(): void
12{
13    try {
14        // 何らかのデータ処理中に予期せぬ問題が発生したと仮定します。
15        // ここでは説明のため、直接 RuntimeException をスローします。
16        throw new RuntimeException("データ検証に失敗しました。", 100);
17
18    } catch (RuntimeException $innerException) {
19        // RuntimeException をキャッチしました。
20        // この例外を原因として、さらに上位の ErrorException をスローします。
21        // ErrorException の最後の引数に $innerException を渡すことで、
22        // 例外チェインを作成します。
23        throw new ErrorException(
24            "システム処理中に予期せぬエラーが発生しました。",
25            500,            // エラーコード
26            E_USER_ERROR,   // エラーの重大度 (ユーザー定義エラー)
27            __FILE__,       // エラーが発生したファイル名
28            __LINE__,       // エラーが発生した行番号
29            $innerException // この例外の原因となった前の例外
30        );
31    }
32}
33
34// メインの実行ブロック
35try {
36    // 問題が発生する可能性のある処理を実行します。
37    performOperationWithPossibleError();
38
39} catch (ErrorException $outerException) {
40    // performOperationWithPossibleError() からスローされた ErrorException をキャッチします。
41
42    echo "--- 外側の例外 (ErrorException) 情報 ---\n";
43    echo "メッセージ: " . $outerException->getMessage() . "\n";
44    echo "コード: " . $outerException->getCode() . "\n";
45    echo "ファイル: " . $outerException->getFile() . "\n";
46    echo "行: " . $outerException->getLine() . "\n";
47    echo "\n";
48
49    // ErrorException::getPrevious() メソッドを使用して、
50    // この例外の原因となった前の例外 (RuntimeException) を取得します。
51    // 戻り値は Throwable または null です。
52    $previousException = $outerException->getPrevious();
53
54    if ($previousException !== null) {
55        // 前の例外が存在する場合、その情報を表示します。
56        echo "--- 前の例外 (原因となった例外) 情報 ---\n";
57        echo "タイプ: " . get_class($previousException) . "\n"; // 例外のクラス名
58        echo "メッセージ: " . $previousException->getMessage() . "\n";
59        echo "コード: " . $previousException->getCode() . "\n";
60        echo "ファイル: " . $previousException->getFile() . "\n";
61        echo "行: " . $previousException->getLine() . "\n";
62    } else {
63        echo "前の例外は存在しません。\n";
64    }
65}
66
67?>

ErrorException::getPrevious()メソッドは、PHPの例外処理における「例外チェイン」の仕組みを理解するために重要です。このメソッドは、現在発生している例外が、別の例外を原因としてスローされた場合に、その原因となった一つ前の例外（親の例外）を取得するために使用されます。

このメソッドには引数がなく、呼び出すだけで機能します。戻り値は?Throwable型で、これは原因となった例外が存在すればThrowableインターフェースを実装した例外オブジェクトを返し、存在しない場合はnullを返します。

サンプルコードでは、performOperationWithPossibleError関数内で内部的なRuntimeExceptionが発生し、それが捕捉された後に、より上位のErrorExceptionとして再スローされています。この際、RuntimeExceptionはErrorExceptionのコンストラクタの最後の引数として渡され、「前の例外」として設定されています。

メインの実行ブロックでは、このErrorExceptionをキャッチした後、$outerException->getPrevious()を呼び出すことで、元々の原因であるRuntimeExceptionを取得しています。これにより、問題の根本原因を追跡し、詳細なデバッグ情報やエラーレポートを提供することが可能になります。例外チェインを利用することで、エラーの発生経路と原因を明確に理解できます。