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

isGeneratorメソッドは、対象のメソッドがジェネレータであるかどうかを判定するメソッドです。このメソッドは、ReflectionMethodクラスに属しており、指定されたメソッドがPHPのジェネレータ機能を利用している場合にtrueを、そうでない場合にfalseを返します。PHPのジェネレータとは、yieldキーワードを使って値を段階的に生成し、イテレータインターフェースを明示的に実装することなく反復処理を可能にする機能です。これにより、大量のデータを一度にメモリに読み込むのではなく、必要な時に必要な分だけデータを生成できるため、特に大規模なデータセットやファイル処理においてメモリ効率が良く、アプリケーションのパフォーマンス向上に貢献します。isGeneratorメソッドを用いることで、プログラムの実行中に動的にメソッドの特性を検査し、その結果に基づいて処理を適切に分岐させることが可能になります。例えば、ジェネレータであるメソッドに対しては特別なリソース解放処理を適用したり、非ジェネレータメソッドとは異なるデータ処理ロジックを適用したりするなど、より堅牢で効率的なコード設計に役立ちます。このメソッドは、Reflection APIを介してメソッドの内部構造を解析し、信頼性の高い動的な振る舞いの判断をサポートします。

Copy
1<?php
2
3class ExampleClass
4{
5    public function nonGeneratorMethod(): int
6    {
7        return 1;
8    }
9
10    public function generatorMethod(): \Generator
11    {
12        yield 1;
13        yield 2;
14    }
15}
16
17$reflectionClass = new ReflectionClass('ExampleClass');
18$reflectionMethod = $reflectionClass->getMethod('generatorMethod');
19$isGenerator = $reflectionMethod->isGenerator();
20
21// $isGenerator には、メソッドがジェネレータであるかどうかの真偽値が格納されます。
22// この場合、generatorMethod はジェネレータなので $isGenerator は true になります。

引数なし

引数はありません

bool

このメソッドは、呼び出し元のメソッドがジェネレーター関数であるかどうかを示す真偽値（true または false）を返します。