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

allowsNullメソッドは、PHPのプログラムが実行中に自身の構造や型に関する情報を取得できる「リフレクションAPI」の一部として、ReflectionNamedTypeクラスに属するメソッドです。このメソッドは、特定の型宣言がNULL値を許容するかどうかを判定する役割を実行します。

PHP 7.0以降、変数や関数の引数、戻り値に型を宣言できるようになりました。ReflectionNamedTypeオブジェクトは、これらの型宣言に関する詳細な情報を提供しており、allowsNullメソッドを呼び出すことで、その型がNULLを許容する型であるかを確認できます。

このメソッドは、NULLを許容する場合はtrueを、許容しない場合はfalseをブール値として返します。例えば、stringやintのように明示的にNULLを許容していない型に対してはfalseを返します。一方で、?stringのように型の前に疑問符が付いているnull許容型や、デフォルト値がnullである引数の型、またはnullが許容される戻り値の型に対してはtrueを返します。

この機能は、開発者が実行時に型情報を動的に検査し、型安全な処理を実装する際に非常に役立ちます。特に、フレームワークの構築やコードの自動生成、動的なバリデーションなど、プログラミング言語の構造を分析する場面で活用されます。

Copy
1<?php
2
3class ExampleClass {
4    public function exampleMethod(?string $nullableParam, int $nonNullableParam): void {}
5}
6
7$reflectionMethod = new ReflectionMethod('ExampleClass', 'exampleMethod');
8$reflectionParameter = $reflectionMethod->getParameters()[0]; // ?string $nullableParam を取得
9
10$type = $reflectionParameter->getType();
11
12if ($type instanceof ReflectionNamedType) {
13    $isNullable = $type->allowsNull();
14    // $isNullable はこの場合 true を返します。
15}

引数なし

引数はありません

bool

このメソッドは、対象の型がnullを許容するかどうかを示す真偽値（trueまたはfalse）を返します。