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

hasReturnTypeメソッドは、対象の関数またはメソッドに戻り値の型が宣言されているかを確認するメソッドです。このメソッドは、PHPのReflection APIの一部であるReflectionFunctionAbstractクラスに属しています。ReflectionFunctionAbstractクラスは、ユーザー定義関数、クラスのメソッド、クロージャなど、PHPで定義されたあらゆる種類の関数に関する情報を、プログラム実行時に動的に取得するための抽象基底クラスです。

PHP 7.0以降で導入された戻り値の型宣言は、関数の返す値の型を明示的に指定することで、コードの信頼性と可読性を向上させる重要な機能です。hasReturnTypeメソッドは、このような型宣言がソースコード内で明確に指定されているかどうかを、プログラム実行時に動的にチェックする目的で使用されます。

このメソッドは引数を取りません。戻り値は真偽値（bool）です。もし対象の関数またはメソッドに戻り値の型が宣言されていればtrueを返し、そうでなければfalseを返します。例えば、function foo(): string { ... } のような関数ではtrueを返し、function bar() { ... } のような関数ではfalseを返します。

この機能は、フレームワークやライブラリの作成者が、ユーザーが定義した関数やメソッドが特定の規約に従って戻り値の型を宣言しているかを検証する際や、コードの静的解析ツールを開発する際に特に有用です。これにより、コードの品質向上やエラーの早期発見に貢献できます。

Copy
1<?php
2
3class MyClass
4{
5    public function myMethodWithReturnType(): string
6    {
7        return "Hello";
8    }
9
10    public function myMethodWithoutReturnType()
11    {
12        return "World";
13    }
14}
15
16// ReflectionMethod のインスタンスを作成し、myMethodWithReturnType を反映
17$reflectionMethodWithReturnType = new ReflectionMethod('MyClass', 'myMethodWithReturnType');
18// hasReturnType メソッドを呼び出す
19$resultWithReturnType = $reflectionMethodWithReturnType->hasReturnType();
20var_dump($resultWithReturnType); // bool(true)
21
22// ReflectionMethod のインスタンスを作成し、myMethodWithoutReturnType を反映
23$reflectionMethodWithoutReturnType = new ReflectionMethod('MyClass', 'myMethodWithoutReturnType');
24// hasReturnType メソッドを呼び出す
25$resultWithoutReturnType = $reflectionMethodWithoutReturnType->hasReturnType();
26var_dump($resultWithoutReturnType); // bool(false)
27
28?>

引数なし

引数はありません

bool

このメソッドは、対象となる関数またはメソッドに返り値の型宣言が定義されているかどうかを示す真偽値（trueまたはfalse）を返します。