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

Copy
1<?php
2
3/**
4 * プロパティの型宣言を持つクラスの例。
5 * PHP 7.4以降で導入されたプロパティ型宣言を使用しています。
6 */
7class Product
8{
9    // string型のプロパティ
10    public string $name;
11
12    // ?intはint型またはnullを許容するプロパティ (PHP 7.1以降で導入されたnull許容型)
13    public ?int $price = null;
14
15    // 型宣言がないプロパティ
16    public $description;
17
18    // union型プロパティ (PHP 8.0以降)
19    public string|int $identifier;
20}
21
22/**
23 * ReflectionProperty::getType() メソッドの動作を示す関数。
24 * クラスのプロパティの型情報を取得する方法を実演します。
25 */
26function demonstrateReflectionPropertyGetType(): void
27{
28    // ReflectionClassを使用してProductクラスのリフレクションインスタンスを作成
29    $reflectionClass = new ReflectionClass(Product::class);
30
31    // 検査するプロパティ名をリストアップ
32    $propertyNames = ['name', 'price', 'description', 'identifier'];
33
34    foreach ($propertyNames as $propertyName) {
35        // ReflectionPropertyインスタンスを取得
36        $reflectionProperty = $reflectionClass->getProperty($propertyName);
37
38        // getType() メソッドを呼び出し、プロパティの型情報を取得
39        // 戻り値は ReflectionType オブジェクトか、型宣言がない場合は null です。
40        $propertyType = $reflectionProperty->getType();
41
42        echo "プロパティ '{$propertyName}' の型情報: ";
43
44        if ($propertyType !== null) {
45            // 型宣言が存在する場合、その名前とnull許容性を表示
46            echo $propertyType->getName();
47            if ($propertyType->allowsNull()) {
48                echo " (null許容)";
49            }
50        } else {
51            // 型宣言が存在しない場合
52            echo "型宣言なし";
53        }
54        echo "\n";
55    }
56}
57
58// サンプルコードを実行
59demonstrateReflectionPropertyGetType();

PHPのReflectionProperty::getType()メソッドは、クラスのプロパティにどのようなデータ型が宣言されているかを知るために使用します。このメソッドは引数を必要としません。

戻り値はReflectionTypeというオブジェクトか、プロパティに型が宣言されていない場合はnullを返します。ReflectionTypeオブジェクトからは、プロパティの具体的な型名（例: string、int）や、そのプロパティがnullを許容するかどうかといった詳細な情報を取得できます。

提供されたサンプルコードでは、Productクラスにstring型、null許容のint型、型宣言なし、そしてPHP 8で導入されたstring|intのユニオン型といった様々なプロパティが定義されています。demonstrateReflectionPropertyGetType関数では、ReflectionClassとReflectionPropertyを使って、これらのプロパティ一つ一つにアクセスしています。

各プロパティに対してgetType()メソッドを呼び出し、その戻り値を確認しています。もし型宣言が存在し、getType()がReflectionTypeオブジェクトを返した場合は、そのオブジェクトのgetName()メソッドで型名を表示し、allowsNull()メソッドでnullを許容するかどうかを確認して出力しています。一方、getType()がnullを返した場合は、そのプロパティには型宣言がないことを示しています。このように、プログラムの実行中にプロパティの型情報を動的に検査できるのがこのメソッドの特長です。

Copy
1<?php
2
3/**
4 * プロパティの型宣言情報を取得するサンプルコードです。
5 *
6 * この関数は、クラスのプロパティに宣言された型（タイプヒント）に関する情報を
7 * ReflectionProperty::getType() メソッドを使って取得し、表示します。
8 * PHPの組み込み関数 gettype() が変数の実行時データ型を返すのに対し、
9 * ReflectionProperty::getType() はプロパティの定義時に指定された型宣言を参照します。
10 * これは、特に型安全なコードを書く際に、プロパティの意図された型をプログラム的に確認するのに役立ちます。
11 */
12function demonstrateReflectionPropertyGetType(): void
13{
14    // サンプルクラスの定義
15    // プロパティには様々な型宣言を施しています。
16    class UserProfile
17    {
18        public string $username;           // 文字列型として宣言されたプロパティ
19        protected ?int $userId = null;     // null許容の整数型として宣言されたプロパティ
20        private bool $isActive = false;    // 真偽値型として宣言されたプロパティ
21        public $bio;                       // 型宣言がないプロパティ
22        public array $roles;               // 配列型として宣言されたプロパティ
23        public string|int $identifier;     // 結合型（Union Type）として宣言されたプロパティ (PHP 8.0以降の機能)
24
25        public function __construct(string $username, string|int $identifier)
26        {
27            $this->username = $username;
28            $this->identifier = $identifier;
29        }
30    }
31
32    echo "--- UserProfile クラスのプロパティ型宣言の確認 ---\n";
33
34    // UserProfile クラスのリフレクションオブジェクトを作成
35    // これにより、クラスの構造情報をプログラムから取得できるようになります。
36    $reflectionClass = new ReflectionClass(UserProfile::class);
37
38    // 確認したいプロパティ名の配列
39    $propertyNames = ['username', 'userId', 'isActive', 'bio', 'roles', 'identifier'];
40
41    foreach ($propertyNames as $propertyName) {
42        // 指定されたプロパティのReflectionPropertyオブジェクトを取得
43        // このオブジェクトを通じて、プロパティの詳細な情報にアクセスできます。
44        $reflectionProperty = $reflectionClass->getProperty($propertyName);
45
46        // getType() メソッドを呼び出して型情報を取得
47        // 戻り値は ReflectionType オブジェクト、またはプロパティに型宣言がない場合は null となります。
48        $propertyType = $reflectionProperty->getType();
49
50        echo "\nプロパティ: $" . $propertyName . "\n";
51
52        if ($propertyType === null) {
53            // プロパティに型宣言がない場合
54            echo "  - このプロパティには型宣言がありません。\n";
55        } else {
56            // ReflectionType オブジェクトが返された場合、その情報を表示
57            // getName() メソッドで型名を取得します (例: "string", "int", "string|int" など)。
58            echo "  - 型: " . $propertyType->getName() . "\n";
59            // allowsNull() メソッドで、この型が null を許容するかどうかを確認します (例: "?int" の場合は true)。
60            echo "  - null を許容: " . ($propertyType->allowsNull() ? 'はい' : 'いいえ') . "\n";
61        }
62    }
63
64    echo "\n-----------------------------------------\n";
65}
66
67// 上記の関数を実行してデモンストレーションを開始します。
68demonstrateReflectionPropertyGetType();

PHPのReflectionProperty::getType()メソッドは、クラスのプロパティに宣言された型情報（タイプヒント）をプログラムから取得するために使用されます。これは、変数の実行時データ型を返す組み込み関数gettype()とは異なり、プロパティが定義される際に指定された型宣言そのものを参照します。

このメソッドには引数がなく、戻り値として?ReflectionTypeが返されます。具体的には、プロパティに型宣言がされている場合はReflectionTypeオブジェクトが返され、型宣言がない場合はnullが返されます。

サンプルコードでは、まずReflectionClassを使ってクラスの構造情報にアクセスし、次にgetProperty()メソッドで特定のプロパティのReflectionPropertyオブジェクトを取得しています。その後、取得したReflectionPropertyオブジェクトに対してgetType()を呼び出すことで、プロパティの型宣言情報が取得されます。

戻り値のReflectionTypeオブジェクトからは、getName()メソッドで「string」や「int|string」といった型名を取得でき、allowsNull()メソッドでその型がnullを許容するかどうかを確認できます。このように、プロパティの意図された型をプログラム的に確認できるため、型安全なコードの検証や動的な処理を実装する際に大変役立ちます。