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

getTentativeReturnTypeメソッドは、PHPのReflectionMethodクラスに属し、特定のメソッドが返す「仮の戻り値の型」を取得するメソッドです。

ReflectionMethodクラスは、クラスに定義されたメソッドに関するさまざまな情報を、プログラム実行時に動的に調べるために使用されます。このgetTentativeReturnTypeメソッドは、対象のメソッドが親クラスのメソッドをオーバーライドしている場合や、インターフェースのメソッドを実装している場合に、その親やインターフェースで宣言されている戻り値の型を考慮した上で、最終的にそのメソッドが返すことが期待される型を取得します。

PHP 8以降では、メソッドの戻り値の型宣言において、親クラスやインターフェースの型よりも「より具体的な型」を子クラスや実装クラスで指定できるようになりました。このメソッドは、このような型継承のルールに基づいて、実際に適用される戻り値の型を正確に判断するために利用されます。

メソッドに明示的な戻り値の型が宣言されていれば、通常のgetReturnType()メソッドと同じ型情報を返します。戻り値はReflectionTypeオブジェクトであり、これを通して型の詳細な情報を得ることができます。メソッドに戻り値の型が指定されていない場合はnullが返されます。

Copy
1<?php
2
3class ExampleClass
4{
5    public function exampleMethod(): string
6    {
7        return 'Hello';
8    }
9}
10
11$reflectionMethod = new ReflectionMethod(ExampleClass::class, 'exampleMethod');
12
13$reflectionTypeOrNull = $reflectionMethod->getTentativeReturnType();
14
15?>

引数なし

引数はありません

?ReflectionType

このメソッドは、メソッドに定義されている仮の戻り値の型情報を ReflectionType オブジェクトとして返します。仮の戻り値の型が定義されていない場合は、null が返されます。