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

Copy
1<?php
2
3/**
4 * ジェネレータ内で意図的に例外を発生させる関数。
5 * これによりジェネレータが閉じられ、その後の操作でClosedGeneratorExceptionが発生するシナリオを作る。
6 *
7 * @return Generator
8 */
9function createGeneratorWithInternalError(): Generator
10{
11    yield 'Step 1: Initial value.';
12    // ジェネレータの内部でRuntimeExceptionをスローする
13    throw new RuntimeException("An internal error occurred within the generator!");
14    yield 'Step 2: This will never be reached.'; // 上の行で例外がスローされるため、この行には到達しない
15}
16
17try {
18    $generator = createGeneratorWithInternalError();
19
20    // ジェネレータの最初の要素を取得
21    echo $generator->current() . PHP_EOL; // 出力: Step 1: Initial value.
22
23    // 次の要素に進もうとすると、ジェネレータ内のRuntimeExceptionがスローされる
24    // この内部例外が処理されないため、ジェネレータは自動的に「閉じられた」状態になる
25    $generator->next();
26
27    // ここには到達しない。next()の実行中にClosedGeneratorExceptionがスローされるため。
28    echo "This line will not be executed." . PHP_EOL;
29
30} catch (ClosedGeneratorException $e) {
31    // ジェネレータが閉じられた後に操作しようとすると、この例外がキャッチされる
32    echo "Caught ClosedGeneratorException: " . $e->getMessage() . PHP_EOL;
33
34    // getPrevious() を使用して、ジェネレータが閉じる原因となった元の例外（内部エラー）を取得する
35    $previousException = $e->getPrevious();
36
37    if ($previousException !== null) {
38        // 元の例外が存在する場合、その詳細を表示する
39        echo "  Previous exception (original cause of closure):" . PHP_EOL;
40        echo "    Type: " . get_class($previousException) . PHP_EOL;
41        echo "    Message: " . $previousException->getMessage() . PHP_EOL;
42    } else {
43        // 元の例外が存在しない場合（例: ジェネレータが単に完了した、または明示的に閉じられた場合）
44        echo "  No previous exception found. The generator might have completed or been explicitly closed." . PHP_EOL;
45    }
46} catch (Throwable $e) {
47    // 上記以外の、予期しない一般的な例外をキャッチ
48    echo "Caught an unexpected generic error: " . $e->getMessage() . PHP_EOL;
49}

PHP 8のClosedGeneratorException::getPreviousメソッドは、ジェネレータが予期せず閉じられた際に発生するClosedGeneratorExceptionにおいて、その原因となった元の例外情報を取得するために使用されます。

このメソッドは引数を取らず、戻り値は?Throwable型です。ジェネレータが閉じる原因となった元の例外が存在すればそのオブジェクトを返しますが、元の例外がなければnullが返されます。

サンプルコードでは、ジェネレータの内部で意図的にRuntimeExceptionを発生させ、ジェネレータが閉じる状況を作り出しています。ジェネレータが閉じられた後に操作しようとするとClosedGeneratorExceptionがスローされますが、この例外だけではなぜ閉じられたのかが直接分かりません。

そこで、getPrevious()メソッドを使用することで、ClosedGeneratorExceptionが保持している元のRuntimeExceptionを取り出すことができます。これにより、ジェネレータが閉じられた真の原因を特定し、その詳細なエラーメッセージやタイプを確認することが可能になります。この機能は、複雑なジェネレータのデバッグや、より具体的なエラー処理を実装する際に非常に役立ちます。