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

Copy
1<?php
2
3/**
4 * 共用型プロパティを持つサンプルクラス。
5 * PHP 8で導入された共用型 (Union Types) を使用しています。
6 */
7class ExampleClass
8{
9    // int型またはstring型を受け入れる共用型プロパティ
10    public int|string $value;
11
12    /**
13     * コンストラクタ。
14     *
15     * @param int|string $value 初期値
16     */
17    public function __construct(int|string $value)
18    {
19        $this->value = $value;
20    }
21}
22
23// ReflectionClass を使用して ExampleClass のリフレクションオブジェクトを作成
24$reflectionClass = new ReflectionClass(ExampleClass::class);
25
26// 'value' プロパティのリフレクションオブジェクトを取得
27$reflectionProperty = $reflectionClass->getProperty('value');
28
29// プロパティの型情報を取得
30$propertyType = $reflectionProperty->getType();
31
32// 取得した型が ReflectionUnionType のインスタンスであるかを確認
33if ($propertyType instanceof ReflectionUnionType) {
34    echo "プロパティ '" . $reflectionProperty->getName() . "' は共用型です。\n";
35
36    // getTypes() メソッドを使って、共用型を構成する個々の型（ReflectionNamedTypeオブジェクトの配列）を取得
37    $typesInUnion = $propertyType->getTypes();
38
39    echo "構成する型:\n";
40    foreach ($typesInUnion as $type) {
41        // 各型は ReflectionNamedType オブジェクトであり、getName() で型名を取得できる
42        echo "- " . $type->getName() . "\n";
43    }
44} else {
45    // 共用型でない場合は、その型名を出力
46    echo "プロパティ '" . $reflectionProperty->getName() . "' は共用型ではありません。\n";
47    echo "型: " . ($propertyType ? $propertyType->getName() : '不明') . "\n";
48}
49
50?>

このサンプルコードは、PHP 8で導入された「共用型（Union Types）」、つまり複数の型のいずれかを受け入れるプロパティや引数の情報を、プログラムの実行中に動的に取得する方法を示しています。

ExampleClassでは、int|stringという共用型のプロパティ$valueを定義しています。PHPのリフレクション機能を使うと、このように定義されたクラスやプロパティの詳細な情報を取得できます。具体的には、ReflectionClassやReflectionPropertyを通じてプロパティの型情報を取得します。

取得したプロパティの型情報が共用型である場合、それはReflectionUnionTypeというオブジェクトとして扱われます。このReflectionUnionTypeクラスのgetTypesメソッドは、その共用型を構成する個々の型を配列として返します。このメソッドは引数をとりません。戻り値の配列には、ReflectionNamedTypeオブジェクトが含まれており、それぞれのオブジェクトが共用型を構成する具体的な型（例えばintやstring）を表しています。

サンプルコードでは、まずプロパティvalueの型がReflectionUnionTypeのインスタンスであるかを確認しています。もしそうであれば、getTypes()メソッドを呼び出して、共用型を構成する各型のReflectionNamedTypeオブジェクトの配列を取得します。その後、この配列をループで処理し、各ReflectionNamedTypeオブジェクトのgetName()メソッドを使って、具体的な型名（"int"や"string"）を取り出し、表示しています。

このように、ReflectionUnionType::getTypes()メソッドは、共用型の詳細な構成をプログラムから調べる際に利用され、動的な型チェックや開発ツールの作成などで役立ちます。

Copy
1<?php
2
3// PHP 8 で導入されたユニオン型を持つクラスを定義します。
4// このクラスは、ReflectionUnionType::getTypes() メソッドの使用例を示します。
5class MyDataTypeExample
6{
7    // 'dataValue' プロパティは、int、string、または null のいずれかの型を取るユニオン型です。
8    public int|string|null $dataValue;
9
10    public function __construct(int|string|null $initialValue)
11    {
12        $this->dataValue = $initialValue;
13    }
14}
15
16/**
17 * ReflectionUnionType::getTypes() メソッドの使用方法を示す関数です。
18 * このメソッドは、ユニオン型を構成する個々の型の ReflectionType オブジェクトの配列を返します。
19 */
20function demonstrateReflectionUnionTypeGetTypes(): void
21{
22    echo "--- ReflectionUnionType::getTypes() の使用例 ---\n\n";
23
24    // MyDataTypeExample クラスのリフレクションオブジェクトを作成します。
25    $reflectionClass = new ReflectionClass(MyDataTypeExample::class);
26
27    // 'dataValue' プロパティのリフレクションオブジェクトを取得します。
28    $reflectionProperty = $reflectionClass->getProperty('dataValue');
29
30    // プロパティの型情報を取得します。
31    $type = $reflectionProperty->getType();
32
33    // 取得した型が ReflectionUnionType のインスタンスであるかを確認します。
34    // ReflectionUnionType は複数の型が | (パイプ) で結合された型を表します。
35    if ($type instanceof ReflectionUnionType) {
36        echo "プロパティ 'dataValue' はユニオン型です。\n";
37        echo "getTypes() メソッドを使って、ユニオン型を構成する個々の型を取得します。\n\n";
38
39        // ReflectionUnionType::getTypes() を呼び出し、構成する型の配列を取得します。
40        $unionTypes = $type->getTypes();
41
42        echo "--- ユニオン型を構成する型の一覧 ---\n";
43        foreach ($unionTypes as $individualType) {
44            // 各 individualType は ReflectionNamedType (または ReflectionIntersectionType など) のインスタンスです。
45            // getName() で型の名前を取得できます（例: 'int', 'string', 'null'）。
46            // isBuiltin() で組み込み型（int, stringなど）かを確認できます。
47            // allowsNull() でこの特定の型が null を許容するかを確認できます（ユニオン型全体ではなく、個々の型について）。
48            echo "- 型名: " . $individualType->getName();
49            echo " (組み込み型: " . ($individualType->isBuiltin() ? 'はい' : 'いいえ') . ")";
50            echo " (null許容: " . ($individualType->allowsNull() ? 'はい' : 'いいえ') . ")\n";
51        }
52        echo "-------------------------------------\n";
53    } else {
54        // もしプロパティがユニオン型でなかった場合のメッセージです。
55        echo "プロパティ 'dataValue' はユニオン型ではありません。\n";
56        echo "取得された型: " . ($type ? $type->getName() : '不明') . "\n";
57    }
58
59    echo "\n--- 処理完了 ---\n";
60}
61
62// 上記のデモンストレーション関数を実行します。
63demonstrateReflectionUnionTypeGetTypes();
64

PHP 8で導入されたユニオン型は、一つの変数やプロパティが複数の異なる型の値を許容する際に使用されます。ReflectionUnionType::getTypes()メソッドは、このユニオン型がどのような個々の型で構成されているかをプログラムの実行中に動的に調べるためのリフレクション機能の一部です。

このメソッドは引数を一切取りません。戻り値としては、ユニオン型を構成するそれぞれの型を表すReflectionTypeオブジェクトの配列を返します。例えば、int|string|nullというユニオン型の場合、getTypes()を呼び出すと、int、string、nullという各型に対応するReflectionTypeオブジェクトが配列として返されます。

サンプルコードでは、int|string|nullというユニオン型を持つプロパティ$dataValueを定義したクラスMyDataTypeExampleを使用しています。まず、このクラスのプロパティから型情報を取得し、それがユニオン型であることを確認します。その後、ReflectionUnionType::getTypes()メソッドを実行することで、ユニオン型を構成するint、string、nullという個々の型情報を取得しています。取得した各型情報からは、その型名が「int」や「string」であること、それがPHPの組み込み型であること、そしてその型がnullを許容するかどうかといった詳細を確認できます。これにより、プログラムの実行時に複雑な型定義を解析し、適切な処理を行うことが可能になります。