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

Copy
1<?php
2
3/**
4 * 複数のステップで値を生成するジェネレータ関数。
5 */
6function myGenerator(): Generator
7{
8    // ジェネレータがここで一時停止し、'ステップ1のデータ' を返します。
9    // getExecutingLine() はこの行の番号を返します。
10    yield 'ステップ1のデータ';
11
12    // 何らかの処理をシミュレート...
13    sleep(1); 
14
15    // ジェネレータがここで一時停止し、'ステップ2のデータ' を返します。
16    // getExecutingLine() はこの行の番号を返します。
17    yield 'ステップ2のデータ';
18
19    // さらに複雑な処理をシミュレート...
20    sleep(1);
21
22    // ジェネレータがここで一時停止し、'ステップ3のデータ' を返します。
23    // getExecutingLine() はこの行の番号を返します。
24    yield 'ステップ3のデータ';
25}
26
27// ジェネレータ関数を呼び出し、Generatorオブジェクトを取得します。
28$generator = myGenerator();
29
30// ReflectionGeneratorをインスタンス化し、Generatorオブジェクトを渡します。
31$reflector = new ReflectionGenerator($generator);
32
33echo "ジェネレータの実行状況と中断行番号の追跡:\n";
34
35// ジェネレータが有効な間（まだ生成する値がある間）、ループを続けます。
36while ($generator->valid()) {
37    // ジェネレータが現在生成している値を取得します。
38    echo "  現在の生成値: " . $generator->current() . "\n";
39
40    // ReflectionGenerator::getExecutingLine() を使用して、
41    // ジェネレータが現在中断している（最後に 'yield' ステートメントが実行された）
42    // コード上の行番号を取得します。
43    echo "  中断中の行番号: " . $reflector->getExecutingLine() . "\n";
44
45    // ジェネレータを次の 'yield' ステートメントまで進めます。
46    $generator->next();
47}
48
49echo "ジェネレータの処理が完了しました。\n";

PHP 8のReflectionGenerator::getExecutingLineメソッドは、ジェネレータ関数の実行状況を詳細に把握するために利用される機能です。ジェネレータとは、yieldキーワードを使用して複数回にわたって値を生成し、その度に実行を一時停止・再開できる特別な関数を指します。

このメソッドは引数を一切取らず、戻り値として、ジェネレータが現在値を生成した後に一時停止している、ソースコード上の行番号を整数型（int）で返します。

提供されたサンプルコードでは、myGenerator関数が複数のyieldステートメントを使って値を段階的に生成しています。ReflectionGeneratorクラスのインスタンスを生成し、そのジェネレータを渡すことで、実行中のジェネレータの状態を詳細に調べることが可能になります。ループ処理の中でgetExecutingLine()を呼び出すたびに、ジェネレータが最後にyieldで値を生成し、一時停止した箇所の正確な行番号が表示されます。例えば、「ステップ1のデータ」が生成された直後には最初のyieldの行番号、「ステップ2のデータ」が生成された直後には次のyieldの行番号が取得できます。

このように、ジェネレータがコードのどの位置で現在停止しているのかを追跡できるため、複雑なジェネレータのデバッグや、実行フローの監視を行う際に非常に有効なツールとなります。

Copy
1<?php
2
3/**
4 * ReflectionGenerator::getExecutingLine() メソッドのデモンストレーションを行うジェネレータ関数です。
5 * ジェネレータが yield または return で一時停止する際の行番号を示します。
6 *
7 * @return Generator ジェネレータオブジェクト
8 */
9function demonstrateGeneratorExecutingLine(): Generator
10{
11    // この行は yield ではないため、getExecutingLine() の結果には直接影響しません。
12    echo "--- ジェネレータ内部: 処理開始 ---" . PHP_EOL; 
13    
14    // この yield 文が書かれている行番号が、getExecutingLine() によって返されます。
15    yield 'First value'; 
16    
17    echo "--- ジェネレータ内部: First value を生成しました ---" . PHP_EOL;
18    
19    // この yield 文が書かれている行番号が、getExecutingLine() によって返されます。
20    yield 'Second value'; 
21    
22    echo "--- ジェネレータ内部: Second value を生成しました ---" . PHP_EOL;
23    
24    // この return 文が書かれている行番号が、getExecutingLine() によって返されます。
25    return 'Generator finished.'; 
26}
27
28// ジェネレータのインスタンスを作成します。
29$generator = demonstrateGeneratorExecutingLine();
30
31// ReflectionGenerator オブジェクトを作成します。
32// これにより、ジェネレータの内部状態に関する情報にプログラム的にアクセスできます。
33$reflector = new ReflectionGenerator($generator);
34
35echo "\n--- ReflectionGenerator::getExecutingLine() の動作確認 ---" . PHP_EOL;
36
37// ジェネレータがまだ開始されていないため、getExecutingLine() は 0 を返します。
38// （PHP のバージョンや内部実装によっては、異なる挙動を示す可能性もあります）
39echo "ジェネレータ開始前: " . $reflector->getExecutingLine() . "行目" . PHP_EOL;
40
41// ジェネレータを最初の yield まで進めます。
42// この時点で、'First value' が yield された行でジェネレータが一時停止しています。
43$generator->next();
44echo "First value を yield 後: " . $reflector->getExecutingLine() . "行目 (期待値: 'First value' を yield した行)" . PHP_EOL;
45echo "取得された値: " . $generator->current() . PHP_EOL;
46
47// ジェネレータを次の yield まで進めます。
48// この時点で、'Second value' が yield された行でジェネレータが一時停止しています。
49$generator->next();
50echo "Second value を yield 後: " . $reflector->getExecutingLine() . "行目 (期待値: 'Second value' を yield した行)" . PHP_EOL;
51echo "取得された値: " . $generator->current() . PHP_EOL;
52
53// ジェネレータを終了まで進めます (return 文に到達)。
54// この時点で、return 文が書かれた行でジェネレータが一時停止しています。
55$generator->next();
56echo "ジェネレータ終了後: " . $reflector->getExecutingLine() . "行目 (期待値: return 文の行)" . PHP_EOL;
57
58// ジェネレータが終了したことを確認します。
59if (!$generator->valid()) {
60    echo "ジェネレータは完全に終了しました。" . PHP_EOL;
61}

PHP 8のReflectionGenerator::getExecutingLine()メソッドは、ジェネレータ関数が現在一時停止しているソースコード上の行番号を取得するために使用されます。このメソッドは引数を取らず、ジェネレータが一時停止している行番号を整数（int）で返します。

サンプルコードでは、demonstrateGeneratorExecutingLine()というジェネレータ関数を定義しています。この関数は複数のyield文と、最後にreturn文を含んでおり、yieldやreturnに到達するたびにその実行が一時停止します。

ReflectionGeneratorクラスのインスタンスを作成し、そのgetExecutingLine()メソッドを呼び出すことで、ジェネレータが現在どの行で停止しているかを確認できます。ジェネレータがまだ開始されていない状態では、このメソッドは0を返します。その後、$generator->next()を呼び出してジェネレータを次のyieldまたはreturnまで進めるたびに、getExecutingLine()はそのyield文やreturn文が記述されている行番号を正確に返します。この機能は、ジェネレータの内部的な実行フローを追跡したり、デバッグを行う際に役立ちます。