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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザーデータを検証し、処理するクラス
7 */
8class UserProcessor
9{
10    /**
11     * データベースへの接続を試みる（この例では常に失敗します）
12     *
13     * @throws Exception データベース接続の失敗をシミュレート
14     */
15    private function connectDatabase(): void
16    {
17        // 本来はデータベース接続処理が入るが、ここでは常に失敗させて例外をスローする
18        throw new Exception('データベース接続に失敗しました。');
19    }
20
21    /**
22     * ユーザーIDを検証し、ユーザー情報を処理する
23     *
24     * @param mixed $userId 処理対象のユーザーID
25     * @throws InvalidArgumentException ユーザーIDが不正な場合にスローされる
26     */
27    public function processUserData(mixed $userId): void
28    {
29        // 1. 引数の型を検証する
30        if (!is_int($userId) || $userId <= 0) {
31            // この場合、原因となる別の例外はない
32            throw new InvalidArgumentException('ユーザーIDは正の整数でなければなりません。');
33        }
34
35        // 2. 内部処理で発生した例外を捕捉し、より具体的な例外として再スローする
36        try {
37            $this->connectDatabase();
38        } catch (Exception $e) {
39            // 内部で発生した例外($e)を原因(previous)として、新しいInvalidArgumentExceptionをスローする。
40            // これにより、なぜ引数エラーと判断されたのか、根本原因を追跡できるようになる。
41            throw new InvalidArgumentException(
42                'ユーザー処理の前提条件を満たせませんでした。',
43                0, // 例外コード
44                $e  // 原因となった例外オブジェクト
45            );
46        }
47    }
48}
49
50$processor = new UserProcessor();
51
52try {
53    // 例外が連鎖する可能性のあるメソッドを呼び出す
54    $processor->processUserData(123);
55} catch (InvalidArgumentException $e) {
56    // 捕捉した例外のメッセージを表示
57    echo '--- 現在の例外 ---' . PHP_EOL;
58    echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
59    echo 'クラス: ' . get_class($e) . PHP_EOL;
60    echo PHP_EOL;
61
62    // getPrevious() メソッドで、原因となった「前の」例外を取得する
63    // 戻り値は Throwable または null の可能性があるため、存在をチェックする
64    $previousException = $e->getPrevious();
65
66    if ($previousException !== null) {
67        // 原因となった例外が存在する場合、その情報を表示する
68        echo '--- 原因となった前の例外 ---' . PHP_EOL;
69        echo 'メッセージ: ' . $previousException->getMessage() . PHP_EOL;
70        echo 'クラス: ' . get_class($previousException) . PHP_EOL;
71    } else {
72        echo '原因となった前の例外はありません。' . PHP_EOL;
73    }
74}

InvalidArgumentException::getPreviousメソッドは、ある例外がスローされる原因となった、その直前の例外オブジェクトを取得するために使用されます。プログラム内部で発生した低レベルな例外を、より具体的で分かりやすい例外に変換して再度スローする場合に、この「例外の連鎖」という仕組みが役立ちます。

このサンプルコードでは、processUserDataメソッドが内部でconnectDatabaseメソッドを呼び出します。connectDatabaseで発生したException（データベース接続失敗）はcatchブロックで捕捉され、それを原因として新しいInvalidArgumentExceptionがスローされます。このとき、元のExceptionオブジェクトが新しい例外の第3引数に渡されることで、2つの例外が関連付けられます。

最終的なcatchブロックでは、まずInvalidArgumentExceptionの情報を表示しています。そして、$e->getPrevious()を呼び出すことで、その根本原因である「データベース接続に失敗しました。」というメッセージを持つ元のExceptionオブジェクトを取得し、その情報を表示しています。

このメソッドに引数はありません。戻り値は、原因となった例外が存在すればそのThrowableオブジェクトを、なければnullを返します。そのため、戻り値を使用する前にはnullでないことを確認する必要があります。