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

Copy
1<?php
2
3/**
4 * このスクリプトはPHP 8.1以降で動作します。
5 * 'readonly' プロパティ修飾子と ReflectionProperty::isReadOnly() メソッドはPHP 8.1で導入されました。
6 *
7 * システムエンジニアを目指す初心者の方へ：
8 * Reflection APIは、実行時にクラス、メソッド、プロパティなどの情報を
9 * 取得・操作するための機能です。isReadOnly() メソッドは、特にPHP 8.1で導入された
10 * 'readonly' プロパティが設定されているかを確認するのに役立ちます。
11 * 'readonly' プロパティは一度初期化されると、その後は値を変更できないプロパティです。
12 */
13
14class Product
15{
16    // 通常の読み書き可能なプロパティ
17    public string $name;
18
19    // 'readonly' プロパティ。一度初期化されると変更不可
20    public readonly int $id;
21
22    /**
23     * コンストラクタ
24     * readonly プロパティはコンストラクタ内でのみ初期化できます。
25     */
26    public function __construct(string $name, int $id)
27    {
28        $this->name = $name;
29        $this->id = $id; // readonly プロパティの初期化
30    }
31}
32
33/**
34 * ReflectionProperty::isReadOnly() メソッドの動作をデモンストレーションします。
35 * プロパティが 'readonly' 修飾子を持っているかをチェックします。
36 */
37function demonstrateReadOnlyPropertyReflection(): void
38{
39    echo "--- ReflectionProperty::isReadOnly() のデモンストレーション ---" . PHP_EOL;
40
41    // Product クラスの ReflectionClass オブジェクトを作成
42    $reflectionClass = new ReflectionClass(Product::class);
43
44    // 'name' プロパティのリフレクションを取得し、readonlyか確認
45    $propertyName = 'name';
46    $reflectionPropertyName = $reflectionClass->getProperty($propertyName);
47    echo "プロパティ '{$propertyName}' は readonly ですか？: ";
48    echo $reflectionPropertyName->isReadOnly() ? "はい" : "いいえ"; // 期待値: いいえ
49    echo PHP_EOL;
50
51    // 'id' プロパティのリフレクションを取得し、readonlyか確認
52    $propertyId = 'id';
53    $reflectionPropertyId = $reflectionClass->getProperty($propertyId);
54    echo "プロパティ '{$propertyId}' は readonly ですか？: ";
55    echo $reflectionPropertyId->isReadOnly() ? "はい" : "いいえ"; // 期待値: はい
56    echo PHP_EOL;
57
58    echo "--- デモンストレーション終了 ---" . PHP_EOL;
59}
60
61// デモンストレーション関数を実行
62demonstrateReadOnlyPropertyReflection();
63

PHP 8.1で導入されたReflectionProperty::isReadOnly()メソッドは、クラスのプロパティが「読み取り専用（readonly）」として宣言されているかどうかをプログラムの実行中に確認するために使用されます。Reflection APIの一部であるReflectionPropertyクラスは、クラスのプロパティに関する様々な情報を取得する機能を提供し、isReadOnly()はその特定のプロパティにreadonly修飾子が付いているかを調べます。

readonlyプロパティは、PHP 8.1で導入された機能で、一度コンストラクタ内で初期化されると、その後は値を変更できなくなるプロパティです。これにより、オブジェクトの重要なデータが誤って変更されるのを防ぎ、プログラムの安定性を高めることができます。

isReadOnly()メソッドは引数を一切取りません。戻り値はブール値（bool）で、対象のプロパティがreadonly修飾子を持つ場合はtrueを、そうでない場合はfalseを返します。

サンプルコードでは、Productクラスのnameプロパティは読み書き可能な通常のプロパティであるため、isReadOnly()はfalseを出力します。一方、idプロパティはreadonlyとして定義されているため、isReadOnly()はtrueを出力し、プロパティの特性を正確に判断できることを示しています。これにより、実行時のコードの挙動を動的に制御する高度な処理が可能となります。

Copy
1<?php
2
3// PHP 8.1以降で導入されたreadonlyプロパティを持つクラスを定義します。
4class UserProfile
5{
6    // readonly プロパティは、初期化後に変更できません。
7    public readonly string $username;
8    // 通常のプロパティは、いつでも変更可能です。
9    public string $email;
10    // protectedなreadonlyプロパティの例
11    protected readonly int $userId;
12
13    public function __construct(string $username, string $email, int $userId)
14    {
15        $this->username = $username;
16        $this->email = $email;
17        $this->userId = $userId;
18    }
19}
20
21// UserProfile クラスのリフレクションオブジェクトを作成します。
22$reflectionClass = new ReflectionClass(UserProfile::class);
23
24echo "--- UserProfile クラスのプロパティの readonly 状態をチェック ---" . PHP_EOL;
25
26// クラスの全てのプロパティを取得し、それぞれの readonly 状態を確認します。
27foreach ($reflectionClass->getProperties() as $property) {
28    $propertyName = $property->getName();
29    $isReadOnly = $property->isReadOnly(); // isReadOnly() メソッドで readonly かどうかを判定します。
30
31    echo "プロパティ '{$propertyName}': ";
32    if ($isReadOnly) {
33        echo "このプロパティは 'readonly' です。" . PHP_EOL;
34    } else {
35        echo "このプロパティは 'readonly' ではありません。" . PHP_EOL;
36    }
37}
38
39?>

このコードは、PHP 8.1以降で導入されたreadonlyプロパティを、リフレクション機能を使って判別する方法を示しています。ReflectionProperty::isReadOnly()メソッドは、クラスのプロパティがreadonly修飾子を持つかを判定する際に利用されます。

サンプルコードでは、初期化後に値の変更ができないreadonlyプロパティと、通常のプロパティを持つUserProfileクラスを定義しています。readonlyプロパティは、データの不変性を保証する目的で使用されます。

まず、ReflectionClassを使ってUserProfileクラスの情報を取り出し、そのgetProperties()メソッドでクラスの全てのプロパティ情報（ReflectionPropertyオブジェクト）を取得します。

foreachループの中で、取得した各プロパティのReflectionPropertyオブジェクトに対してisReadOnly()メソッドを呼び出しています。このメソッドは引数を受け取らず、対象のプロパティがreadonlyであればtrueを、そうでなければfalseという真偽値を返します。コードは、この戻り値に基づいてプロパティがreadonlyであるかを判定し、その結果を表示しています。

このように、isReadOnly()メソッドを使うことで、プログラムの実行時に、クラスのプロパティが変更不可の特性を持つかどうかを動的に確認することが可能です。