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

getExecutingGeneratorメソッドは、ReflectionGeneratorクラスに属し、ジェネレータの現在の実行状態に関する情報を提供するメソッドです。このメソッドは、ReflectionGeneratorオブジェクトが「反射」している特定のジェネレータが、現在どのジェネレータによって実際に処理が実行されているかを特定するのに使用されます。

具体的には、対象のジェネレータがPHPのyield from構文を用いて、別のジェネレータに処理の実行を委譲している場合に、現在実際に値を生成しているその「委譲先のジェネレータ」のGeneratorオブジェクトを返します。yield fromは、あるジェネレータが別のジェネレータの処理を一時的に引き継ぎ、その生成する値を透過的に提供するための機能です。

もし、対象のジェネレータがyield fromによる委譲を行っておらず、自身が直接処理を実行している場合は、このメソッドはnullを返します。

このメソッドは、複数のジェネレータがyield fromによって複雑に連携しているような状況で、現在の処理の流れを追跡したり、デバッグを行ったりする際に非常に役立ちます。実行中のジェネレータが入れ子になっている場合に、最も内側でアクティブなジェネレータを特定するのに利用できます。

Copy
1<?php
2
3function mySimpleGenerator() {
4    yield 1;
5    yield 2;
6}
7
8$generator = mySimpleGenerator();
9$generator->current(); // ジェネレータを実行状態にするため、一度進める
10
11$reflectionGenerator = new ReflectionGenerator($generator);
12$executingGenerator = $reflectionGenerator->getExecutingGenerator();

引数なし

引数はありません

Generator

ReflectionGenerator::getExecutingGeneratorは、現在実行中のGeneratorオブジェクトを返します。これにより、Generatorの内部状態にアクセスし、操作することが可能になります。