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

Copy
1<?php
2
3// 通常のクラスを定義します。これはリードオンリーではありません。
4// このクラスのプロパティは、インスタンス化後も変更可能です。
5class MyNormalClass
6{
7    public string $name;
8
9    public function __construct(string $name)
10    {
11        $this->name = $name;
12    }
13}
14
15// リードオンリークラスを定義します。
16// 'readonly' キーワードにより、このクラスのインスタンスが不変であることを示します。
17// 一度初期化されたプロパティは、その後変更できません。
18// この機能はPHP 8.2以降で利用可能です。
19readonly class MyReadonlyClass
20{
21    public string $name;
22
23    public function __construct(string $name)
24    {
25        // リードオンリープロパティはコンストラクタ内で一度だけ初期化できます。
26        $this->name = $name;
27    }
28}
29
30/**
31 * ReflectionObject::isReadOnly メソッドの動作をデモンストレーションする関数。
32 *
33 * ReflectionObject::isReadOnly() メソッドは、
34 * 対象のオブジェクトが 'readonly' キーワードで定義されたクラスのインスタンスである場合に
35 * true を返します。そうでない場合は false を返します。
36 *
37 * 注意: このメソッドと 'readonly class' 機能はPHP 8.2以降で導入されました。
38 */
39function demonstrateIsReadOnly(): void
40{
41    echo "--- ReflectionObject::isReadOnly デモンストレーション ---\n\n";
42    echo "※このスクリプトはPHP 8.2以降のバージョンで正しく動作します。\n\n";
43
44    // 1. 通常のクラスのインスタンスを作成し、そのリフレクションオブジェクトを取得
45    $normalObject = new MyNormalClass("標準クラスのインスタンス");
46    $reflectionNormal = new ReflectionObject($normalObject);
47
48    // 通常のクラスに対する isReadOnly() の結果を表示
49    echo "オブジェクト: '" . $normalObject->name . "'\n";
50    echo "  ->isReadOnly(): " . ($reflectionNormal->isReadOnly() ? "true" : "false") . " (MyNormalClass は readonly ではありません)\n\n";
51
52    // 2. リードオンリークラスのインスタンスを作成し、そのリフレクションオブジェクトを取得
53    $readOnlyObject = new MyReadonlyClass("リードオンリークラスのインスタンス");
54    $reflectionReadOnly = new ReflectionObject($readOnlyObject);
55
56    // リードオンリークラスに対する isReadOnly() の結果を表示
57    echo "オブジェクト: '" . $readOnlyObject->name . "'\n";
58    echo "  ->isReadOnly(): " . ($reflectionReadOnly->isReadOnly() ? "true" : "false") . " (MyReadonlyClass は readonly です)\n\n";
59}
60
61// デモンストレーション関数を実行
62demonstrateIsReadOnly();
63

PHPのReflectionObject::isReadOnlyメソッドは、指定されたオブジェクトが「readonlyクラス」として定義されているかどうかを判定する際に使用します。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。

「readonlyクラス」はPHP 8.2で導入された機能で、クラスのインスタンスが一度生成されると、そのプロパティの値が変更できない不変なオブジェクトを定義するために使われます。つまり、プロパティはコンストラクタ内で一度だけ初期化可能で、それ以降は読み取り専用となります。

ReflectionObjectは、実行時にオブジェクトの構造や挙動に関する情報を取得できるクラスです。このisReadOnlyメソッドは、対象のオブジェクトがreadonlyキーワードで定義されたクラスのインスタンスであればtrueを返し、通常のクラスのインスタンスであればfalseを返します。

例えば、サンプルコードのMyNormalClassのような通常のクラスのインスタンスに対してはisReadOnly()はfalseを返しますが、MyReadonlyClassのようにreadonlyキーワードで定義されたクラスのインスタンスに対してはtrueを返します。これにより、プログラムの実行中にオブジェクトの不変性を確認することが可能になります。この機能はPHP 8.2以降のバージョンで利用できます。

Copy
1<?php
2
3/**
4 * PHP 8.2以降で導入された 'readonly' クラスの例です。
5 * readonly クラスのプロパティは、コンストラクタ内で一度初期化されると、
6 * その後変更することはできません。
7 */
8readonly class ImmutableData
9{
10    public string $name;
11    public int $value;
12
13    public function __construct(string $name, int $value)
14    {
15        $this->name = $name;
16        $this->value = $value;
17    }
18}
19
20/**
21 * 通常のクラスの例です。
22 * プロパティは自由に再代入可能です。
23 */
24class MutableData
25{
26    public string $name;
27    public int $value;
28
29    public function __construct(string $name, int $value)
30    {
31        $this->name = $name;
32        $this->value = $value;
33    }
34}
35
36// ImmutableData クラスのインスタンスを作成
37$immutableObject = new ImmutableData("Example Item", 123);
38
39// ReflectionObject を使用して、ImmutableData オブジェクトのリフレクションを作成
40$immutableReflection = new ReflectionObject($immutableObject);
41
42// isReadOnly() メソッドを呼び出し、クラスが readonly であるか確認
43echo "ImmutableData クラスは readonly ですか？ ";
44var_dump($immutableReflection->isReadOnly()); // 出力: bool(true)
45
46echo "\n";
47
48// MutableData クラスのインスタンスを作成
49$mutableObject = new MutableData("Temporary Item", 456);
50
51// ReflectionObject を使用して、MutableData オブジェクトのリフレクションを作成
52$mutableReflection = new ReflectionObject($mutableObject);
53
54// isReadOnly() メソッドを呼び出し、クラスが readonly であるか確認
55echo "MutableData クラスは readonly ですか？ ";
56var_dump($mutableReflection->isReadOnly()); // 出力: bool(false)
57
58?>

ReflectionObject::isReadOnly()メソッドは、PHP 8.2以降で導入されたreadonlyクラスが持つ不変性を、プログラムから確認するためのものです。このメソッドは、指定されたオブジェクトがreadonlyクラスのインスタンスであるかを判定します。

readonlyクラスとは、クラスのプロパティがコンストラクタで一度初期化されると、その後は一切変更できないように設計されたクラスのことです。これにより、安全で予測可能な不変オブジェクトを作成できます。

isReadOnly()メソッドは引数を何も取らずに呼び出します。戻り値はbool型で、対象のオブジェクトがreadonlyクラスのインスタンスであればtrue（真）を返し、通常のクラスのインスタンスであればfalse（偽）を返します。

サンプルコードでは、readonlyキーワードで定義されたImmutableDataクラスと、通常のMutableDataクラスの二つを定義しています。それぞれのクラスからオブジェクトを作成した後、ReflectionObjectクラスを使用して、それらのオブジェクトに関する情報を取得します。

ImmutableDataオブジェクトに対してisReadOnly()メソッドを呼び出すとbool(true)が出力され、ImmutableDataクラスがreadonlyであることが確認できます。一方、MutableDataオブジェクトに対して同じメソッドを呼び出すとbool(false)が出力され、通常のクラスであることが示されます。このメソッドを使うことで、実行時にクラスの不変性をプログラムで判別することが可能になります。