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

getReturnTypeメソッドはReflectionMethodクラスに属し、特定のメソッドが返す値の型、つまり戻り値の型に関する情報を取得するメソッドです。

ReflectionMethodクラスは、プログラムが実行中にメソッドの構造を検査する機能を提供します。このgetReturnTypeメソッドを利用することで、例えば、あるメソッドが整数（int）を返すのか、文字列（string）を返すのかといった、ソースコードで宣言された戻り値の型情報を動的に取得できます。これは、PHP 7以降の戻り値の型宣言を解析する際に重要です。

このメソッドは、戻り値の型が宣言されている場合、ReflectionTypeクラスのオブジェクトを返します。このReflectionTypeオブジェクトからは、getName()メソッドで具体的な型名（例: "string", "int"）を取得したり、allowsNull()メソッドでその型がnullを許容するかどうかを確認できます。これにより、より詳細な型情報をプログラムで利用することが可能です。

もし対象のメソッドに戻り値の型が明示的に宣言されていない場合は、getReturnTypeメソッドはnullを返します。この機能は、フレームワークやコード解析ツールにおいて、動的にメソッドの戻り値の型に応じた処理を行う際に非常に有用で、より堅牢で柔軟なPHPアプリケーションの開発に貢献します。

Copy
1<?php
2
3class MyService
4{
5    public function getData(): array
6    {
7        return [];
8    }
9}
10
11$reflectionMethod = new ReflectionMethod(MyService::class, 'getData');
12$returnType = $reflectionMethod->getReturnType();

引数なし

引数はありません

?ReflectionType

ReflectionMethod::getReturnType()は、メソッドが定義している戻り値の型情報をReflectionTypeオブジェクト、または型が指定されていない場合はnullを返します。