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

Copy
1<?php
2
3/**
4 * この関数は、入力が文字列でない場合にInvalidArgumentExceptionをスローします。
5 * これは、上位レベルのTypeErrorの「以前の例外」として連鎖される可能性のある
6 * 下位レベルのエラーをシミュレートします。
7 *
8 * @param mixed $value 処理するデータ
9 * @return string 処理されたデータ
10 * @throws InvalidArgumentException 入力が文字列でない場合
11 */
12function processData(mixed $value): string
13{
14    if (!is_string($value)) {
15        throw new InvalidArgumentException(
16            sprintf(
17                "Expected a string, but %s was given.",
18                get_debug_type($value)
19            )
20        );
21    }
22    return "Processed: " . $value;
23}
24
25/**
26 * この関数は、processData()を呼び出し、発生したInvalidArgumentExceptionを
27 * キャッチし、TypeErrorとして再スローします。
28 * このTypeErrorは、元のInvalidArgumentExceptionを「以前の例外」として含みます。
29 *
30 * 注: 通常、TypeErrorはPHPエンジンによって直接スローされますが、
31 * この例ではgetPrevious()の動作を示すために、意図的に連鎖させています。
32 *
33 * @param mixed $data 処理するデータ
34 * @return string 処理結果
35 * @throws TypeError データの処理中に型エラーが発生した場合
36 */
37function handleDataOperation(mixed $data): string
38{
39    try {
40        return processData($data);
41    } catch (InvalidArgumentException $e) {
42        // 下位レベルの例外をキャッチし、TypeErrorとして上位に再スローします。
43        // 元の例外をTypeErrorのコンストラクタの第3引数で連鎖させます。
44        throw new TypeError(
45            "Data operation failed due to an invalid input type.",
46            0, // エラーコード
47            $e  // 以前の例外としてInvalidArgumentExceptionを渡す
48        );
49    }
50}
51
52// メインの実行ブロック
53try {
54    // 意図的に無効な型の値を渡して、例外の連鎖をトリガーします。
55    echo handleDataOperation(123);
56} catch (TypeError $e) {
57    // TypeErrorをキャッチし、その詳細を表示します。
58    echo "--- Caught TypeError ---" . PHP_EOL;
59    echo "Message: " . $e->getMessage() . PHP_EOL;
60    echo "Code: " . $e->getCode() . PHP_EOL;
61    echo "File: " . $e->getFile() . PHP_EOL;
62    echo "Line: " . $e->getLine() . PHP_EOL;
63
64    // getPrevious()メソッドを使用して、連鎖された以前の例外を取得します。
65    $previous = $e->getPrevious();
66
67    if ($previous !== null) {
68        // 以前の例外が存在する場合、その詳細を表示します。
69        echo PHP_EOL . "--- Previous Exception (from getPrevious()) ---" . PHP_EOL;
70        echo "Type: " . get_class($previous) . PHP_EOL;
71        echo "Message: " . $previous->getMessage() . PHP_EOL;
72        echo "Code: " . $previous->getCode() . PHP_EOL;
73        echo "File: " . $previous->getFile() . PHP_EOL;
74        echo "Line: " . $previous->getLine() . PHP_EOL;
75    } else {
76        echo PHP_EOL . "No previous exception found for this TypeError." . PHP_EOL;
77    }
78} catch (Throwable $e) {
79    // 予期せぬその他の例外をキャッチします。
80    echo "Caught unexpected exception: " . $e->getMessage() . PHP_EOL;
81}

PHP 8のTypeError::getPrevious()メソッドは、例外が別の例外を原因として発生した際に、その原因となった元の例外（以前の例外）を取得するために使用されます。このメソッドは引数を取りません。戻り値は?Throwable型で、以前の例外が存在する場合はThrowableインターフェースを実装するオブジェクトを返し、存在しない場合はnullを返します。

サンプルコードでは、まずprocessData関数が無効な型の入力（文字列以外）を受け取るとInvalidArgumentExceptionをスローします。次に、handleDataOperation関数がprocessDataを呼び出し、そこで発生したInvalidArgumentExceptionをキャッチします。そして、このInvalidArgumentExceptionを「以前の例外」として含んだ新たなTypeErrorをスローし直すことで、例外を連鎖させています。

メインの実行ブロックでは、handleDataOperationに無効な値を渡すことでTypeErrorを発生させ、それをキャッチします。キャッチしたTypeErrorオブジェクトに対してgetPrevious()メソッドを呼び出すと、連鎖された元のInvalidArgumentExceptionを取得できます。これにより、発生した型エラーの根本原因となった、より詳細なエラー情報を確認できるようになります。これは、システムのデバッグやエラーハンドリングにおいて、問題の追跡を容易にする上で非常に役立ちます。