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

Copy
1<?php
2
3// ユーザー定義関数（戻り値の型宣言なし）
4function exampleFunction(string $name)
5{
6    return "Hello, " . $name;
7}
8
9// ReflectionFunction::hasTentativeReturnType の使用例
10// このメソッドは、PHP 8.0 以降で、特定の組み込み関数に
11// 「暫定的な戻り値の型」が定義されているかを調べます。
12// これは、`phpstan has no return type specified` のような警告に対し、
13// 組み込み関数の型情報がどのように扱われているかを理解する一助となります。
14// ユーザー定義関数には通常 `false` を返します。
15
16echo "--- 関数: exampleFunction (ユーザー定義関数, 型宣言なし) ---\n";
17$reflectionUserFunction = new ReflectionFunction('exampleFunction');
18echo "  hasTentativeReturnType: ";
19var_dump($reflectionUserFunction->hasTentativeReturnType());
20// ユーザー定義関数で型宣言がない場合、通常は false を返します。
21
22echo "  hasReturnType: ";
23var_dump($reflectionUserFunction->hasReturnType());
24// 明示的な型宣言も暫定的な型もないため、false を返します。
25if ($reflectionUserFunction->hasReturnType()) {
26    echo "  戻り値の型: " . (string)$reflectionUserFunction->getReturnType() . "\n";
27} else {
28    echo "  戻り値の型: (宣言なし)\n";
29}
30echo "\n";
31
32
33echo "--- 関数: strpos (組み込み関数, PHP 8.0で暫定型追加) ---\n";
34$reflectionBuiltinFunction = new ReflectionFunction('strpos');
35echo "  hasTentativeReturnType: ";
36var_dump($reflectionBuiltinFunction->hasTentativeReturnType());
37// PHP 8.0 以降では strpos に int|false の暫定型が追加されたため、true を返します。
38
39echo "  hasReturnType: ";
40var_dump($reflectionBuiltinFunction->hasReturnType());
41// 暫定型があるため、true を返します。
42if ($reflectionBuiltinFunction->hasReturnType()) {
43    echo "  戻り値の型: " . (string)$reflectionBuiltinFunction->getReturnType() . "\n";
44} else {
45    echo "  戻り値の型: (宣言なし)\n";
46}
47
48?>

ReflectionFunction::hasTentativeReturnTypeは、PHP 8.0以降で利用できるメソッドで、対象の関数に「暫定的な戻り値の型」が定義されているかどうかを確認します。このメソッドは引数を取らず、結果として真偽値（bool）を返します。

「暫定的な戻り値の型」とは、PHPの型ヒントがまだ完全ではなかった時期に作られた古い組み込み関数に対して、後から内部的に追加された型情報のことです。これは、phpstan has no return type specifiedのような静的解析ツールの警告を減らし、コードの型安全性を高めるために導入されました。

サンプルコードでは、ユーザーが作成したexampleFunctionのように、戻り値の型を明示的に宣言していない関数に対しては、このメソッドは通常falseを返します。これは、ユーザー定義関数には「暫定的な型」という概念がないためです。一方、PHPの組み込み関数であるstrposのように、PHP 8.0でint|falseのような暫定的な戻り値の型が内部的に追加された関数に対してはtrueを返します。

このメソッドは、特に組み込み関数がどのような型情報を内部的に持っているかを調べたい場合に役立ちます。また、hasTentativeReturnTypeが暫定型の有無を見るのに対し、hasReturnTypeは明示的に宣言された型、または暫定的な型のどちらかが存在するかを確認します。

Copy
1<?php
2
3/**
4 * 2つの整数値を加算し、その合計を返します。
5 * この関数は戻り値の型として `int` を明示的に宣言しています。
6 *
7 * PHP 8.1以降の環境では、このような通常の型宣言は
8 * 「暫定的な戻り値の型（Tentative Return Type）」とは見なされません。
9 * そのため、ReflectionFunction::hasTentativeReturnType() メソッドは通常 `false` を返します。
10 *
11 * PHP 8.0では、インターフェースや親クラスに型宣言がないメソッドに対し、
12 * 子クラスや実装クラスが型を付けた場合、その型は暫定的な戻り値の型と見なされ、
13 * ReflectionMethod::hasTentativeReturnType() (当時) が `true` を返していました。
14 * PHP 8.1以降、PHPの型システムが強化され、ほとんどのLSP (Liskov Substitution Principle)
15 * に準拠する型宣言は通常の有効な型宣言と見なされるようになったため、
16 * hasTentativeReturnType() が `true` を返すケースは非常に限定的になりました。
17 *
18 * 「phpstan override return type」というキーワードとの関連性について：
19 * PHPStanのような静的解析ツールは、コードの型安全性をチェックする際に、
20 * PHPの実際の型宣言（本メソッドが検出する暫定的な型も含む）と、
21 * PHPDocの `@return` タグによる型宣言の両方を考慮します。
22 * PHPDocでPHPの型宣言よりも厳密な型を指定して「オーバーライド」する場合、
23 * これらの型宣言間の整合性がPHPStanによって検証されます。
24 *
25 * @param int $a 最初の数値
26 * @param int $b 2番目の数値
27 * @return int 2つの数値の合計
28 */
29function addNumbers(int $a, int $b): int
30{
31    return $a + $b;
32}
33
34/**
35 * グローバル関数 'addNumbers' のリフレクション情報を取得します。
36 * ReflectionFunction クラスは、グローバル関数やクロージャのリフレクション（実行時の構造解析）に使用されます。
37 */
38$reflectionFunction = new ReflectionFunction('addNumbers');
39
40/**
41 * hasTentativeReturnType メソッドを呼び出し、関数が暫定的な戻り値の型を持つかどうかを確認します。
42 * PHP 8.1以降の環境でこのコードを実行すると、上記の理由により、通常 `bool(false)` が出力されます。
43 */
44var_dump($reflectionFunction->hasTentativeReturnType());
45

PHPのReflectionFunction::hasTentativeReturnTypeメソッドは、特定の関数が「暫定的な戻り値の型」を持っているかどうかを調べるために使用されます。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。trueであれば暫定的な型を持ち、falseであれば持たないことを意味します。

「暫定的な戻り値の型」とは、過去のPHPバージョン（特にPHP 8.0）において、インターフェースや親クラスに型が宣言されていないメソッドに、子クラスや実装クラスが初めて型を宣言した場合に適用された概念です。しかし、PHP 8.1以降のバージョンでは型システムが強化されたため、通常の型宣言はほとんどの場合「暫定的な」ものではなく、有効な型宣言と見なされるようになりました。

そのため、提供されたサンプルコードにあるaddNumbers関数のように、int型を明確に宣言した関数に対してこのメソッドを呼び出すと、PHP 8.1以降の環境では通常falseが返されます。これは、addNumbers関数の戻り値の型intが、もはや暫定的なものではないためです。

サンプルコードでは、まずaddNumbersという整数を加算する関数を定義しています。次に、ReflectionFunctionクラスを使ってこのaddNumbers関数の情報を取得し、hasTentativeReturnType()メソッドを呼び出しています。この結果はvar_dumpで表示され、前述の理由によりbool(false)が出力されることが期待されます。

PHPStanのような静的解析ツールは、PHPDocで宣言された型とPHP自体の型宣言との整合性を確認する際に、これらの型情報を利用します。hasTentativeReturnTypeは、PHPが実行時に型情報をどのように認識しているかを確認する低レベルな手段の一つと言えます。