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

getExecutingLineメソッドは、ReflectionFiberオブジェクトが表すファイバーが現在実行している、または処理を中断しているソースコードの行番号を取得する処理を実行するメソッドです。PHP 8.1で導入されたFiberは、プログラム内で協調的なマルチタスクを実現し、非同期処理をより効率的かつ直感的に記述するための強力な機能です。ReflectionFiberクラスは、このFiberの実行状態や内部情報を検査するためのリフレクションAPIを提供し、その一つとしてgetExecutingLineメソッドが存在します。

このメソッドは、ReflectionFiberのインスタンスに対して呼び出され、ファイバーが現在処理を進めている具体的なコード行を整数値で返します。特に、ファイバーが処理を一時停止（中断）している場合、このメソッドはその中断された行番号を正確に示します。これにより、デバッグ作業において、複数のファイバーが動作している状況下で、どのファイバーがどのコード行で処理を待機しているのか、あるいは問題を引き起こしているのかを素早く特定することが可能になります。

返される値は、ソースファイル内の行番号を表す正の整数です。しかし、対象のファイバーがまだ一度も実行を開始していない場合や、すでに実行を完全に終了している場合には、このメソッドは0を返します。したがって、この戻り値を確認することで、ファイバーの現在のライフサイクル状態の一部も把握できます。システムエンジニアとして、複雑な非同期処理を含むアプリケーションのデバッグやパフォーマンスチューニングを行う際、このgetExecutingLineメソッドは、ファイバーの実行フローを詳細に分析するための重要なツールとして活用できます。

Copy
1<?php
2$fiber = new Fiber(function (): void {
3    // この行でファイバーの実行が一時停止します
4    Fiber::suspend();
5});
6
7$fiber->start();
8
9$reflectionFiber = new ReflectionFiber($fiber);
10$reflectionFiber->getExecutingLine();

引数なし

引数はありません

?int

ReflectionFiber::getExecutingLine()は、現在実行中のFiberのコード上の行番号を整数で返します。Fiberが実行されていない場合はnullを返します。