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

getEndLineメソッドは、PHPの関数がソースコード上でどこで定義を終えているかを示す行番号を取得するメソッドです。このメソッドは、ReflectionFunctionクラスに属しています。ReflectionFunctionクラスは、PHPが提供するリフレクションAPIの一部であり、プログラムの実行中に、特定の関数に関する構造やメタデータを動的に取得するための強力な機能を提供します。

具体的には、getEndLineメソッドを呼び出すことで、リフレクト対象となっている関数の定義が終了する行、つまり、ソースコード上で関数の閉じ括弧}が存在する行の番号を整数値として取得できます。この情報は、コードの分析やデバッグ、あるいは自動生成ツールなどにおいて、関数の範囲を正確に把握するために非常に重要です。例えば、カスタムのコードレビューツールを作成する際に、特定の関数のコードブロックの長さを測定したり、エラーが発生した際にその関数がどの行で終わるのかをユーザーに提示したりする用途で活用できます。PHP 8以降の環境で、プログラムが自身のコード構造を理解し、操作するための基礎的な機能として、システムエンジニアがコードを解析する際に役立つでしょう。

Copy
1<?php
2function mySampleFunction()
3{
4    // この関数は複数行にわたります。
5    echo "Hello from my sample function!";
6    return true;
7}
8
9$reflector = new ReflectionFunction('mySampleFunction');
10$endLine = $reflector->getEndLine();

引数なし

引数はありません

int

このメソッドは、ReflectionFunctionオブジェクトが表す関数定義の終了行番号を整数で返します。