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

Copy
1<?php
2
3/**
4 * UnhandledMatchError::getPrevious() メソッドのサンプルコード。
5 *
6 * PHP 8 で導入された 'match' 式が、与えられた値に対して網羅されていない場合に
7 * 発生する UnhandledMatchError を捕捉し、その getPrevious() メソッドの動作を示します。
8 *
9 * UnhandledMatchError は通常、自身が直接前の例外をラップしないため、
10 * getPrevious() は null を返すことが期待されます。
11 */
12function demonstrateUnhandledMatchErrorGetPrevious(): void
13{
14    echo "--- UnhandledMatchError::getPrevious() のデモンストレーション ---" . PHP_EOL;
15
16    $value = 3; // 'match' 式で処理されない値
17
18    try {
19        echo "値 '{$value}' で 'match' 式を実行中..." . PHP_EOL;
20        // $value が 1 でも 2 でもないため、UnhandledMatchError が発生します。
21        $result = match ($value) {
22            1 => 'one',
23            2 => 'two',
24            // ここに $value が 3 の場合のケースがないため、エラーが発生
25        };
26        echo "結果: {$result}" . PHP_EOL; // この行は実行されません
27    } catch (UnhandledMatchError $e) {
28        echo "UnhandledMatchError を捕捉しました。" . PHP_EOL;
29        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
30        echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")" . PHP_EOL;
31
32        // getPrevious() メソッドを呼び出し、前の例外を取得します。
33        // UnhandledMatchError は通常、別の例外をラップして発生するものではないため、
34        // ここでは null が返されることがほとんどです。
35        $previousException = $e->getPrevious();
36
37        if ($previousException === null) {
38            echo "getPrevious() は null を返しました。このエラーは前の例外をラップしていません。" . PHP_EOL;
39        } else {
40            echo "getPrevious() が前の例外を返しました: " . get_class($previousException) . PHP_EOL;
41            echo "前の例外のメッセージ: " . $previousException->getMessage() . PHP_EOL;
42        }
43    } catch (Throwable $e) {
44        // UnhandledMatchError 以外の予期せぬエラーを捕捉する場合
45        echo "予期せぬエラーを捕捉しました: " . get_class($e) . PHP_EOL;
46        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
47    }
48
49    echo "--- デモンストレーション終了 ---" . PHP_EOL;
50}
51
52// 関数を実行して動作を確認します。
53demonstrateUnhandledMatchErrorGetPrevious();

このサンプルコードは、PHP 8で導入されたmatch式が網羅されていない場合に発生するUnhandledMatchErrorのgetPrevious()メソッドの動作を説明するものです。UnhandledMatchErrorは、match式で評価する値に対応するケースが存在しない場合に発生します。

getPrevious()メソッドは、例外が発生する前に発生した別の例外（前の例外）を返すためのものです。引数はなく、戻り値は?Throwable型です。これは、前の例外が存在する場合はThrowableオブジェクトを返し、存在しない場合はnullを返すことを意味します。

サンプルコードでは、match式で定義されていない値（ここでは3）を使用することで、UnhandledMatchErrorを発生させています。そして、catchブロック内で$e->getPrevious()を呼び出すことで、前の例外を取得しようとしています。UnhandledMatchErrorは通常、別の例外をラップして発生するものではないため、getPrevious()はnullを返すことが期待されます。したがって、サンプルコードの実行結果は「getPrevious() は null を返しました。このエラーは前の例外をラップしていません。」というメッセージを表示します。このメソッドを使うことで、例外発生の経緯を追跡し、デバッグに役立てることができます。