【PHP8.x】T_READONLY定数の使い方

Copy
1<?php
2
3/**
4 * PHP 8.1以降で導入されたreadonlyプロパティの基本的な使い方を示すクラス。
5 * readonlyプロパティは、オブジェクトの初期化後にその値を変更できないようにします。
6 */
7class UserProfile
8{
9    // public readonly修飾子により、$nameプロパティはコンストラクタで初期化された後、
10    // 再代入による変更ができなくなります。
11    // T_READONLY 定数は、この 'readonly' キーワードを表すPHPの内部トークンIDです。
12    public readonly string $name;
13    public readonly int $age;
14
15    /**
16     * コンストラクタでreadonlyプロパティを初期化します。
17     * readonlyプロパティはここで一度だけ値を設定できます。
18     */
19    public function __construct(string $name, int $age)
20    {
21        $this->name = $name;
22        $this->age = $age;
23    }
24
25    /**
26     * プロフィール情報を表示します。
27     */
28    public function displayProfile(): void
29    {
30        echo "名前: " . $this->name . "\n";
31        echo "年齢: " . $this->age . "\n";
32    }
33}
34
35// UserProfileクラスのインスタンスを作成し、readonlyプロパティを初期化
36$user = new UserProfile("山田 太郎", 30);
37
38// プロフィールを表示
39$user->displayProfile();
40
41echo "\n";
42
43// readonlyプロパティは初期化後に変更しようとするとTypeErrorが発生します。
44// 以下の行のコメントアウトを外すとエラーが発生する例です。
45// $user->name = "鈴木 次郎";
46
47// T_READONLY 定数は、PHPの内部で 'readonly' キーワードを識別するための整数値であり、
48// 通常のアプリケーション開発で直接使用することはほとんどありません。
49// その値は整数型です。
50?>

PHP 8.1以降で導入されたreadonlyプロパティは、クラスのプロパティを一度初期化すると、その後変更できないようにする機能です。これにより、オブジェクトの特定の状態が不変であることを保証し、プログラムの予期せぬ動作を防ぐのに役立ちます。

サンプルコードのUserProfileクラスでは、$nameと$ageプロパティがpublic readonly修飾子で宣言されています。これらのプロパティは、クラスのインスタンスが生成される際に呼び出される__construct（コンストラクタ）メソッドの中で一度だけ値を設定されます。例えば、$user = new UserProfile("山田 太郎", 30);のようにインスタンスを作成すると、$nameには"山田 太郎"、$ageには30が設定されます。一度設定された後、これらのreadonlyプロパティの値を変更しようとすると、TypeErrorが発生し、プログラムがエラーで停止します。

T_READONLYは、PHPの内部でreadonlyキーワードを識別するために使われる特別な定数です。これはPHPのパーサー（コードを解析する部分）が利用するトークンIDであり、プログラミング言語のリファレンス情報が示すように、引数を持ちません。その戻り値はint型で、これはT_READONLYが内部的に特定の整数値であることを意味します。通常のアプリケーション開発者がこのT_READONLY定数を直接使用することはほとんどなく、主にPHPの言語仕様や内部動作を理解する際に参照される情報です。readonlyプロパティは、データの整合性を保つための重要な機能として活用されます。

Copy
1<?php
2
3/**
4 * ユーザー情報を保持する不変（immutable）なクラスの例。
5 * PHP 8.1以降で導入されたreadonlyプロパティを使用しています。
6 */
7class UserProfile
8{
9    /**
10     * @var int ユーザーID。一度設定されると変更できません。
11     *          この 'readonly' キーワードは、PHPの内部では T_READONLY という定数で識別される構文要素です。
12     */
13    public readonly int $id;
14
15    /**
16     * @var string ユーザー名。一度設定されると変更できません。
17     */
18    public readonly string $name;
19
20    /**
21     * コンストラクタでプロパティを初期化します。
22     * readonlyプロパティは、コンストラクタ内でのみ初期値を設定できます。
23     *
24     * @param int $id ユーザーID
25     * @param string $name ユーザー名
26     */
27    public function __construct(int $id, string $name)
28    {
29        $this->id = $id;
30        $this->name = $name;
31    }
32
33    /**
34     * ユーザー情報を文字列として返します。
35     *
36     * @return string
37     */
38    public function getInfo(): string
39    {
40        return "ID: {$this->id}, Name: {$this->name}";
41    }
42}
43
44// UserProfileクラスのインスタンスを作成します。
45$user = new UserProfile(101, "Alice Smith");
46echo "初期データ: " . $user->getInfo() . PHP_EOL;
47
48// readonlyプロパティは、コンストラクタ以外で値を変更しようとすると、
49// 実行時にFatal errorが発生します。
50// 例として、以下の行を実行しようとするとエラーになります。
51// $user->name = "Bob Johnson"; // エラー: Cannot modify readonly property UserProfile::$name
52
53// 別のユーザーを作成して、readonlyプロパティが正しく動作することを確認します。
54$anotherUser = new UserProfile(102, "Charlie Brown");
55echo "別のユーザーデータ: " . $anotherUser->getInfo() . PHP_EOL;
56
57// T_READONLY 定数について補足:
58// この定数はPHPの内部パーサーが 'readonly' キーワードをトークン化する際に使用するもので、
59// 通常のアプリケーション開発で直接使用することは稀です。
60// 例えば、var_dump(T_READONLY); とすることで、この定数の値を確認できますが、
61// このサンプルコードの目的ではないためコメントアウトしています。

PHP 8.1以降で導入されたreadonlyプロパティは、一度設定されると後から変更できない「不変」なプロパティを定義する際に使用されます。これにより、データの一貫性を保ち、予期せぬ変更を防ぐことができます。サンプルコードのUserProfileクラスは、ユーザーIDとユーザー名をreadonlyとして宣言しており、インスタンス作成時にコンストラクタで初期化されます。readonlyプロパティは、コンストラクタ内で一度だけ初期値を設定することが許されており、それ以外の場所で値を変更しようとすると、実行時にエラー（Fatal error）が発生します。

T_READONLYは、PHPの内部でreadonlyキーワードを識別するための定数です。これは、PHPがソースコードを解析する際、readonlyという構文要素をT_READONLYという数値（int型）のトークンとして内部的に扱っていることを示します。この定数自体に引数はなく、その値は単なる整数です。システムエンジニアとしての通常のアプリケーション開発ではT_READONLYを直接使うことはほとんどなく、主にPHPの内部構造やパーサーを理解する際に参照されるものです。readonlyプロパティは、オブジェクトの信頼性と予測可能性を高める重要な機能と言えます。