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

Copy
1<?php
2
3/**
4 * DateException::getPrevious() メソッドのデモンストレーションを行います。
5 * このメソッドは、現在の例外が別の例外を原因としてスローされた場合に、
6 * その元の例外（前の例外）を返します。
7 *
8 * @see https://www.php.net/manual/ja/class.dateexception.php
9 */
10function demonstrateDateExceptionGetPrevious(): void
11{
12    // 例外チェインを作成するため、ネストされたtry-catchブロックを使用します。
13    try {
14        try {
15            // STEP 1: 最初の例外を意図的に発生させます。
16            // DateExceptionではなく、任意の Throwable (ここでは InvalidArgumentException) で構いません。
17            throw new InvalidArgumentException("処理対象のデータが不正です。");
18
19        } catch (InvalidArgumentException $e) {
20            // STEP 2: 最初の例外をキャッチし、その例外を原因として新しい DateException をスローします。
21            // DateException のコンストラクタの第3引数に $e (前の例外) を渡すことで、
22            // 例外チェインが確立されます。
23            echo "最初の例外をキャッチしました: " . $e->getMessage() . "\n";
24            echo "この例外を原因として DateException をスローします。\n";
25            throw new DateException("日付処理中に問題が発生しました。", 100, $e);
26        }
27
28    } catch (DateException $e) {
29        // STEP 3: 新しくスローされた DateException をキャッチします。
30        echo "\nDateException をキャッチしました。\n";
31        echo "  現在の例外メッセージ: " . $e->getMessage() . "\n";
32        echo "  現在の例外コード: " . $e->getCode() . "\n";
33
34        // STEP 4: getPrevious() メソッドを使用して、この DateException の原因となった前の例外を取得します。
35        $previousException = $e->getPrevious();
36
37        // getPrevious() は Throwable オブジェクトまたは null を返します。
38        if ($previousException !== null) {
39            echo "\ngetPrevious() で取得した前の例外情報:\n";
40            echo "  タイプ: " . get_class($previousException) . "\n";
41            echo "  メッセージ: " . $previousException->getMessage() . "\n";
42            echo "  コード: " . $previousException->getCode() . "\n";
43            echo "  (これは最初に発生した InvalidArgumentException です)\n";
44        } else {
45            echo "\ngetPrevious() は前の例外を返しませんでした (null)。\n";
46        }
47
48    } catch (Throwable $e) {
49        // DateException 以外の予期せぬエラーをキャッチするための汎用ブロック
50        echo "\n予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
51    }
52}
53
54// デモンストレーション関数を実行します。
55demonstrateDateExceptionGetPrevious();

DateException::getPrevious()メソッドは、PHPで発生した例外が、さらに別の例外を原因としてスローされた場合に、その「原因となった元の例外（前の例外）」を取得するために使用されます。プログラミングにおいて、ある処理でエラーが起こり、それが原因でさらに別のエラーが発生するという「例外の連鎖（例外チェイン）」はよくあることです。このメソッドは、その連鎖を遡って根本原因を特定する際に非常に役立ちます。

このメソッドは引数を必要とせず、呼び出すだけで機能します。戻り値は?Throwable型で、前の例外が存在する場合はその例外オブジェクト（例えばInvalidArgumentExceptionなど）を返し、存在しない場合はnullを返します。

サンプルコードでは、まず内部でInvalidArgumentExceptionを発生させ、これをキャッチします。そして、このInvalidArgumentExceptionを原因（前の例外）として、新たにDateExceptionをスローしています。外側のcatchブロックでこのDateExceptionを捕捉した後、getPrevious()メソッドを呼び出すことで、最初に発生したInvalidArgumentExceptionの情報を取得し、表示しています。これにより、最終的に発生したDateExceptionがどのような原因で引き起こされたのかを詳細に追跡できるため、エラーのデバッグや根本原因の特定が容易になります。