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

IS_READONLY定数の使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年01月23日

基本的な使い方

IS_READONLY定数は、ReflectionAPIを通じてクラスの修飾子を検査する際に、そのクラスが「読み取り専用（readonly）」であるかどうかの状態を表す定数です。この定数は、PHPのReflectionClassクラスに属しており、実行時にクラスの情報を動的に取得・分析するために使用されます。

PHP 8.1で導入されたreadonlyプロパティは、一度初期化されるとその後は変更できないプロパティを宣言するためのものです。さらにPHP 8.2ではreadonly classが導入され、クラス全体を読み取り専用として宣言できるようになりました。このIS_READONLY定数は、リフレクションの対象となるクラスが、これらの新しい「読み取り専用」の特性を持っているかどうかをプログラム的に判別するために非常に重要な役割を果たします。

具体的には、ReflectionClass::getModifiers()メソッドが返す整数値とこのIS_READONLY定数をビット演算子（&）で組み合わせることで、対象のクラスがreadonlyとして宣言されているかどうかを確認できます。システムエンジニアを目指す方にとって、実行時にクラスの構造や振る舞いを分析し、それに応じた処理を動的に行う必要が生じた際に、この定数は非常に有用なツールとなります。これにより、例えば特定の特性を持つクラスに対してのみ追加の処理を適用するなど、柔軟で堅牢なプログラミングが可能になります。

構文(syntax)


1<?php
2
3readonly class MyExampleClass {}
4
5$reflector = new ReflectionClass(MyExampleClass::class);
6$modifiers = $reflector->getModifiers();
7$isReadonlyClass = ($modifiers & ReflectionClass::IS_READONLY);
8
9?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

ReflectionClass::IS_READONLY は、プロパティが読み取り専用であることを示す整数値を返します。

サンプルコード

PHP ReflectionClass::IS_READONLYでクラスを判定する


1<?php
2
3// readonlyクラスの定義 (PHP 8.2以降で利用可能)
4// このクラスのプロパティは、コンストラクタで初期化された後は変更できません。
5readonly class MyReadonlyClass
6{
7    public function __construct(
8        public string $name
9    ) {}
10}
11
12// 通常のクラスの定義
13// このクラスのプロパティは、後から変更可能です。
14class MyNormalClass
15{
16    public string $name;
17
18    public function __construct(string $name)
19    {
20        $this->name = $name;
21    }
22}
23
24/**
25 * PHPのReflection APIを使って、指定されたクラスが「読み取り専用 (readonly)」であるかを判定する関数です。
26 * システムエンジニアを目指す初心者向けに、`ReflectionClass::IS_READONLY` 定数の使い方を示します。
27 */
28function checkClassReadonlyStatus(): void
29{
30    echo "--- 読み取り専用クラスの検出 ---" . PHP_EOL;
31
32    // MyReadonlyClass のリフレクションオブジェクトを作成します。
33    // Reflection APIは、実行中のプログラムの構造を動的に調べたり、操作したりするための機能を提供します。
34    $readonlyClassReflection = new ReflectionClass(MyReadonlyClass::class);
35
36    // MyReadonlyClass が読み取り専用であるかを確認します。
37    // `ReflectionClass::getModifiers()` メソッドは、クラスの修飾子（例: public, final, abstract, readonly）を
38    // ビットマスクとして整数で返します。
39    // `ReflectionClass::IS_READONLY` 定数とビット論理AND演算子 (`&`) を使うことで、
40    // 返された修飾子の中に `IS_READONLY` フラグが含まれているかを効率的に判断できます。
41    $isReadonly = ($readonlyClassReflection->getModifiers() & ReflectionClass::IS_READONLY) === ReflectionClass::IS_READONLY;
42
43    echo "クラス '" . MyReadonlyClass::class . "' は読み取り専用ですか: " . ($isReadonly ? "はい" : "いいえ") . PHP_EOL;
44
45    echo PHP_EOL;
46
47    // MyNormalClass のリフレクションオブジェクトを作成します。
48    $normalClassReflection = new ReflectionClass(MyNormalClass::class);
49
50    // MyNormalClass が読み取り専用であるかを確認します。
51    $isNormalReadonly = ($normalClassReflection->getModifiers() & ReflectionClass::IS_READONLY) === ReflectionClass::IS_READONLY;
52
53    echo "クラス '" . MyNormalClass::class . "' は読み取り専用ですか: " . ($isNormalReadonly ? "はい" : "いいえ") . PHP_EOL;
54}
55
56// サンプル関数を実行して、定義したクラスの「読み取り専用」状態を確認します。
57checkClassReadonlyStatus();

PHPのReflectionClass::IS_READONLY定数は、プログラム実行時にクラスが「読み取り専用 (readonly)」であるかを判定するために使用される整数値です。この定数はReflectionClassクラスに所属し、引数はなく、int型の値を持ちます。PHP 8.2以降で導入されたreadonlyクラスは、そのプロパティがコンストラクタで初期化された後、値を変更できなくなる特性を持ちます。

サンプルコードでは、readonly修飾子を持つMyReadonlyClassと、通常のMyNormalClassを定義しています。checkClassReadonlyStatus関数内では、まずReflectionClassを使って各クラスのリフレクションオブジェクトを作成し、プログラムからクラスの情報を動的に取得します。

次に、ReflectionClass::getModifiers()メソッドを呼び出し、クラスの修飾子（public、final、readonlyなど）がビットマスクとして表現された整数値を取得します。この整数値とReflectionClass::IS_READONLY定数をビット論理AND演算子（&）で組み合わせることで、クラスがreadonly修飾子を持っているかを確認します。IS_READONLY定数自体は、readonly修飾子に対応する特定のビットフラグを表す整数値です。この判定により、MyReadonlyClassは「はい」、MyNormalClassは「いいえ」と正しく出力され、IS_READONLY定数がreadonlyクラスの検出に有効であることが示されます。

このサンプルコードでは、readonly classの構文がPHP 8.2以降で利用可能である点に注意が必要です。それより古いバージョンでは構文エラーとなります。ReflectionClass::IS_READONLY定数はPHP 8.1で導入され、クラスが「読み取り専用」であるかを確認するために用います。ReflectionClass::getModifiers()メソッドはクラスの修飾子をビットマスクとして返すため、IS_READONLY定数とのビット論理AND演算子 & を使って、該当するフラグが含まれているかを正確に判定する必要があります。このビット演算パターンを理解せず単純な比較を行うと、期待する結果が得られない場合があります。この機能は、実行時にクラスの構造を動的に調べたい場合に利用されます。