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

Copy
1<?php
2
3// PHP 8.1 で導入された readonly クラスを定義します。
4// readonly クラスの全てのプロパティは自動的に readonly プロパティとなり、
5// コンストラクタでの初期化後にのみ値を設定でき、その後変更することはできません。
6readonly class MyReadonlyClass
7{
8    public string $name;
9    public int $id;
10
11    public function __construct(string $name, int $id)
12    {
13        $this->name = $name;
14        $this->id = $id;
15    }
16}
17
18// 比較のために、通常の（readonlyではない）クラスを定義します。
19class MyNormalClass
20{
21    public string $name;
22
23    public function __construct(string $name)
24    {
25        $this->name = $name;
26    }
27}
28
29/**
30 * 指定されたオブジェクトのクラスが readonly クラスであるかどうかを判定し、結果を表示します。
31 * この関数は、PHP 8.1 以降の readonly クラスのリフレクションによる判別方法を示します。
32 *
33 * @param object $object 検査対象のオブジェクト
34 */
35function checkIfClassIsReadonly(object $object): void
36{
37    // オブジェクトから ReflectionObject を作成します。
38    // ReflectionObject は特定のオブジェクトに関するリフレクション情報を提供します。
39    $reflectorObject = new ReflectionObject($object);
40
41    echo "--- クラス名: " . $reflectorObject->getName() . " ---\n";
42
43    // 1. ReflectionClass::isReadOnly() メソッドを使用する方法（推奨）
44    // ReflectionObject からそのクラスの ReflectionClass インスタンスを取得し、
45    // isReadOnly() メソッドで readonly クラスか判定します。
46    $reflectionClass = $reflectorObject->getReflector();
47
48    if ($reflectionClass->isReadOnly()) {
49        echo "判定1 (isReadOnly()): このクラスは readonly クラスです。\n";
50    } else {
51        echo "判定1 (isReadOnly()): このクラスは readonly クラスではありません。\n";
52    }
53
54    // 2. ReflectionObject::getModifiers() と ReflectionClass::IS_READONLY 定数を比較する方法
55    // getModifiers() はクラスの修飾子を表すビットマスクを返します。
56    // ReflectionClass::IS_READONLY 定数（PHP 8.1以降）は、readonly 修飾子を示すビットフラグです。
57    // ビットAND演算子 (&) を使い、クラスが readonly 修飾子を持っているかを確認します。
58    $modifiers = $reflectorObject->getModifiers();
59
60    if (($modifiers & ReflectionClass::IS_READONLY) === ReflectionClass::IS_READONLY) {
61        echo "判定2 (getModifiers() & ReflectionClass::IS_READONLY): このクラスは readonly クラスです。\n";
62    } else {
63        echo "判定2 (getModifiers() & ReflectionClass::IS_READONLY): このクラスは readonly クラスではありません。\n";
64    }
65    echo "\n";
66}
67
68// readonly クラスのオブジェクトを作成し、関数で判定します。
69$readonlyInstance = new MyReadonlyClass("リードオンリーデータ", 456);
70checkIfClassIsReadonly($readonlyInstance);
71
72// 通常のクラスのオブジェクトを作成し、関数で判定します。
73$normalInstance = new MyNormalClass("ノーマルデータ");
74checkIfClassIsReadonly($normalInstance);

PHP 8.1で導入されたreadonly classは、その全てのプロパティが初期化後に変更できない「読み取り専用」であることを保証するクラスです。これにより、オブジェクトの不変性を安全に扱えます。

このサンプルコードは、プログラムの実行中に、あるクラスがreadonly classであるかどうかを判定する方法をシステムエンジニアの初心者の方にも分かりやすく説明しています。ReflectionObjectやReflectionClassは、実行時にクラスやオブジェクトの構造を分析するためのPHPのリフレクション機能です。

判定方法として、主に二つの方法が示されています。一つは、ReflectionClassインスタンスが提供するisReadOnly()メソッドを使う方法で、これが最も推奨されます。これは、対象のクラスがreadonlyであればtrueを返します。もう一つの方法は、ReflectionObject::getModifiers()が返すクラスの修飾子を表すビットマスクと、ReflectionClass::IS_READONLY定数をビット演算子&で比較する方法です。ReflectionClass::IS_READONLYは、readonly修飾子を表す特定のビットフラグ値を持つ定数で、クラスがreadonlyであるか否かを数値的に判別するために使用されます。この定数自体は引数を取らず、その値がreadonlyクラスの修飾子を示す役割を果たします。