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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 根本的な原因となる例外をスローする関数
7 *
8 * @throws InvalidArgumentException
9 */
10function createDateRangeFromInvalidInput(): void
11{
12    // 何らかの不正な入力があったと仮定します
13    throw new InvalidArgumentException('無効な日付形式です。');
14}
15
16/**
17 * 例外チェーンと getPrevious() の使用例を実演します
18 */
19function demonstrateGetPrevious(): void
20{
21    try {
22        try {
23            // 内部の処理で、根本原因となる例外が発生
24            createDateRangeFromInvalidInput();
25        } catch (InvalidArgumentException $e) {
26            // 捕捉した例外($e)を原因(previous)として、新しいDateRangeErrorをスローします。
27            // これにより、例外の連鎖（チェーン）が作られます。
28            throw new DateRangeError('日付範囲の作成に失敗しました。', 0, $e);
29        }
30    } catch (DateRangeError $e) {
31        // スローされたDateRangeErrorを捕捉します
32        echo "現在の例外: " . $e->getMessage() . PHP_EOL;
33        echo "現在の例外クラス: " . get_class($e) . PHP_EOL;
34        echo PHP_EOL;
35
36        // getPrevious() メソッドで、原因となった一つ前の例外を取得します
37        $previousException = $e->getPrevious();
38
39        // 前の例外が存在するか確認します
40        if ($previousException instanceof Throwable) {
41            echo "前の例外(原因): " . $previousException->getMessage() . PHP_EOL;
42            echo "前の例外クラス: " . get_class($previousException) . PHP_EOL;
43        } else {
44            echo "この例外には、原因となった前の例外はありません。" . PHP_EOL;
45        }
46    }
47}
48
49// 関数を実行して結果を確認します
50demonstrateGetPrevious();

PHPのサンプルコードは、例外処理における「例外チェーン」と、そのチェーンを辿るためのgetPrevious()メソッドの利用方法を具体的に示しています。

プログラム内で何らかの問題が発生し、それが別のエラーを引き起こすような場合、元のエラー情報を失わずに、より適切な意味を持つ新しい例外として再スローすることがあります。この際、新しい例外のコンストラクタの第三引数に元の例外を指定することで、例外が連鎖する「例外チェーン」が形成されます。

getPrevious()メソッドは、引数を受け取らず、現在の例外が原因として持っている一つ前の例外オブジェクト（Throwable型）を取得するために使用されます。もし前の例外が存在しない場合はnullを返します。この機能により、エラーの根本原因を追跡し、問題解決に必要な詳細情報を得ることが可能となります。

サンプルコードでは、まずcreateDateRangeFromInvalidInput関数でInvalidArgumentExceptionという根本原因となる例外がスローされます。これを内部のcatchブロックで捕捉し、その例外を原因（previous）として新しいDateRangeErrorを生成し、再スローしています。外側のcatchブロックでこのDateRangeErrorを捕捉した後、getPrevious()メソッドを呼び出すことで、根本原因であったInvalidArgumentExceptionの情報を取り出し、表示しています。これにより、ユーザーは現在のエラーだけでなく、その原因となったエラーも確認できるため、デバッグやエラーハンドリングに非常に役立ちます。