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

Copy
1<?php
2
3// このサンプルコードは、PHPのReflectionMethod::hasReturnType メソッドの使用方法を示します。
4// このメソッドは、対象のメソッドが戻り値の型を明示的に宣言しているかどうかを判定します。
5// PHP 8で導入された #[ReturnTypeWillChange] 属性を持つメソッドも含まれており、
6// hasReturnType がこの属性の有無ではなく、実際の型宣言をチェックすることを示します。
7
8class MyService
9{
10    // 戻り値の型が 'string' として明示的に宣言されているメソッド
11    public function methodWithReturnType(): string
12    {
13        return "Hello";
14    }
15
16    // 戻り値の型が宣言されていないメソッド
17    public function methodWithoutReturnType()
18    {
19        // 何らかの処理
20    }
21
22    // #[ReturnTypeWillChange] 属性が付与され、かつ戻り値の型が 'int' として宣言されているメソッド
23    // ReflectionMethod::hasReturnType は、#[ReturnTypeWillChange] 属性の有無に関わらず、
24    // メソッドのシグネチャに型が宣言されているかのみをチェックします。
25    #[ReturnTypeWillChange]
26    public function methodWithReturnTypeWillChange(): int
27    {
28        return 123;
29    }
30}
31
32// MyServiceクラスのReflectionClassインスタンスを作成します。
33$reflectionClass = new ReflectionClass(MyService::class);
34
35echo "--- ReflectionMethod::hasReturnType の使用例 ---\n";
36
37// 1. 戻り値の型が宣言されているメソッドをチェックします。
38$methodWithReturnType = $reflectionClass->getMethod('methodWithReturnType');
39echo "メソッド 'methodWithReturnType': ";
40echo $methodWithReturnType->hasReturnType() ? "戻り値の型が宣言されています。\n" : "戻り値の型は宣言されていません。\n";
41
42// 2. 戻り値の型が宣言されていないメソッドをチェックします。
43$methodWithoutReturnType = $reflectionClass->getMethod('methodWithoutReturnType');
44echo "メソッド 'methodWithoutReturnType': ";
45echo $methodWithoutReturnType->hasReturnType() ? "戻り値の型が宣言されています。\n" : "戻り値の型は宣言されていません。\n";
46
47// 3. #[ReturnTypeWillChange] 属性と戻り値の型宣言を持つメソッドをチェックします。
48$methodWithReturnTypeWillChange = $reflectionClass->getMethod('methodWithReturnTypeWillChange');
49echo "メソッド 'methodWithReturnTypeWillChange' (#[ReturnTypeWillChange] 属性あり): ";
50echo $methodWithReturnTypeWillChange->hasReturnType() ? "戻り値の型が宣言されています。\n" : "戻り値の型は宣言されていません。\n";
51

PHP 8のReflectionMethod::hasReturnTypeは、メソッドが戻り値の型を明示的に宣言しているかどうかを判定するメソッドです。このメソッドは引数をとらず、戻り値としてbool型を返します。メソッドのシグネチャに: stringや: intのような戻り値の型が記述されていればtrueを、型が宣言されていなければfalseを返します。

このメソッドは、PHP 8で導入された#[ReturnTypeWillChange]属性の有無には影響されません。この属性は戻り値の型を変更する際の特殊な指定ですが、hasReturnTypeがチェックするのは属性の有無ではなく、あくまでメソッド定義に実際に型宣言があるか否かです。そのため、属性が付与されていても、戻り値の型が宣言されていればtrueを返します。

サンプルコードでは、戻り値の型が宣言されているメソッド、されていないメソッド、そして#[ReturnTypeWillChange]属性と型宣言が両方あるメソッドの三つのケースでhasReturnTypeを使用し、その具体的な挙動を示しています。

Copy
1<?php
2
3/**
4 * ReflectionMethod::hasReturnType の使用例を示すクラス。
5 * メソッドが戻り値の型を宣言しているかどうかを確認します。
6 */
7class ExampleReflectionTarget
8{
9    /**
10     * string 型の戻り値の型を宣言しているメソッド。
11     *
12     * @return string
13     */
14    public function methodWithStringType(): string
15    {
16        return "PHP Expert";
17    }
18
19    /**
20     * 戻り値の型を宣言していないメソッド。
21     *
22     * @return mixed
23     */
24    public function methodWithoutType()
25    {
26        return 8;
27    }
28
29    /**
30     * null 許容の int 型の戻り値の型を宣言しているメソッド。
31     *
32     * @return int|null
33     */
34    public function methodWithNullableIntType(): ?int
35    {
36        return null;
37    }
38}
39
40// Reflection APIを使用して、ExampleReflectionTarget クラスの情報を取得します。
41$reflectionClass = new ReflectionClass(ExampleReflectionTarget::class);
42
43echo "--- ReflectionMethod::hasReturnType の使用例 ---" . PHP_EOL;
44echo "このメソッドは、ReflectionMethod インスタンスが表すメソッドが戻り値の型を宣言しているかを判定します。" . PHP_EOL . PHP_EOL;
45
46// 1. methodWithStringType メソッドの ReflectionMethod インスタンスを取得
47$methodWithStringType = $reflectionClass->getMethod('methodWithStringType');
48echo "メソッド 'methodWithStringType': ";
49// hasReturnType() を呼び出して、戻り値の型が宣言されているか確認
50echo $methodWithStringType->hasReturnType() ? "戻り値の型を宣言しています。" : "戻り値の型を宣言していません。";
51echo PHP_EOL;
52
53// 2. methodWithoutType メソッドの ReflectionMethod インスタンスを取得
54$methodWithoutType = $reflectionClass->getMethod('methodWithoutType');
55echo "メソッド 'methodWithoutType': ";
56// hasReturnType() を呼び出して、戻り値の型が宣言されているか確認
57echo $methodWithoutType->hasReturnType() ? "戻り値の型を宣言しています。" : "戻り値の型を宣言していません。";
58echo PHP_EOL;
59
60// 3. methodWithNullableIntType メソッドの ReflectionMethod インスタンスを取得
61$methodWithNullableIntType = $reflectionClass->getMethod('methodWithNullableIntType');
62echo "メソッド 'methodWithNullableIntType': ";
63// hasReturnType() を呼び出して、戻り値の型が宣言されているか確認
64echo $methodWithNullableIntType->hasReturnType() ? "戻り値の型を宣言しています。" : "戻り値の型を宣言していません。";
65echo PHP_EOL;
66
67?>

ReflectionMethod::hasReturnTypeは、PHPのReflection APIの一部で、特定のメソッドが戻り値の型を明示的に宣言しているかどうかを判定するために使用されます。Reflection APIとは、実行中のプログラムのクラスやメソッドなどの構造を動的に調べることができる機能です。

このhasReturnTypeメソッドは引数を一切取らず、戻り値として真偽値（trueまたはfalse）を返します。対象のメソッドがpublic function someMethod(): stringのようにコロン（:）の後にstringやint、?boolといった戻り値の型を宣言していればtrueを返し、public function someMethod()のように戻り値の型が明示されていない場合はfalseを返します。PHPDocコメントで@return stringなどと記述されていても、PHPの構文として型宣言がなければfalseとなる点にご注意ください。

サンプルコードでは、methodWithStringType()やmethodWithNullableIntType()のように戻り値の型を宣言しているメソッドに対してはtrueが返され、methodWithoutType()のように型を宣言していないメソッドに対してはfalseが返される様子が示されています。これは、メソッドの定義時に:を使って型を指定しているかどうかに基づく判定です。

この機能は、フレームワークやライブラリの開発において、メソッドの戻り値の型定義に基づいて処理を分岐させたり、型の制約を検証したりする際に活用されます。