【PHP8.x】ArgumentCountError::getPrevious()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 例外の連鎖(Exception Chaining)と getPrevious() の動作を示すための関数です。
7 *
8 * @throws ArgumentCountError
9 */
10function causeChainedException(): void
11{
12    try {
13        // 1. 原因となる最初の例外を意図的に発生させます。
14        //    (例: データのバリデーションに失敗した)
15        throw new InvalidArgumentException('IDが無効です。');
16    } catch (InvalidArgumentException $e) {
17        // 2. 最初の例外をキャッチし、それを原因(previous)として設定して
18        //    新しい ArgumentCountError をスローします。
19        //    これは、最初のエラーが原因で、後続の関数呼び出しの引数を
20        //    間違えてしまった、という状況を模倣しています。
21        throw new ArgumentCountError(
22            'ユーザー取得処理の引数が不足しています。',
23            0,
24            $e // キャッチした例外を3番目の引数に渡し、例外を連鎖させる
25        );
26    }
27}
28
29try {
30    // 上記の関数を実行して、連鎖した例外を発生させます。
31    causeChainedException();
32} catch (ArgumentCountError $e) {
33    // 3. 最終的にスローされた ArgumentCountError をキャッチします。
34    echo '■キャッチした例外' . PHP_EOL;
35    echo 'クラス: ' . $e::class . PHP_EOL;
36    echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
37    echo '---' . PHP_EOL;
38
39    // 4. getPrevious() を使って、この例外の原因となった「前の例外」を取得します。
40    $previous = $e->getPrevious();
41
42    // getPrevious() は、前の例外が存在しない場合は null を返します。
43    if ($previous instanceof Throwable) {
44        echo '■getPrevious() で取得した原因の例外' . PHP_EOL;
45        echo 'クラス: ' . $previous::class . PHP_EOL;
46        echo 'メッセージ: ' . $previous->getMessage() . PHP_EOL;
47    }
48}

ArgumentCountError::getPrevious() は、ある例外が別の例外によって引き起こされた場合に、その原因となった「前の例外」を取得するためのメソッドです。このように例外を関連付けることを「例外の連鎖（Exception Chaining）」と呼び、エラーの根本原因を特定するのに役立ちます。

このサンプルコードでは、まず InvalidArgumentException を発生させ、それを catch します。次に、その catch した例外を原因として、新しい ArgumentCountError をスローします。このとき、ArgumentCountError のコンストラクタの第3引数に元の例外を渡すことで、2つの例外が関連付けられます。

最終的に ArgumentCountError を受け取った後、そのオブジェクトに対して getPrevious() を呼び出しています。このメソッドは引数を必要としません。戻り値として、原因として設定された InvalidArgumentException のオブジェクトが返されます。もし原因となる例外が設定されていなければ null を返すため、戻り値の型は ?Throwable となります。この仕組みにより、表面的なエラーの裏に隠れた根本原因を効率的に調査できます。