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

Copy
1<?php
2
3/**
4 * ClosedGeneratorException の発生をデモンストレーションし、
5 * getMessage() メソッドで例外メッセージを取得するサンプル。
6 *
7 * ジェネレータは一度最後まで実行されるか、明示的に閉じられると、
8 * その後値を要求しようとすると ClosedGeneratorException をスローします。
9 */
10
11// 1. 簡単なジェネレータ関数を定義します。
12function mySimpleGenerator()
13{
14    yield '最初の値';
15    yield '2番目の値';
16    // ジェネレータはここまで実行され、その後閉じられます。
17}
18
19// 2. ジェネレータのインスタンスを作成します。
20$generator = mySimpleGenerator();
21
22// 3. ジェネレータを最後まで実行し、閉じます。
23echo "ジェネレータの実行を開始します。\n";
24foreach ($generator as $value) {
25    echo "  取得した値: " . $value . "\n";
26}
27echo "ジェネレータは閉じられました。\n\n";
28
29// 4. 閉じられたジェネレータに対して操作を試み、例外を捕捉します。
30try {
31    echo "閉じられたジェネレータから値を要求しようとします...\n";
32    // 閉じられたジェネレータから値を要求しようとすると、
33    // PHP 8以降では ClosedGeneratorException が発生します。
34    $generator->current(); // または $generator->next(); $generator->send(null);
35    echo "このメッセージは表示されません。\n";
36} catch (ClosedGeneratorException $e) {
37    // 5. ClosedGeneratorException を捕捉し、$e->getMessage() でエラーメッセージを取得します。
38    echo "ClosedGeneratorException を捕捉しました！\n";
39    echo "エラーメッセージ: " . $e->getMessage() . "\n";
40} catch (Throwable $e) {
41    // その他の予期せぬ例外を捕捉する場合（任意）
42    echo "予期せぬ例外を捕捉しました: " . $e->getMessage() . "\n";
43}
44
45?>

PHP 8のClosedGeneratorException::getMessage()メソッドは、ジェネレータが閉じられた後に不正な操作が行われた際に発生するClosedGeneratorExceptionオブジェクトから、エラーの具体的な内容を示すメッセージを取得するために使用されます。

ジェネレータは、すべての値が生成され終えるか、あるいは明示的に閉じられると、それ以降は値を生成したり操作したりすることができません。このような閉じられたジェネレータに対して、再度値を要求するなどの操作を試みると、PHP 8以降ではClosedGeneratorExceptionという例外がスローされます。

このサンプルコードでは、まずジェネレータを最後まで実行して意図的に閉じます。その後、閉じられたジェネレータから値を要求する操作をtryブロック内で試み、ClosedGeneratorExceptionの発生を促しています。catchブロックでこの例外を捕捉すると、捕捉した例外オブジェクト（例では$e）に対して$e->getMessage()メソッドを呼び出すことで、「Cannot advance a closed generator」といったエラーメッセージを文字列として取得し、出力しています。

このメソッドは引数を必要とせず、エラーの状況を説明する文字列型の値を戻り値として返します。これにより、プログラムの実行中に何が問題だったのかを正確に把握し、適切なエラー処理を行うことができます。

Copy
1<?php
2
3/**
4 * ClosedGeneratorException の発生と getMessage メソッドの使用例。
5 *
6 * この関数は、PHPのジェネレータが閉じられた後に誤って操作しようとした際に発生する
7 * ClosedGeneratorException を捕捉し、その例外からエラーメッセージを取得する方法を示します。
8 * システムエンジニアを目指す初心者の方にも理解しやすいよう、簡潔な例としています。
9 */
10function demonstrateClosedGeneratorExceptionUsage(): void
11{
12    echo "--- ジェネレータの動作開始 ---\n";
13
14    // 1. ジェネレータ関数を定義し、即座にジェネレータオブジェクトを作成します。
15    //    このジェネレータは、一度だけ "Hello" という値を生成し、その後閉じられます。
16    $myGenerator = (function () {
17        yield "Hello";
18        echo "ジェネレータは 'Hello' を発行し、処理を完了しました。\n";
19    })();
20
21    // 2. ジェネレータを最後までイテレーションして閉じます。
22    //    foreach ループが終了すると、ジェネレータは「閉じられた」状態になります。
23    foreach ($myGenerator as $value) {
24        echo "ジェネレータから受け取った値: " . $value . "\n";
25    }
26
27    echo "--- ジェネレータは閉じられました ---\n\n";
28
29    echo "閉じられたジェネレータに値を送信しようとします。\n";
30    echo "この操作は ClosedGeneratorException を引き起こします。\n";
31
32    try {
33        // 3. 既に閉じられたジェネレータに対して `send()` メソッドを呼び出すと、
34        //    ClosedGeneratorException が発生します。
35        //    これは、閉じられたジェネレータに対して値を「送る」ことができないためです。
36        $myGenerator->send('新しいデータ');
37        echo "この行は、例外が発生したため実行されません。\n";
38    } catch (ClosedGeneratorException $e) {
39        // 4. ClosedGeneratorException をキャッチします。
40        echo "\n!!! ClosedGeneratorException が発生しました !!!\n";
41        echo "--------------------------------------------------\n";
42        // 5. キャッチした例外オブジェクトの `getMessage()` メソッドを使って、
43        //    例外に関連付けられたエラーメッセージを取得し表示します。
44        echo "エラーメッセージ: " . $e->getMessage() . "\n";
45        echo "--------------------------------------------------\n";
46    } catch (Throwable $e) {
47        // その他の予期せぬ例外をキャッチする場合の汎用的な処理です。
48        echo "\n予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
49    }
50
51    echo "\n--- 処理が終了しました ---\n";
52}
53
54// 上で定義したサンプルコードを実行します。
55demonstrateClosedGeneratorExceptionUsage();

PHPのClosedGeneratorExceptionは、ジェネレータが既に閉じられた（処理が完了した）後に、再度そのジェネレータに対して操作を行おうとした際に発生する例外です。ジェネレータは一度値を生成し終えると、その状態は閉じられ、再びアクティブな状態には戻りません。

ここでご紹介するgetMessageメソッドは、発生したClosedGeneratorExceptionオブジェクトから、例外が発生した具体的な理由を示すエラーメッセージを文字列として取得するために利用されます。このメソッドは引数を必要とせず、エラー内容を説明するstring型の値を返します。

サンプルコードでは、まずジェネレータを定義し、「Hello」という値を出力させた後、意図的にジェネレータを完全に閉じます。その後、閉じられた状態のジェネレータに対してsend()メソッドで新たな値を送ろうとすると、ClosedGeneratorExceptionが発生します。try-catchブロックでこの例外を適切に捕捉し、キャッチした例外オブジェクト$eに対して$e->getMessage()を呼び出すことで、エラーの詳細なメッセージを画面に表示しています。これにより、開発者はジェネレータが閉じられた後に不正な操作が行われたことを具体的なメッセージで確認し、問題の解決に役立てることができます。

Copy
1<?php
2
3/**
4 * ClosedGeneratorException::getMessage() の使用例を示します。
5 *
6 * ジェネレータが閉じられた後に再度値を生成しようとした際にスローされる
7 * ClosedGeneratorException をキャッチし、そのメッセージを取得します。
8 *
9 * @return void
10 */
11function demonstrateClosedGeneratorExceptionMessage(): void
12{
13    // ジェネレータ関数を定義します。
14    function myNumberGenerator(): Generator
15    {
16        for ($i = 1; $i <= 3; $i++) {
17            yield $i;
18        }
19    }
20
21    echo "--- ClosedGeneratorException の発生とメッセージ取得 ---" . PHP_EOL;
22
23    $generator = myNumberGenerator();
24
25    // ジェネレータを一度実行し、最初の値を生成します。
26    echo "最初の値: " . $generator->current() . PHP_EOL;
27    $generator->next(); // 2番目の値に進みます
28
29    // ジェネレータを明示的に閉じます。
30    // これにより、それ以上値を生成できなくなります。
31    $generator->close();
32    echo "ジェネレータを明示的に閉じました。" . PHP_EOL;
33
34    // 閉じられたジェネレータを再開しようとすると ClosedGeneratorException がスローされます。
35    try {
36        echo "閉じられたジェネレータを再開しようとします..." . PHP_EOL;
37        $generator->next(); // ここで ClosedGeneratorException がスローされる
38        echo "この行は実行されません。" . PHP_EOL; // 例外が発生するため、この行はスキップされます
39    } catch (ClosedGeneratorException $e) {
40        // ClosedGeneratorException をキャッチし、getMessage() でメッセージを取得します。
41        echo "ClosedGeneratorException をキャッチしました！" . PHP_EOL;
42        echo "例外メッセージ: " . $e->getMessage() . PHP_EOL;
43    } catch (Throwable $e) {
44        // その他の予期せぬ例外をキャッチ
45        echo "予期せぬ例外をキャッチしました: " . $e->getMessage() . PHP_EOL;
46    }
47}
48
49// 関数を実行します。
50demonstrateClosedGeneratorExceptionMessage();

ClosedGeneratorException::getMessage()は、PHP 8において、閉じられたジェネレータから値を生成しようとした際にスローされるClosedGeneratorExceptionのメッセージを取得するメソッドです。引数はなく、例外の原因を示す文字列（string）を返します。

サンプルコードでは、myNumberGeneratorというジェネレータを作成し、一部の値を生成後にclose()で明示的に閉じます。閉じられたジェネレータに再度next()を呼び出すとClosedGeneratorExceptionが発生します。プログラムはこの例外をtry-catchで捕捉し、getMessage()でエラーメッセージを取得・表示します。これにより、閉じられたジェネレータへの誤ったアクセス状況を把握し、適切なエラーハンドリングを行えます。