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

getReturnTypeメソッドは、関数やメソッドに関する詳細な情報を取得するためのReflectionFunctionAbstractクラスに属するメソッドです。このメソッドは、PHPの関数やクラスのメソッドが「どのような型の値を返すか」という、戻り値の型に関する情報を取得するために使用されます。

具体的には、PHP 7以降で導入された戻り値の型宣言がされている場合に、その型に関する詳細な情報を持つReflectionTypeオブジェクトを返します。ReflectionTypeオブジェクトからは、型がビルトイン型であるか、nullを許容するかといった、さらに詳しい情報を取得できます。もし、対象の関数やメソッドに戻り値の型宣言が指定されていない場合は、このメソッドはnullを返します。

getReturnTypeメソッドを利用することで、プログラムの実行中に、ある関数が整数型や文字列型、または特定のオブジェクト型など、どのような種類の値を返すように設計されているかを動的に調べることが可能になります。これは、例えばフレームワークが自動的に型チェックを行ったり、開発ツールがコードの解析を行ったりする際に非常に役立つ機能です。プログラムが自身の構造を理解し、その情報に基づいて動作を調整できる「リフレクション」と呼ばれる機能の一部であり、高度なプログラミングにおいて重要な役割を果たします。

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

引数なし

引数はありません

ReflectionType|null

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