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

getReturnTypeメソッドは、指定された関数の戻り値の型情報を取得するメソッドです。このメソッドは、PHPの強力な機能であるリフレクションAPIを構成するReflectionFunctionクラスに属しています。リフレクションAPIは、プログラムの実行中にクラス、インターフェース、関数、メソッド、プロパティなどの構造に関する情報を取得し、操作することを可能にします。ReflectionFunctionクラスは、特に特定の関数についての詳細な情報を動的に調べるために利用されます。

getReturnTypeメソッドを呼び出すことで、対象の関数がどのような型の値を返すように宣言されているかを実行時に正確に把握することができます。具体的には、関数の定義で戻り値の型が宣言されている場合、このメソッドはその型に関する情報を含むReflectionTypeオブジェクトを返します。ReflectionTypeオブジェクトからは、型が何か（例: int, string, array）、またはその型がnullを許容するかどうかなど、具体的な型情報を取得できます。もし関数に戻り値の型が一切宣言されていない場合は、このメソッドはnullを返します。

この機能は、コード解析ツールやドキュメント生成ツール、あるいはアプリケーションの柔軟性を高めるために、関数の戻り値の型を動的に検証したり利用したりする場面で非常に有用です。開発者がプログラムの内部構造を深く理解し、より高度な処理を実装する手助けとなります。

Copy
1<?php
2
3function exampleFunction(): string
4{
5    return 'hello';
6}
7
8$reflectionFunction = new ReflectionFunction('exampleFunction');
9$returnType = $reflectionFunction->getReturnType();

引数なし

引数はありません

ReflectionType|null

このメソッドは、対象となる関数の定義で指定された戻り値の型情報を表すReflectionTypeオブジェクト、または戻り値の型が指定されていない場合はnullを返します。