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

Copy
1<?php
2
3/**
4 * ユーザーデータを検証する関数。
5 *
6 * @param array $data 検証するデータ
7 * @throws InvalidArgumentException データが無効な場合にスローされる
8 */
9function validate(array $data): void
10{
11    if (empty($data['name'])) {
12        // 処理の前提条件が満たされないため、例外をスローする
13        throw new InvalidArgumentException('Name is required.');
14    }
15}
16
17/**
18 * ユーザーを登録するメインロジック。
19 *
20 * @param array $user 登録するユーザー情報
21 * @throws LogicException ビジネスロジックの実行に失敗した場合にスローされる
22 */
23function registerUser(array $user): void
24{
25    try {
26        // 内部で別の処理を呼び出す
27        validate($user);
28        // ... ここに本来のユーザー登録処理が続く ...
29    } catch (InvalidArgumentException $e) {
30        // 捕捉した例外($e)を「原因」として、より上位の例外をスローする
31        // これを「例外チェーン」と呼び、第3引数に原因となった例外を渡す
32        throw new LogicException('User registration failed.', 0, $e);
33    }
34}
35
36// --- 実行コード ---
37try {
38    // 意図的に無効なデータを渡して例外を発生させる
39    $invalidUserData = ['email' => 'test@example.com'];
40    registerUser($invalidUserData);
41} catch (LogicException $e) {
42    echo "エラーが発生しました: " . $e->getMessage() . "\n\n";
43
44    // getPrevious() メソッドで、この例外の原因となった先行する例外を取得する
45    $previousException = $e->getPrevious();
46
47    // 先行する例外が存在するかチェック
48    if ($previousException) {
49        echo "根本原因:\n";
50        // 原因となった例外の情報を表示
51        echo "  - 例外クラス: " . get_class($previousException) . "\n";
52        echo "  - メッセージ: " . $previousException->getMessage() . "\n";
53        echo "  - ファイル: " . $previousException->getFile() . "\n";
54        echo "  - 行番号: " . $previousException->getLine() . "\n";
55    }
56}

このサンプルコードは、PHPの例外処理における getPrevious() メソッドの役割を解説するものです。このメソッドは、ある例外が別の例外を原因としてスローされた場合に、その原因となった「前の例外」を取得するために使用されます。このような例外の連鎖は「例外チェーン」と呼ばれ、エラーの根本原因を追跡するのに非常に役立ちます。

コードの流れを見てみましょう。まずregisterUser関数が、内部で呼び出したvalidate関数からInvalidArgumentExceptionを受け取ります。registerUser関数はこの例外をcatchブロックで捕捉し、それを原因として新たにLogicExceptionをスローしています。コンストラクタの第3引数に元の例外を渡すことで、2つの例外が関連付けられます。

最終的な実行部分のcatchブロックでは、$e->getPrevious()を呼び出すことで、LogicExceptionの裏に隠れていた根本原因、つまりInvalidArgumentExceptionの情報を取得し、その詳細を表示しています。

getPrevious()メソッドは引数を取らず、戻り値の型は?Throwableです。これは、原因となった例外オブジェクト（Throwable）を返すか、原因が存在しない場合はnullを返すことを意味します。そのため、サンプルコードのようにif文でnullでないことを確認してから使用するのが一般的です。