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

Copy
1<?php
2
3// PHP 8.3以降で型付きクラス定数が導入されました。
4// ReflectionClassConstant::hasType() メソッドは、定数に型が宣言されているかどうかを判定します。
5// このサンプルコードはPHP 8.3以降で実行することで、hasType()がtrueを返すケースを確認できます。
6
7class Product
8{
9    // 型が宣言されたクラス定数 (PHP 8.3以降で有効)
10    public const string TYPE_ELECTRONICS = 'electronics';
11    public const int MAX_PRICE = 9999;
12    public const bool IS_AVAILABLE = true;
13
14    // 型が宣言されていないクラス定数
15    public const DEFAULT_CURRENCY = 'JPY';
16    public const UNUSED_CONSTANT = null;
17}
18
19/**
20 * 指定されたクラスのクラス定数に関する情報を取得します。
21 * 取得した情報は連想配列（PHPにおけるハッシュテーブル）として返されます。
22 *
23 * @param string $className クラス名
24 * @return array クラス定数名とその詳細（値、型宣言の有無、型）を含む連想配列
25 */
26function getClassConstantsInfo(string $className): array
27{
28    $constantsInfo = [];
29    $reflectionClass = new ReflectionClass($className);
30
31    // クラスに定義されている全ての定数をReflectionClassConstantオブジェクトとして取得
32    $constants = $reflectionClass->getReflectionConstants();
33
34    foreach ($constants as $constant) {
35        // ReflectionClassConstant::hasType() を使用して、定数に型が宣言されているか確認
36        $hasType = $constant->hasType();
37
38        // 各定数に関する情報を連想配列に格納
39        // この連想配列のキーは定数名、値はさらに詳細な情報を持つ連想配列です。
40        $constantsInfo[$constant->getName()] = [
41            'value'     => $constant->getValue(),
42            'hasType'   => $hasType,
43            // 型が宣言されている場合のみ型情報を取得し、文字列として格納 (PHP 8.3以降)
44            'type'      => $hasType ? (string) $constant->getType() : 'なし',
45        ];
46    }
47
48    return $constantsInfo; // 結果を連想配列として返す
49}
50
51// Productクラスの定数情報を取得
52$productConstants = getClassConstantsInfo(Product::class);
53
54echo "--- クラス定数情報 (" . Product::class . ") ---" . PHP_EOL;
55
56// 取得した連想配列の情報を表示
57foreach ($productConstants as $name => $info) {
58    echo "定数名: " . $name . PHP_EOL;
59    echo "  値: " . var_export($info['value'], true) . PHP_EOL;
60    echo "  型宣言の有無: " . ($info['hasType'] ? 'あり' : 'なし') . PHP_EOL;
61    echo "  型: " . $info['type'] . PHP_EOL;
62    echo PHP_EOL;
63}

このサンプルコードは、PHP 8.3以降で導入された「型付きクラス定数」が、実際に型を宣言しているかどうかを判定するReflectionClassConstant::hasType()メソッドの利用例を示しています。hasType()メソッドは、引数を受け取らず、指定されたクラス定数に型が宣言されていればtrue、宣言されていなければfalseをブール値で返します。

コードでは、Productクラスに型付き定数と型なし定数を定義しています。getClassConstantsInfo関数は、ReflectionClassとReflectionClassConstantを利用して、指定されたクラスの全ての定数を取得し、それぞれの定数についてhasType()を呼び出します。これにより、定数に型が宣言されているかどうかをプログラム的に判断できます。

取得した定数情報は、PHPにおけるハッシュテーブルである「連想配列」として整理され、定数名、その値、そして型宣言の有無が明確に表示されます。特に、hasType()がtrueを返した場合にのみ、getType()メソッドで具体的な型情報を取得している点がポイントです。このサンプルを実行することで、PHP 8.3以降の環境において、どのクラス定数に型が宣言されているかを一目で確認でき、クラス設計やリフレクションAPIの理解を深めることができます。

Copy
1<?php
2
3/**
4 * A sample class demonstrating constants with and without declared types.
5 *
6 * IMPORTANT NOTE FOR PHP VERSION:
7 * Typed class constants (e.g., `public const string MY_CONSTANT = 'value';`)
8 * were introduced in PHP 8.3. This example leverages this feature to fully
9 * demonstrate `ReflectionClassConstant::hasType()`.
10 *
11 * If you run this code on PHP 8.0, 8.1, or 8.2, the class definition below
12 * (specifically, the typed constants) will result in a syntax error.
13 * Ensure your PHP environment is running PHP 8.3 or newer to execute this
14 * sample code successfully and observe `hasType()` returning true for typed constants.
15 */
16class MyClassWithConstants
17{
18    // This constant does not have an explicitly declared type.
19    public const UNTYPED_CONSTANT = 'This is an untyped constant.';
20
21    // This constant has a declared 'string' type. (Requires PHP 8.3+)
22    public const string TYPED_STRING_CONSTANT = 'Hello PHP 8.3!';
23
24    // This constant has a declared 'int|float' union type. (Requires PHP 8.3+)
25    public const int|float TYPED_UNION_CONSTANT = 123.45;
26
27    // This constant has a declared 'object|null' type. (Requires PHP 8.3+)
28    public const object|null TYPED_OBJECT_CONSTANT = null;
29}
30
31/**
32 * Demonstrates the use of ReflectionClassConstant::hasType()
33 * for inspecting class constants.
34 *
35 * This function iterates through the constants of `MyClassWithConstants`
36 * and uses Reflection to determine if each constant has an explicitly
37 * declared type, and if so, what that type is.
38 *
39 * This helps beginners understand how to programmatically check for
40 * type declarations on class constants, a concept similar to checking
41 * for properties or other characteristics using reflection.
42 */
43function demonstrateReflectionClassConstantHasType(): void
44{
45    echo "--- Demonstrating ReflectionClassConstant::hasType() ---\n\n";
46
47    // Create a ReflectionClass instance for MyClassWithConstants
48    $reflector = new ReflectionClass(MyClassWithConstants::class);
49
50    // Get all ReflectionClassConstant objects defined in the class
51    $constants = $reflector->getReflectionConstants();
52
53    foreach ($constants as $constant) {
54        $constantName = $constant->getName(); // Get the name of the constant
55        $hasType = $constant->hasType();     // Check if the constant has a declared type
56
57        echo "Constant '{$constantName}':\n";
58        echo "  - Declared value: " . var_export($constant->getValue(), true) . "\n";
59        echo "  - Has a declared type? " . ($hasType ? 'Yes' : 'No') . "\n";
60
61        // If the constant has a type, retrieve and display its name
62        if ($hasType) {
63            $type = $constant->getType(); // Get the ReflectionType object
64            // ReflectionType::getName() returns the type string (e.g., 'string', 'int|float')
65            echo "  - Declared type: " . $type->getName() . "\n";
66        }
67        echo "\n";
68    }
69
70    echo "--------------------------------------------------------\n";
71}
72
73// Execute the demonstration function to see the output
74demonstrateReflectionClassConstantHasType();

ReflectionClassConstant::hasType() メソッドは、PHPのクラス定数に明示的な型が宣言されているかどうかを判定するために使用されます。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。定数に型が指定されていれば true を、指定されていなければ false を返します。

提供されたサンプルコードでは、MyClassWithConstantsというクラスを定義し、型が宣言されていない定数と、string型やint|floatユニオン型のように型が宣言された定数を複数用意しています。ここで注意が必要なのは、クラス定数に型を宣言する機能はPHP 8.3で導入されたため、このサンプルコードを動作させるにはPHP 8.3以降の環境が必要です。それ以前のバージョンで型付き定数を使用すると、文法エラーとなります。

サンプルコードの実行部分では、ReflectionClassという機能を使ってMyClassWithConstantsの情報を取得し、そこに含まれる各定数に対してReflectionClassConstantオブジェクトを生成します。その後、ループ処理で各定数を順に処理し、hasType()メソッドを呼び出して型が宣言されているかを確認しています。型が宣言されている定数に対しては「Yes」と表示され、さらにgetType()メソッドを使ってその具体的な型名も出力します。これにより、プログラム的にクラス定数の型情報を動的に取得できることがわかります。この機能は、クラスの構造を解析したり、定数の型に基づいて処理を分岐させたりする際に役立ちます。