【PHP8.x】ReflectionProperty::IS_READONLY定数の使い方

Copy
1<?php
2
3/**
4 * PHP 8.1 から導入された readonly プロパティを持つクラスの例。
5 * プロパティごとに readonly を指定できます。
6 */
7class Product
8{
9    public readonly string $sku;
10    public string $name; // 通常のプロパティ
11    private int $stock;
12
13    public function __construct(string $sku, string $name, int $stock)
14    {
15        $this->sku = $sku;
16        $this->name = $name;
17        $this->stock = $stock;
18    }
19
20    public function getStock(): int
21    {
22        return $this->stock;
23    }
24}
25
26/**
27 * PHP 8.2 から導入された readonly クラスの例。
28 * クラス全体を readonly にすると、すべてのプロパティが自動的に readonly になります。
29 * 初期化はコンストラクタでのみ可能です。
30 */
31readonly class UserProfile
32{
33    public int $id; // readonly クラス内のプロパティは自動的に readonly
34    public string $username;
35    public string $email;
36
37    public function __construct(int $id, string $username, string $email)
38    {
39        $this->id = $id;
40        $this->username = $username;
41        $this->email = $email;
42    }
43}
44
45/**
46 * 指定されたクラスのプロパティをリフレクションAPIで調べ、
47 * そのプロパティが readonly であるかどうかを判定します。
48 * ReflectionProperty::IS_READONLY 定数を使用して判定します。
49 *
50 * @param string $className 調査対象のクラス名
51 */
52function demonstrateReadonlyPropertyDetection(string $className): void
53{
54    echo "--- クラス: {$className} のプロパティをチェック中 ---\n";
55
56    try {
57        $reflectionClass = new ReflectionClass($className);
58        $properties = $reflectionClass->getProperties();
59
60        if (empty($properties)) {
61            echo "クラス '{$className}' にプロパティは見つかりませんでした。\n";
62            return;
63        }
64
65        foreach ($properties as $property) {
66            $propertyName = $property->getName();
67            // ReflectionProperty::getModifiers() でプロパティの修飾子（public, private, static, readonlyなど）を
68            // ビットフラグとして取得します。
69            $modifiers = $property->getModifiers();
70
71            // 取得した修飾子に ReflectionProperty::IS_READONLY 定数（これもビットフラグ）が
72            // 含まれているか（つまり、readonly属性が設定されているか）をビットAND演算で判定します。
73            $isReadonly = ($modifiers & ReflectionProperty::IS_READONLY) === ReflectionProperty::IS_READONLY;
74
75            echo sprintf(
76                " プロパティ '%s': %s\n",
77                $propertyName,
78                $isReadonly ? 'READONLY' : 'NOT READONLY'
79            );
80        }
81    } catch (ReflectionException $e) {
82        echo "エラー: クラス '{$className}' のリフレクション中に問題が発生しました。 " . $e->getMessage() . "\n";
83    }
84    echo "\n";
85}
86
87// サンプルコードの実行
88demonstrateReadonlyPropertyDetection(Product::class);
89demonstrateReadonlyPropertyDetection(UserProfile::class);
90
91// 比較のため、通常のプロパティのみを持つクラスも確認
92class SimpleData
93{
94    public string $name;
95    protected int $value;
96
97    public function __construct(string $name, int $value)
98    {
99        $this->name = $name;
100        $this->value = $value;
101    }
102}
103demonstrateReadonlyPropertyDetection(SimpleData::class);
104
105// プロパティを持たないクラスの例
106class EmptyClass {}
107demonstrateReadonlyPropertyDetection(EmptyClass::class);
108

PHPのReflectionProperty::IS_READONLYは、クラスのプロパティがreadonly（読み取り専用）であるかどうかを判定するために使用される定数です。この定数自体はint型の値を持ち、引数は取りません。PHP 8.1で導入されたプロパティごとのreadonly指定や、PHP 8.2で導入されたクラス全体をreadonlyとする機能は、一度初期化されたプロパティの変更を防ぎ、データの不変性を保証する際に役立ちます。

サンプルコードでは、Productクラスで特定のプロパティをreadonlyにする例と、UserProfileクラスでクラス全体をreadonlyとして、そのプロパティがすべて自動的に読み取り専用となる例を示しています。

demonstrateReadonlyPropertyDetection関数は、指定されたクラスのプロパティをリフレクションAPIで調べ、それぞれのプロパティがreadonlyであるかを判定します。具体的には、ReflectionProperty::getModifiers()メソッドでプロパティに設定されている修飾子（public、private、readonlyなど）の情報をビットフラグとして取得します。そして、この取得した情報とReflectionProperty::IS_READONLY定数をビットAND演算で比較することで、そのプロパティがreadonly属性を持つかどうかを正確に判定し、その結果を出力しています。これにより、プログラムの実行中にプロパティの特性を動的に確認することが可能になります。