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

Copy
1<?php
2
3/**
4 * Generator::throw() メソッドのサンプルコード
5 */
6class MyGenerator
7{
8    /**
9     * ジェネレータ関数
10     *
11     * @return Generator
12     */
13    public static function generatorFunction(): Generator
14    {
15        try {
16            yield 1;
17            yield 2;
18            yield 3;
19        } catch (Exception $e) {
20            echo "例外がキャッチされました: " . $e->getMessage() . PHP_EOL;
21            yield 4; // 例外処理後もジェネレータを続行できる
22        }
23    }
24}
25
26// ジェネレータオブジェクトを作成
27$generator = MyGenerator::generatorFunction();
28
29// ジェネレータから値を取得
30echo $generator->current() . PHP_EOL; // 1
31$generator->next();
32
33echo $generator->current() . PHP_EOL; // 2
34$generator->next();
35
36// ジェネレータに例外をスロー
37try {
38    $generator->throw(new Exception("テスト例外"));
39} catch (Exception $e) {
40    echo "外部で例外がキャッチされました: " . $e->getMessage() . PHP_EOL; // 例外が処理されない場合
41}
42
43echo $generator->current() . PHP_EOL; // 4 (例外処理後のyield)
44$generator->next();
45
46// ジェネレータの完了を確認
47var_dump($generator->valid()); // bool(false)

PHP 8における Generator クラスの throw メソッドは、ジェネレータの実行中に例外を発生させるために使用します。引数には Throwable インターフェースを実装した例外オブジェクトを渡します。この例外は、ジェネレータ関数内の try-catch ブロックでキャッチできます。

サンプルコードでは、MyGenerator クラスの generatorFunction がジェネレータ関数として定義されています。この関数は yield を使用して値を生成し、try-catch ブロック内で例外を捕捉します。

$generator->throw(new Exception("テスト例外")) の部分で、ジェネレータ内に Exception がスローされます。ジェネレータ関数内で例外がキャッチされた場合、例外処理後のコードが実行され、yield 4 によって次の値が生成されます。もしジェネレータ関数内で例外がキャッチされなかった場合、throw を呼び出した箇所で例外がキャッチされます。

throw メソッドの戻り値は Generator オブジェクト自身です。このメソッドを使用することで、ジェネレータの処理フローを外部から制御し、特定のエラー状態をシミュレートしたり、ジェネレータの動作を中断させたりすることができます。ジェネレータが完了すると、$generator->valid() は false を返します。

Copy
1<?php
2
3/**
4 * Generator::throw() のサンプルコード
5 */
6class MyGenerator
7{
8    public function generateValues(): Generator
9    {
10        try {
11            yield 1;
12            yield 2;
13            // 例外がスローされると、ここから処理が中断されます。
14            yield 3;
15        } catch (Exception $e) {
16            echo "Caught exception: " . $e->getMessage() . PHP_EOL;
17            yield 'recovered'; // 例外処理後、値をyieldで返すことも可能
18        }
19    }
20}
21
22$generator = (new MyGenerator())->generateValues();
23
24foreach ($generator as $value) {
25    echo "Value: " . $value . PHP_EOL;
26
27    if ($value === 2) {
28        try {
29            // ジェネレータに例外をスローします。
30            $generator->throw(new Exception("Something went wrong!"));
31        } catch (Exception $e) {
32            echo "Caught exception outside generator: " . $e->getMessage() . PHP_EOL;
33        }
34    }
35}
36

Generator::throw() メソッドは、PHP 8のジェネレータオブジェクトに対して例外をスローするために使用されます。このメソッドは、ジェネレータの実行を一時停止している yield 式の位置で、指定された例外 (Throwable インタフェースを実装したオブジェクト) をスローします。

サンプルコードでは、MyGenerator クラス内で generateValues() メソッドがジェネレータを返します。このジェネレータは、yield を使用して値を生成しますが、try-catch ブロック内で囲まれているため、例外が発生した場合に処理できます。

メインの処理では、ジェネレータから値を取得し、$value が 2 の場合に $generator->throw() を呼び出して、ジェネレータ内部に Exception をスローしています。

ジェネレータ内で例外がキャッチされた場合、catch ブロック内の処理が実行され、エラーメッセージが表示された後、yield 'recovered' によって新しい値を生成して処理を継続できます。もしジェネレータ内部で例外がキャッチされなかった場合は、ジェネレータを呼び出している側のスコープで例外がキャッチされます。

Generator::throw() は、ジェネレータの処理中にエラーが発生した場合に、外部からジェネレータの実行を制御し、エラーハンドリングを行うための強力なツールです。戻り値はジェネレータオブジェクト自身です。