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

Copy
1<?php
2
3/**
4 * T_PRIVATE_SET 定数の利用例を示す関数。
5 *
6 * T_PRIVATE_SET は PHP 8.1 以降で導入されたトークン定数で、
7 * クラスプロパティの 'private set' 構文の解析時に使用されます。
8 * この関数では、'private set' 構文を含むPHPコードを token_get_all() で解析し、
9 * T_PRIVATE_SET トークンがどのように現れるかを示します。
10 *
11 * システムエンジニアを目指す初心者の方へ:
12 * この定数は、通常のアプリケーション開発で直接使用することはほとんどありません。
13 * 主にPHPのパーサー（コードを解析する内部機能）が利用するもので、
14 * PHPがコードをどのように理解しているかの一端を垣間見ることができます。
15 */
16function demonstrateTPrivateSetUsage(): void
17{
18    // 'private set' 構文を含むPHPコードの例
19    // 注意: この構文は PHP 8.1 以降で有効です。
20    $code = <<<'PHP_CODE'
21<?php
22class Product
23{
24    public string $name;
25    // この 'private set' は、同じクラス内でのみ $price の値を変更できることを示します。
26    // PHPの内部では、この 'private set' 部分が T_PRIVATE_SET トークンとして識別されます。
27    public float $price private set;
28
29    public function __construct(string $name, float $initialPrice)
30    {
31        $this->name = $name;
32        $this->price = $initialPrice;
33    }
34
35    public function setPrice(float $newPrice): void
36    {
37        // クラスのメソッド内であれば $price の値を変更可能です。
38        $this->price = $newPrice;
39    }
40}
41PHP_CODE;
42
43    echo "--- 解析対象のPHPコード ---" . PHP_EOL;
44    echo $code . PHP_EOL;
45    echo "--------------------------" . PHP_EOL . PHP_EOL;
46
47    // token_get_all() を使用して、コードをトークン配列に分解します。
48    // 各トークンは、コードの構成要素（キーワード、変数名、演算子など）を表します。
49    $tokens = token_get_all($code);
50
51    echo "--- トークン解析結果から T_PRIVATE_SET を探します ---" . PHP_EOL;
52
53    $foundPrivateSet = false;
54    foreach ($tokens as $token) {
55        // トークンが定数やキーワードを表す場合、配列形式で返されます。
56        // [0]はトークンのID、[1]は元のコード部分、[2]は行番号です。
57        if (is_array($token)) {
58            // トークンIDが T_PRIVATE_SET と一致するか確認
59            if ($token[0] === T_PRIVATE_SET) {
60                echo "T_PRIVATE_SET トークンを検出しました！" . PHP_EOL;
61                echo "  定数名: " . token_name($token[0]) . " (内部値: " . $token[0] . ")" . PHP_EOL;
62                echo "  元のコード部分: '" . $token[1] . "'" . PHP_EOL;
63                echo "  行番号: " . $token[2] . PHP_EOL;
64                $foundPrivateSet = true;
65                // 一つ見つかれば十分なのでループを抜ける
66                break;
67            }
68        }
69    }
70
71    if (!$foundPrivateSet) {
72        echo "T_PRIVATE_SET トークンは検出されませんでした。" . PHP_EOL;
73        echo "このコードは PHP 8.1 以降で実行されないと、'private set' 構文は認識されません。" . PHP_EOL;
74    }
75
76    echo "---------------------------------------------------" . PHP_EOL;
77}
78
79// 関数を実行し、結果を出力します。
80demonstrateTPrivateSetUsage();

T_PRIVATE_SETは、PHP 8.1で導入された定数で、クラスプロパティに「private set」という新しい構文が使われた際にPHPの内部でコードを解析（トークン化）するために利用されます。この定数自体は引数を取らず、トークンを識別するための整数型の値を返します。

サンプルコードでは、「public float $price private set;」のような「private set」構文を含むPHPコードを用意しています。そして、token_get_all()関数を使用してこのコードをPHPが内部でどのように認識しているかを示しています。コードを実行すると、token_get_all()によってPHPコードが細かな部品（トークン）に分解され、その中から「private set」を意味するT_PRIVATE_SETトークンが検出される様子を確認できます。

システムエンジニアを目指す初心者の方にとって、この定数を通常のアプリケーション開発で直接使用する機会はほとんどありません。しかし、PHPがコードを読み解き、新しい構文をどのように理解しているのか、その内部的な仕組みの一端を学ぶ上で役立つでしょう。この構文はPHP 8.1以降で有効ですので、実行環境にご注意ください。

Copy
1<?php
2
3/**
4 * private set プロパティの動作を示すサンプルクラス。
5 *
6 * この機能は PHP 8.1 以降で導入されました。
7 * T_PRIVATE_SET 定数は、この `private set` キーワードのトークンを識別するために
8 * PHP内部で使われる定数です。
9 *
10 * private set プロパティは、プロパティの読み取りは可能ですが、
11 * クラス外からの設定（書き込み）はできません。
12 * 設定はプロパティを宣言したクラスの内部でのみ許可されます。
13 */
14class Product
15{
16    /**
17     * 商品名。これは通常の public プロパティです。
18     * クラスの内外から読み書き可能です。
19     * @var string
20     */
21    public string $name;
22
23    /**
24     * 商品コード。これが private set プロパティです。
25     * クラス外から読み取りは可能ですが、設定はクラス内でのみ可能です。
26     *
27     * この構文 (public type $property { private set; }) は PHP 8.1 以降で有効です。
28     *
29     * @var string
30     */
31    public string $code { private set; }
32
33    /**
34     * コンストラクタ。
35     *
36     * @param string $name 初期の商品名
37     * @param string $code 初期の商品コード
38     */
39    public function __construct(string $name, string $code)
40    {
41        $this->name = $name;
42        // private set プロパティも、コンストラクタ内での初期化は許可されます。
43        $this->code = $code;
44    }
45
46    /**
47     * 商品名を更新します。
48     * これは通常の public プロパティなので、クラス内外から更新可能です。
49     *
50     * @param string $newName 新しい商品名
51     */
52    public function updateName(string $newName): void
53    {
54        $this->name = $newName;
55        echo "商品名が「{$this->name}」に更新されました。\n";
56    }
57
58    /**
59     * 商品コードを更新します。
60     * private set プロパティなので、クラス内からの書き込みは許可されます。
61     *
62     * @param string $newCode 新しい商品コード
63     */
64    public function updateCode(string $newCode): void
65    {
66        $this->code = $newCode; // クラス内部からの設定は許可されます
67        echo "商品コードが「{$this->code}」に更新されました。\n";
68    }
69}
70
71// --- private set プロパティのデモンストレーション ---
72
73// Productクラスのインスタンスを作成
74$product = new Product("高機能スマホ", "SP001");
75echo "初期状態: 商品名 = {$product->name}, 商品コード = {$product->code}\n\n";
76
77// クラス外からのプロパティ読み取り (許可される)
78echo "クラス外から商品名を読み取り: " . $product->name . "\n";
79echo "クラス外から商品コードを読み取り: " . $product->code . "\n\n";
80
81// クラス内メソッドからのプロパティ更新 (許可される)
82$product->updateName("最新モデルスマホ");
83$product->updateCode("SP002");
84echo "更新後: 商品名 = {$product->name}, 商品コード = {$product->code}\n\n";
85
86// クラス外からの private set プロパティの書き込みを試みる (エラーになることを示す)
87echo "クラス外から商品コードの変更を試みます...\n";
88try {
89    $product->code = "NEW_CODE"; // PHP 8.1 以降でFatal error: Uncaught Error: Cannot write to a private-set property Product::$code
90} catch (Error $e) {
91    echo "エラーが発生しました: " . $e->getMessage() . "\n";
92    echo "これは、private set プロパティがクラス外からの書き込みを拒否するためです。\n";
93    echo "このコードを実行するには PHP 8.1 以上が必要です。\n";
94}
95echo "\n--- デモンストレーション終了 ---\n";
96

T_PRIVATE_SETはPHPの内部でprivate setキーワードを識別するために使われる定数で、整数値を返します。このprivate setプロパティはPHP 8.1以降で導入された機能です。

private setプロパティは、宣言されたクラスの外部からプロパティの値を読み取ることはできますが、値を書き換えることはできません。値の設定（書き込み）は、そのプロパティを宣言したクラスの内部からのみ許可されます。これにより、データの整合性を保ちながら、外部からの不要な変更を防ぐことができます。

サンプルコードのProductクラスでは、$codeプロパティがpublic string $code { private set; }と定義されています。クラスのインスタンス化時や、クラス内部のupdateCodeメソッドからは$codeプロパティに値を設定できます。これは、クラス内部からの書き込みが許可されているためです。一方、クラスの外部から$product->code = "NEW_CODE";のように直接$codeプロパティの値を変更しようとすると、エラーが発生します。これは、private setが外部からの書き込みを拒否するからです。しかし、$product->codeのように値を読み取ることは、クラス内外問わずいつでも可能です。