【PHP8.x】getPreviousメソッドの使い方

Copy
1<?php
2
3/**
4 * 最初の操作をシミュレートし、基本的な例外をスローする関数。
5 *
6 * @throws RuntimeException 何らかの失敗があった場合にスローされる。
7 */
8function simulateInitialOperation(): void
9{
10    // 何らかの処理が失敗したと仮定し、RuntimeException をスローします。
11    // これは、より具体的な DateInvalidOperationException がラップする「原因」となる例外です。
12    throw new RuntimeException("データベースへの接続が失敗しました。");
13}
14
15/**
16 * 日付関連の操作をシミュレートし、前の例外をDateInvalidOperationExceptionでラップして再スローする関数。
17 *
18 * この関数は、前の操作で発生した例外をより具体的な日付関連の例外として
19 * 再包装（re-throw）するシナリオを示します。これは「例外の連鎖（Exception Chaining）」と呼ばれます。
20 *
21 * @throws DateInvalidOperationException 日付操作中にエラーが発生した場合にスローされる。
22 */
23function performDateOperation(): void
24{
25    try {
26        simulateInitialOperation(); // 例外をスローする可能性のある操作を呼び出す
27    } catch (RuntimeException $e) {
28        // RuntimeException をキャッチし、それを原因として
29        // DateInvalidOperationException をスローします。
30        // getPrevious() メソッドでこの元の例外を取得できるよう、
31        // DateInvalidOperationException のコンストラクタの第3引数に $e を渡すのが重要です。
32        throw new DateInvalidOperationException("日付の書式設定中に予期せぬエラーが発生しました。", 0, $e);
33    }
34}
35
36// メインの処理
37try {
38    // 日付関連の操作を実行しようとします。
39    performDateOperation();
40} catch (DateInvalidOperationException $e) {
41    // performDateOperation() 関数からスローされた DateInvalidOperationException をキャッチします。
42    echo "--- DateInvalidOperationException をキャッチしました ---" . PHP_EOL;
43    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
44    echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")" . PHP_EOL;
45
46    // getPrevious() メソッドを使用して、この例外の前に発生した元の例外を取得します。
47    // これにより、エラーの原因となった最初の例外まで遡ることができます。
48    $previousException = $e->getPrevious();
49
50    if ($previousException !== null) {
51        echo PHP_EOL . "--- 前の例外（原因となった例外）情報 ---" . PHP_EOL;
52        echo "クラス名: " . get_class($previousException) . PHP_EOL;
53        echo "メッセージ: " . $previousException->getMessage() . PHP_EOL;
54        echo "発生ファイル: " . $previousException->getFile() . " (行: " . $previousException->getLine() . ")" . PHP_EOL;
55    } else {
56        echo PHP_EOL . "前の例外は存在しません。" . PHP_EOL;
57    }
58} catch (Throwable $e) {
59    // DateInvalidOperationException 以外の、予期せぬその他のエラーをキャッチします。
60    echo "--- 予期せぬエラーが発生しました ---" . PHP_EOL;
61    echo "クラス名: " . get_class($e) . PHP_EOL;
62    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
63    echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")" . PHP_EOL;
64}
65

DateInvalidOperationException::getPrevious() メソッドは、PHPで発生した例外が、別の例外を原因として内部的に保持している場合に、その元の例外を取得するために使用されます。PHPでは、より一般的な低レベルの例外を、具体的な高レベルの例外で「ラップ」（包み込む）して再スローする「例外の連鎖」という手法がよく用いられます。これにより、エラーのコンテキストを維持しつつ、より意味のある例外をユーザーに提示できます。

このメソッドには引数はありません。戻り値は ?Throwable 型で、これは「前の例外が存在すればその Throwable オブジェクトを返し、存在しなければ null を返す」ことを意味します。

サンプルコードでは、まず simulateInitialOperation 関数が RuntimeException をスローします。次に performDateOperation 関数がこの RuntimeException をキャッチし、それを原因として DateInvalidOperationException を新しくスローしています。このとき、DateInvalidOperationException のコンストラクタの第三引数に元の RuntimeException を渡すことで、例外の連鎖が確立されます。メインの処理で DateInvalidOperationException をキャッチした後、$e->getPrevious() を呼び出すことで、最初に発生した RuntimeException の詳細情報を取得し表示しています。これにより、エラーの根本原因を追跡し、デバッグを容易にすることができます。