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

Copy
1<?php
2
3/**
4 * 戻り値の型をintで宣言した関数。
5 * ReflectionFunctionAbstract::hasReturnType() はこの関数に対してtrueを返します。
6 */
7function functionWithReturnType(): int
8{
9    return 1;
10}
11
12/**
13 * 戻り値の型を宣言していない関数。
14 * ReflectionFunctionAbstract::hasReturnType() はこの関数に対してfalseを返します。
15 */
16function functionWithoutReturnType()
17{
18    return 'hello';
19}
20
21echo "--- ReflectionFunctionAbstract::hasReturnType の使用例 ---" . PHP_EOL;
22echo PHP_EOL;
23
24try {
25    // 戻り値の型が宣言された関数についてReflectionFunctionを作成
26    $reflectorWith = new ReflectionFunction('functionWithReturnType');
27
28    // hasReturnType() を使用して戻り値の型が宣言されているか確認
29    echo "関数 'functionWithReturnType' は戻り値の型を宣言していますか？: ";
30    echo ($reflectorWith->hasReturnType() ? 'はい' : 'いいえ') . PHP_EOL;
31    if ($reflectorWith->hasReturnType()) {
32        echo "  - 宣言されている型: " . $reflectorWith->getReturnType()?->getName() . PHP_EOL;
33    }
34
35    echo PHP_EOL;
36
37    // 戻り値の型が宣言されていない関数についてReflectionFunctionを作成
38    $reflectorWithout = new ReflectionFunction('functionWithoutReturnType');
39
40    // hasReturnType() を使用して戻り値の型が宣言されているか確認
41    echo "関数 'functionWithoutReturnType' は戻り値の型を宣言していますか？: ";
42    echo ($reflectorWithout->hasReturnType() ? 'はい' : 'いいえ') . PHP_EOL;
43    if ($reflectorWithout->hasReturnType()) {
44        // このブロックは実行されませんが、getReturnType()の存在を示します
45        echo "  - 宣言されている型: " . $reflectorWithout->getReturnType()?->getName() . PHP_EOL;
46    }
47
48} catch (ReflectionException $e) {
49    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
50}
51
52echo PHP_EOL;
53echo "この例では、関数に明示的に戻り値の型が指定されているかどうかを" . PHP_EOL;
54echo "`ReflectionFunctionAbstract::hasReturnType()` メソッドで確認しています。" . PHP_EOL;
55
56?>

ReflectionFunctionAbstract::hasReturnType()は、PHPの関数が戻り値の型（例: intやstringなど）を明示的に宣言しているかどうかを動的に確認するためのメソッドです。

このメソッドは引数を一切必要とせず、戻り値は真偽値（bool）です。対象の関数に戻り値の型が宣言されていればtrueを返し、宣言されていなければfalseを返します。

サンプルコードでは、まずReflectionFunctionクラスを使って、調べたい関数の情報を取得しています。 functionWithReturnType()のようにint型が宣言されている関数に対してhasReturnType()を呼び出すとtrueが返され、型が宣言されていることが確認できます。一方、functionWithoutReturnType()のように戻り値の型が宣言されていない関数に対してはfalseが返されることが示されています。

このように、このメソッドを使用することで、プログラムの実行中に各関数がどのように定義されているかを柔軟に調べることが可能になります。これにより、型宣言の有無に応じた処理の分岐や、特定の条件を満たす関数を検出する際などに役立てることができます。

Copy
1<?php
2
3/**
4 * 戻り値の型宣言がない関数。
5 * システムエンジニアを目指す初心者向けに、簡単な処理の関数を定義します。
6 */
7function greetUser(string $name)
8{
9    echo "Hello, " . $name . "!\n";
10}
11
12/**
13 * 戻り値の型宣言がある関数 (PHP 7.0以降)。
14 * PHP 8のコードスタイルに従い、戻り値の型 (int) を明示しています。
15 */
16function sumNumbers(int $a, int $b): int
17{
18    return $a + $b;
19}
20
21echo "--- 関数の戻り値の型宣言の有無をチェック ---\n\n";
22
23// ReflectionFunctionAbstract は抽象クラスのため、具体的な ReflectionFunction クラスを使用します。
24// ReflectionFunction は、グローバルな関数やクロージャに関するリフレクション情報を提供します。
25
26// 1. 戻り値の型宣言がない関数 'greetUser' のチェック
27$reflectionGreet = new ReflectionFunction('greetUser');
28echo "関数 'greetUser' に戻り値の型宣言があるか: ";
29// hasReturnType() メソッドは、関数に戻り値の型宣言がある場合に true を返します。
30if ($reflectionGreet->hasReturnType()) {
31    echo "はい\n";
32} else {
33    echo "いいえ\n";
34}
35
36echo "\n";
37
38// 2. 戻り値の型宣言がある関数 'sumNumbers' のチェック
39$reflectionSum = new ReflectionFunction('sumNumbers');
40echo "関数 'sumNumbers' に戻り値の型宣言があるか: ";
41if ($reflectionSum->hasReturnType()) {
42    echo "はい";
43    // getReturnType() メソッドで、宣言されている型情報を取得できます。
44    echo " (型: " . $reflectionSum->getReturnType()->getName() . ")\n";
45} else {
46    echo "いいえ\n";
47}
48

このPHPサンプルコードは、リフレクションAPIを用いて、関数に戻り値の型宣言があるかを動的に確認する方法を解説します。リフレクションとは、プログラムの実行時にその構造情報を取得する機能です。

コードでは、戻り値の型宣言がないgreetUser関数と、int型が宣言されているsumNumbers関数を定義しています。

ReflectionFunctionAbstract::hasReturnType()メソッドは引数なしで呼び出され、対象の関数に戻り値の型宣言が存在すればtrueを、存在しなければfalseをブール値で返します。

ReflectionFunctionインスタンスで各関数をチェックした結果、greetUserではfalse、sumNumbersではtrueが返されます。型宣言のあるsumNumbersの場合、getReturnType()->getName()で具体的な型名「int」も取得可能です。この機能は、コードの型安全性を高めたり、フレームワークで動的な型チェックを行う際に役立ちます。