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

Copy
1<?php
2
3/**
4 * PHP 8.2以降で導入されたreadonlyクラスの定義
5 * readonly修飾子をクラスに適用すると、そのクラスの全てのプロパティは自動的にreadonlyプロパティとなる。
6 */
7readonly class MyReadOnlyClass
8{
9    public string $name;
10    public int $value;
11
12    public function __construct(string $name, int $value)
13    {
14        $this->name = $name;
15        $this->value = $value;
16    }
17}
18
19/**
20 * 通常のクラスの定義
21 */
22class MyNormalClass
23{
24    public string $name;
25
26    public function __construct(string $name)
27    {        $this->name = $name;
28    }
29}
30
31/**
32 * 指定されたクラスがreadonlyであるかを判定し、その結果を出力します。
33 *
34 * この関数は、ReflectionClassクラスとReflectionClass::IS_READONLY定数を使用して、
35 * クラスがreadonly修飾子を持っているかを確認する方法を示します。
36 * (提供されたリファレンス情報ではReflectionEnum::IS_READONLYとされていますが、
37 *  キーワード「php what is a readonly class」とPHPの現在の仕様に基づき、
38 *  readonlyクラスの判定にはReflectionClass::IS_READONLYが適切です。)
39 *
40 * @param object|string $class 対象のクラス名（文字列）またはクラスのインスタンス（オブジェクト）
41 * @return void
42 */
43function checkClassReadOnlyStatus(object|string $class): void
44{
45    // ReflectionClass を使用して、クラスのリフレクション情報を取得
46    $reflectionClass = new ReflectionClass($class);
47
48    // getModifiers() メソッドは、クラスの修飾子（public, final, readonlyなど）を
49    // ビットマスクとして返します。
50    // ReflectionClass::IS_READONLY 定数とビットAND演算子で比較し、
51    // クラスがreadonly修飾子を持っているかを確認します。
52    $isReadOnly = ($reflectionClass->getModifiers() & ReflectionClass::IS_READONLY) === ReflectionClass::IS_READONLY;
53
54    echo "Class '{$reflectionClass->getName()}' is readonly: " . ($isReadOnly ? 'Yes' : 'No') . "\n";
55}
56
57// サンプルクラスでreadonlyステータスを判定してみる
58checkClassReadOnlyStatus(MyReadOnlyClass::class);
59checkClassReadOnlyStatus(MyNormalClass::class);
60
61?>

PHP 8.2で導入されたreadonlyクラスは、そのクラスのプロパティが一度初期化されると、後から値を変更できないようにする特別な機能を持つクラスです。このサンプルコードは、ReflectionClassクラスとReflectionClass::IS_READONLY定数を利用して、プログラム実行中に特定のクラスがreadonlyであるかを判定する方法を実演しています。

コードでは、readonly修飾子を持つMyReadOnlyClassと、持たないMyNormalClassの二種類のクラスが定義されています。checkClassReadOnlyStatus関数は、対象のクラス名（文字列）またはクラスのインスタンス（オブジェクト）を引数として受け取ります。関数内部では、ReflectionClassオブジェクトを生成することで、そのクラスの構造や特性に関する詳細な情報を取得します。

特に注目すべきは、ReflectionClass::getModifiers()メソッドです。このメソッドは、クラスに適用されているpublic、final、readonlyといった様々な修飾子を組み合わせたビットマスク（整数値）を返します。ReflectionClass::IS_READONLY定数は、クラスがreadonlyであることを示す特定の整数値です。この定数とgetModifiers()メソッドの戻り値をビットAND演算子（&）で比較することで、対象のクラスがreadonly修飾子を持っているかを正確に判別できます。IS_READONLY定数自体は引数を取らず、常にint型の値としてreadonly修飾子の有無を示すフラグとして機能します。

この判定結果に基づき、「Class 'クラス名' is readonly: Yes/No」という形式でコンソールに結果が出力されます。このようなリフレクション機能は、フレームワークやライブラリ開発において、クラスの特性を動的に分析し、特定の振る舞いを制御する際に非常に有用です。