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

Copy
1<?php
2
3/**
4 * 例外チェーンと getPrevious() の使用法を示す関数。
5 *
6 * この関数は、内側の try-catch ブロックで InvalidArgumentException を捕捉し、
7 * それを「原因」として新しい OutOfBoundsException をスローします。
8 * これにより、例外の連鎖（Exception Chaining）が作成されます。
9 *
10 * @param array $data 任意のデータ配列
11 * @param mixed $index 配列にアクセスするためのインデックス
12 * @return void
13 * @throws OutOfBoundsException インデックスが無効な場合にスローされる
14 */
15function demonstrateGetPrevious(array $data, mixed $index): void
16{
17    try {
18        // インデックスが整数で、かつ0以上であるか検証する
19        if (!is_int($index) || $index < 0) {
20            // 検証に失敗した場合、これが最初の「原因」となる例外
21            throw new InvalidArgumentException("インデックスは正の整数である必要があります。");
22        }
23        // ... 本来はこの後、配列へのアクセス処理が続く ...
24        if (!isset($data[$index])) {
25             // このデモでは、上記の検証失敗ケースに焦点を当てる
26        }
27    } catch (InvalidArgumentException $e) {
28        // 捕捉した InvalidArgumentException を原因($previous)として、
29        // 新たな OutOfBoundsException をスローする
30        throw new OutOfBoundsException(
31            "無効なインデックスが指定されたため、データにアクセスできませんでした。",
32            0,
33            $e // 第3引数に、原因となった例外オブジェクトを渡す
34        );
35    }
36}
37
38// --- メインの実行コード ---
39
40try {
41    // わざと無効なインデックス（-1）を渡し、例外を発生させる
42    demonstrateGetPrevious(['apple', 'banana', 'cherry'], -1);
43} catch (OutOfBoundsException $e) {
44    // スローされた OutOfBoundsException を捕捉する
45    echo "キャッチした例外: " . $e::class . PHP_EOL;
46    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
47    echo "----------------------------------------" . PHP_EOL;
48
49    // getPrevious() メソッドで、原因となった「前の」例外を取得する
50    $previousException = $e->getPrevious();
51
52    // 前の例外が存在するか確認
53    if ($previousException !== null) {
54        echo "原因となった例外 (getPrevious()で取得): " . $previousException::class . PHP_EOL;
55        echo "原因のメッセージ: " . $previousException->getMessage() . PHP_EOL;
56    } else {
57        echo "原因となった例外はありません。" . PHP_EOL;
58    }
59}

このPHPサンプルコードは、OutOfBoundsExceptionクラスが持つgetPrevious()メソッドの使用法を解説するものです。このメソッドは、例外が連鎖的に発生した場合に、その直接の原因となった「一つ前」の例外オブジェクトを取得するために使われます。

コード内のdemonstrateGetPrevious関数では、意図的に例外の連鎖（例外チェーン）を発生させています。まず、不正なインデックス値を検出するとInvalidArgumentExceptionがスローされます。そして、catchブロックでこの例外を捕捉し、これを原因として新たなOutOfBoundsExceptionをスローしています。

メインの実行部分では、最終的にスローされたOutOfBoundsExceptionをcatchで捕捉します。ここで、捕捉した例外オブジェクト$eに対して$e->getPrevious()を呼び出すと、OutOfBoundsExceptionがスローされる原因となった、内側のInvalidArgumentExceptionオブジェクトを取得できます。

getPrevious()メソッドは引数を取りません。戻り値は、原因となった前の例外オブジェクト（Throwableインターフェースを実装したオブジェクト）、または原因が存在しない場合はnullです。この機能により、エラーの根本原因を追跡しやすくなり、デバッグ作業が効率的になります。