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

Copy
1<?php
2
3/**
4 * PHPにおける「ハッシュテーブル」は、通常、連想配列（array）として実装されます。
5 * このサンプルコードでは、ReflectionProperty::hasType()メソッドを使用して、
6 * クラスプロパティに型宣言があるかどうかを確認する方法を示します。
7 * 特に、連想配列型のプロパティを含めることで、キーワードとの関連性を示します。
8 */
9class Configuration
10{
11    /**
12     * 環境設定を表す連想配列（PHPにおけるハッシュテーブル）。
13     * array型として型宣言されています。
14     */
15    public array $settings;
16
17    /**
18     * データベース接続情報。
19     * string型として型宣言されています。
20     */
21    public string $dbHost;
22
23    /**
24     * 型宣言されていないプロパティ。
25     */
26    public $untypedData;
27
28    /**
29     * コンストラクタでプロパティを初期化します。
30     *
31     * @param array  $settings    設定情報
32     * @param string $dbHost      データベースホスト
33     * @param mixed  $untypedData 型宣言されていないデータ
34     */
35    public function __construct(array $settings, string $dbHost, $untypedData)
36    {
37        $this->settings = $settings;
38        $this->dbHost = $dbHost;
39        $this->untypedData = $untypedData;
40    }
41}
42
43/**
44 * Configurationクラスのプロパティに対してReflectionProperty::hasType()を使用し、
45 * 型宣言の有無を検査します。
46 */
47function inspectConfigurationProperties(): void
48{
49    $configInstance = new Configuration(
50        ['timeout' => 30, 'debugMode' => true],
51        'localhost',
52        12345
53    );
54
55    // Configurationクラスのリフレクションオブジェクトを作成
56    $reflectionClass = new ReflectionClass($configInstance);
57
58    echo "--- プロパティの型宣言の有無を検査 ---\n";
59
60    // クラスの全てのプロパティをループ
61    foreach ($reflectionClass->getProperties() as $property) {
62        $propertyName = $property->getName();
63
64        // ReflectionProperty::hasType() を使用して、プロパティが型宣言を持っているか確認
65        if ($property->hasType()) {
66            // 型宣言がある場合、その型名も取得して表示
67            $typeName = $property->getType()->getName();
68            echo "プロパティ '{$propertyName}' は型宣言を持っています。型: '{$typeName}'\n";
69        } else {
70            echo "プロパティ '{$propertyName}' は型宣言を持っていません。\n";
71        }
72    }
73}
74
75// プロパティ検査関数を実行
76inspectConfigurationProperties();
77

ReflectionProperty::hasType() メソッドは、PHPのクラスが持つプロパティに型宣言がされているかどうかをプログラムから確認するために使用されます。このメソッドは引数を取らず、プロパティに型が宣言されていれば true を、宣言されていなければ false を真偽値（bool）として返します。

このサンプルコードでは、Configuration クラスを定義し、型宣言されたプロパティ（public array $settings; や public string $dbHost;）と、型宣言されていないプロパティ（public $untypedData;）を用意しています。特に、$settings プロパティはPHPでハッシュテーブルとして使われることが多い連想配列（array型）の例として型宣言されています。

コードの実行部では、ReflectionClass を使って Configuration クラスのリフレクションオブジェクトを作成し、そこから各プロパティの ReflectionProperty オブジェクトを取得します。そして、それぞれのプロパティに対して hasType() メソッドを呼び出すことで、型宣言の有無を判断し、その結果と型名（存在する場合）を表示しています。これにより、実行時にプロパティの型情報を動的に検査できることがわかります。

Copy
1<?php
2
3/**
4 * プロパティの型宣言の有無を確認するためのサンプルクラス。
5 */
6class ExampleClass
7{
8    // 型宣言を持つプロパティ (int型)
9    public int $typedProperty;
10
11    // 型宣言を持たないプロパティ
12    public $untypedProperty;
13
14    // NULL許容の型宣言を持つプロパティ (?string型)
15    protected ?string $nullableTypedProperty = null;
16
17    // Union型のプロパティ (PHP 8.0+)
18    private int|float $unionTypeProperty = 0;
19
20    /**
21     * コンストラクタ
22     *
23     * @param int $typedProperty
24     * @param mixed $untypedProperty
25     */
26    public function __construct(int $typedProperty, $untypedProperty)
27    {
28        $this->typedProperty = $typedProperty;
29        $this->untypedProperty = $untypedProperty;
30    }
31}
32
33/**
34 * Reflection API を使用して、クラスのプロパティが型宣言を持つかを確認する関数。
35 *
36 * @param string $className 検査するクラス名
37 */
38function inspectPropertyTypes(string $className): void
39{
40    // 指定されたクラスのReflectionClassオブジェクトを作成
41    $reflectionClass = new ReflectionClass($className);
42
43    echo "--- クラス '{$className}' のプロパティ型宣言の有無を検査 ---" . PHP_EOL . PHP_EOL;
44
45    // クラスの全てのプロパティを取得し、ループで検査
46    foreach ($reflectionClass->getProperties() as $property) {
47        echo "プロパティ名: " . $property->getName() . PHP_EOL;
48
49        // ReflectionProperty::hasType() メソッドを使用して、プロパティが型宣言を持つか確認
50        if ($property->hasType()) {
51            echo "  - このプロパティは型宣言を持っています。" . PHP_EOL;
52            // 型宣言がある場合、getType() メソッドでその型情報を取得できます
53            echo "  - 宣言されている型: " . $property->getType() . PHP_EOL;
54        } else {
55            echo "  - このプロパティは型宣言を持っていません。" . PHP_EOL;
56        }
57        echo PHP_EOL;
58    }
59}
60
61// 上で定義したinspectPropertyTypes関数を呼び出し、ExampleClassのプロパティを検査
62inspectPropertyTypes(ExampleClass::class);

PHP 8 の ReflectionProperty::hasType() メソッドは、クラスのプロパティが型宣言を持っているかどうかをプログラムから確認するための機能です。このメソッドは ReflectionProperty クラスに属しており、プロパティの情報を取得した後に利用します。引数は必要なく、呼び出すとそのプロパティが型宣言を持っていれば true、持っていなければ false という真偽値を返します。

サンプルコードでは、ExampleClass というクラスに、int 型の$typedPropertyや、型宣言のない$untypedProperty、?string 型の$nullableTypedPropertyなど、様々なプロパティが定義されています。inspectPropertyTypes 関数では、PHPのリフレクションAPIを使ってこれらのプロパティを一つずつ取得し、それぞれの ReflectionProperty オブジェクトに対して hasType() メソッドを呼び出しています。これにより、どのプロパティが型宣言を持ち、どのプロパティが持たないかを具体的に判定し、結果を出力しているのがわかります。このメソッドは、コードの自動解析や、プロパティの型に基づいた処理を行う際に役立ちます。