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

getPreviousメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月18日

基本的な使い方

getPreviousメソッドは、現在の例外の直前にスローされた例外（Previous Exception）を取得する処理を実行するメソッドです。この機能は「例外の連鎖（Exception Chaining）」と呼ばれ、ある例外が別の例外を原因として引き起こされた場合に、その因果関係をプログラム上で保持するために利用されます。例えば、データベース接続に失敗したという下位レベルの例外が原因で、ユーザー情報の取得に失敗したという上位レベルの例外がスローされるような状況で役立ちます。getPreviousメソッドを使うことで、上位の例外から原因となった下位の例外を辿ることができ、エラーの根本原因の特定やデバッグが容易になります。このメソッドを呼び出すと、直前の例外オブジェクトが返されますが、連鎖する例外が存在しない場合はnullが返されます。このメソッドは、PHPの基底例外クラスであるExceptionクラスで定義されているため、それを継承するRuntimeExceptionクラスのインスタンスからも呼び出すことが可能です。

構文(syntax)


1<?php
2try {
3    // 最初に発生した例外（原因）
4    $cause = new InvalidArgumentException('パラメータが不正です。');
5
6    // 最初の例外を原因として設定し、新しい例外をスローする
7    throw new RuntimeException('処理の実行に失敗しました。', 0, $cause);
8
9} catch (RuntimeException $e) {
10    // getPrevious() を使って、原因となった例外（前の例外）を取得する
11    $previousException = $e->getPrevious();
12
13    if ($previousException) {
14        // 原因となった例外のメッセージを出力する
15        echo '原因: ' . $previousException->getMessage();
16    }
17}

引数(parameters)

引数なし

引数はありません

戻り値(return)

?Throwable

このメソッドは、例外が連鎖している場合に、その連鎖の前の例外オブジェクトを返します。連鎖している例外がない場合は null を返します。

サンプルコード

PHP RuntimeException::getPrevious() で例外原因を取得する


1<?php
2
3/**
4 * RuntimeException::getPrevious() の使用例を示します。
5 *
6 * このメソッドは、現在の例外がスローされる直接的な原因となった
7 * 「直前の」例外を取得するために使用されます（例外の連鎖）。
8 */
9function demonstrateExceptionChaining(): void
10{
11    try {
12        // --- ステップ 1: 内側の処理で、最初の例外を発生させる ---
13        try {
14            // 存在しないファイルを開こうとして、RuntimeException が発生する状況をシミュレート
15            new SplFileObject('non_existent_file.txt');
16        } catch (RuntimeException $ioException) {
17            // --- ステップ 2: 最初の例外をキャッチする ---
18            // より具体的で分かりやすいメッセージを持つ、新しい例外をスローします。
19            // このとき、第3引数にキャッチした例外($ioException)を渡し、原因を紐付けます。
20            throw new RuntimeException(
21                'アプリケーション設定の読み込みに失敗しました。', // 新しい例外のメッセージ
22                1001,                                       // アプリケーション固有のエラーコード
23                $ioException                                // 原因となった「直前の」例外
24            );
25        }
26    } catch (RuntimeException $appException) {
27        // --- ステップ 3: 連鎖された最終的な例外をキャッチする ---
28        echo 'アプリケーションでエラーが発生しました。' . PHP_EOL;
29        echo 'メッセージ: ' . $appException->getMessage() . PHP_EOL;
30        echo 'コード: ' . $appException->getCode() . PHP_EOL;
31        echo PHP_EOL;
32
33        // --- ステップ 4: getPrevious() を使って、原因となった例外を取得する ---
34        // 戻り値は Throwable または null になる可能性があります。
35        $previousException = $appException->getPrevious();
36
37        if ($previousException !== null) {
38            echo '=== エラーの根本原因 ===' . PHP_EOL;
39            echo '例外クラス: ' . get_class($previousException) . PHP_EOL;
40            echo 'メッセージ: ' . $previousException->getMessage() . PHP_EOL;
41            echo '発生ファイル: ' . $previousException->getFile() . PHP_EOL;
42            echo '発生行: ' . $previousException->getLine() . PHP_EOL;
43        }
44    }
45}
46
47// 関数を実行して結果を表示します。
48demonstrateExceptionChaining();
49

RuntimeException::getPrevious()は、ある例外がスローされる直接的な原因となった、一つ前の例外を取得するためのメソッドです。これは「例外の連鎖」と呼ばれる仕組みで、エラーの根本原因を追跡する際に役立ちます。

このサンプルコードでは、まず内側のtryブロックでファイル読み込みに失敗し、最初の例外（$ioException）が発生します。続くcatchブロックでは、この$ioExceptionを捕らえ、より具体的なメッセージを持つ新しい例外（$appException）をスローします。その際、新しい例外の第3引数に原因となった$ioExceptionを渡すことで、2つの例外を関連付けます。

最終的に、外側のcatchブロックで$appExceptionに対してgetPrevious()メソッドを呼び出すと、関連付けられた$ioExceptionを取得できます。これにより、表層的なエラーメッセージだけでなく、その根本原因となった例外の詳細情報も確認することが可能になります。

このメソッドに引数はありません。戻り値は、原因となった前のThrowable型のオブジェクト、または連鎖する例外がない場合はnullとなります。そのため、戻り値を使用する前にはnullでないことを確認するのが一般的です。

getPrevious()メソッドは、ある例外がなぜ発生したのか、その直接的な原因となった「直前の例外」を調べるために使います。この機能を利用するには、新しい例外をthrowする際に、コンストラクタの第3引数として、原因となった元の例外を渡しておく必要があります。この設定がされていない例外に対してgetPrevious()を呼び出すとnullが返ってきます。そのため、戻り値を使用する前には、必ずnullでないことをif文などで確認してください。nullの可能性がある値に対してメソッドを呼び出そうとするとエラーが発生します。この例外の連鎖は、根本的なエラーを隠さず、より分かりやすいエラーメッセージに変換して処理を続けたい場合に非常に役立ちます。