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

Copy
1<?php
2
3// PHP 8.2以降で導入された 'readonly' クラスの機能を示すサンプルコードです。
4// 'readonly' クラスは、そのプロパティが一度初期化されると、その後変更できないことを保証します。
5
6// 1. 通常のクラス定義（readonly ではないクラス）
7class StandardClass
8{
9    public string $name = 'Standard';
10}
11
12// 2. readonly クラス定義
13// このクラスのプロパティは、コンストラクタで初期化された後は変更できません。
14readonly class ImmutableClass
15{
16    public string $id;
17    public string $value;
18
19    public function __construct(string $id, string $value)
20    {
21        $this->id = $id;
22        $this->value = $value;
23    }
24}
25
26/**
27 * 指定されたクラスが 'readonly' として宣言されているかを確認し、結果を出力します。
28 * ReflectionClass::isReadOnly() メソッドは PHP 8.2 以降で利用可能です。
29 *
30 * @param string $className 確認するクラスの完全修飾名
31 * @return void
32 */
33function demonstrateReadonlyClassStatus(string $className): void
34{
35    echo "--- クラス名: {$className} ---\n";
36    try {
37        // ReflectionClass は、実行時にクラスに関する情報を取得するためのPHPの機能です。
38        $reflector = new ReflectionClass($className);
39
40        // isReadOnly() メソッドは、この ReflectionClass が表すクラスが
41        // 'readonly' 修飾子で宣言されている場合に true を返します。
42        $isReadonly = $reflector->isReadOnly();
43
44        echo "このクラスは 'readonly' として宣言されていますか？ " . ($isReadonly ? "はい" : "いいえ") . "\n";
45
46        // 初心者向け補足説明
47        if ($isReadonly) {
48            echo "補足: 'readonly' クラスを使用すると、クラスのインスタンスが作成された後、\n";
49            echo "      そのプロパティの値が意図せず変更されるのを防ぐことができます。\n";
50            echo "      これにより、オブジェクトの不変性（イミュータブル性）を保証し、\n";
51            echo "      予期しないバグのリスクを減らすのに役立ちます。\n";
52        } else {
53            echo "補足: このクラスは 'readonly' ではないため、\n";
54            echo "      インスタンス化された後もプロパティの値を変更することができます。\n";
55        }
56    } catch (ReflectionException $e) {
57        echo "エラー: 指定されたクラス '{$className}' が見つかりません。\n";
58    }
59    echo "\n";
60}
61
62// それぞれのクラスの readonly ステータスを確認し、出力します。
63demonstrateReadonlyClassStatus(StandardClass::class);
64demonstrateReadonlyClassStatus(ImmutableClass::class);
65
66?>

ReflectionClass::isReadOnly()メソッドは、PHP 8.2以降で導入された「readonlyクラス」の特性をプログラムから確認するための機能です。このメソッドは、ReflectionClassというクラスに属しており、指定されたクラスがreadonlyとして宣言されているかどうかを判断します。

readonlyクラスとは、一度インスタンスが作成され、プロパティが初期化されると、その後プロパティの値を変更できなくするクラスです。これにより、オブジェクトの不変性（イミュータブル性）が保証され、予期せぬデータの変更によるバグを防ぐのに役立ちます。

isReadOnly()メソッドは引数を取りません。呼び出すと、対象のクラスがreadonlyであればtrueを、そうでなければfalseを真偽値（bool）で返します。

サンプルコードでは、通常のクラスStandardClassとreadonlyクラスImmutableClassを定義しています。demonstrateReadonlyClassStatus関数内で、ReflectionClassを使って各クラスの情報を取得し、isReadOnly()メソッドを呼び出しています。実行結果として、StandardClassでは「いいえ」が、ImmutableClassでは「はい」が表示され、readonlyクラスの判定結果が明確に示されます。これにより、実行時にクラスがreadonlyかどうかを動的に検査し、適切な処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * 通常のクラスを定義します。
5 */
6class MyNormalClass
7{
8    public string $name = 'Normal';
9}
10
11/**
12 * PHP 8.2 で導入された readonly クラスを定義します。
13 * readonly クラスは、そのすべてのプロパティが readonly プロパティとして宣言されます。
14 * オブジェクトの初期化後にプロパティの変更が禁止されます。
15 */
16readonly class MyReadOnlyClass
17{
18    public string $name;
19
20    public function __construct(string $name)
21    {
22        $this->name = $name;
23    }
24}
25
26// ReflectionClass を使って、各クラスの情報を取得します。
27
28// 通常のクラスの ReflectionClass を作成
29$reflectionNormalClass = new ReflectionClass(MyNormalClass::class);
30// readonly クラスの ReflectionClass を作成
31$reflectionReadOnlyClass = new ReflectionClass(MyReadOnlyClass::class);
32
33// isReadOnly() メソッドを使用して、クラスが readonly であるかを確認します。
34
35echo "クラス '" . MyNormalClass::class . "' は readonly クラスですか？: ";
36echo $reflectionNormalClass->isReadOnly() ? 'はい' : 'いいえ';
37echo "\n";
38
39echo "クラス '" . MyReadOnlyClass::class . "' は readonly クラスですか？: ";
40echo $reflectionReadOnlyClass->isReadOnly() ? 'はい' : 'いいえ';
41echo "\n";
42
43?>

PHPのReflectionClass::isReadOnly()メソッドは、指定されたクラスが「readonlyクラス」として定義されているかどうかを判定するために使用します。このメソッドは引数を一切取らず、判定結果を真偽値（trueまたはfalse）として返します。trueが返された場合、そのクラスはreadonlyクラスであり、falseの場合は通常のクラスであることを意味します。

PHP 8.2で導入されたreadonlyクラスは、そのクラス内の全てのプロパティが自動的に読み取り専用となる特別なクラスです。これは、オブジェクトが一度初期化された後、そのプロパティの値を変更できないようにすることで、データの不変性を保証する目的で利用されます。

サンプルコードでは、まず通常のクラスMyNormalClassと、readonlyキーワードで定義されたMyReadOnlyClassの二種類を定義しています。次に、ReflectionClassという機能を使って、これらのクラスの構造に関する情報を取得するためのオブジェクトを作成します。それぞれのReflectionClassオブジェクトに対してisReadOnly()メソッドを呼び出すことで、そのクラスがreadonlyクラスであるかをプログラム実行時に動的に確認できます。出力結果は、MyNormalClassに対しては「いいえ」、MyReadOnlyClassに対しては「はい」と表示され、それぞれのクラスの特性が正確に判定されていることがわかります。このメソッドは、クラスの性質を動的に確認したい場合に役立ちます。