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

Copy
1<?php
2
3/**
4 * T_ATTRIBUTE が示す PHP 8 の「属性」構文を定義します。
5 * この属性はプロパティに付与され、デフォルト値を指定するために使用されます。
6 * Attribute::TARGET_PROPERTY はこの属性がプロパティにのみ適用可能であることを示します。
7 */
8#[Attribute(\Attribute::TARGET_PROPERTY)]
9class DefaultValue
10{
11    /**
12     * 属性が持つデフォルト値。
13     *
14     * @param int $value デフォルト値。
15     */
16    public function __construct(
17        public int $value
18    ) {}
19}
20
21/**
22 * 指定されたオブジェクトのプロパティに DefaultValue 属性が設定されている場合、
23 * その属性に基づいてプロパティにデフォルト値を設定（セット）します。
24 * T_ATTRIBUTE が指す「属性」の構文を解釈し、キーワード 'setAttribute' が持つ
25 * 「設定する」というニュアンスを、リフレクションを用いて動的に値を設定する処理で表現しています。
26 *
27 * @param object $object デフォルト値を設定する対象のオブジェクト。
28 * @return void
29 */
30function applyDefaultValuesBasedOnAttribute(object $object): void
31{
32    $reflectionClass = new \ReflectionClass($object);
33
34    foreach ($reflectionClass->getProperties() as $property) {
35        // プロパティに DefaultValue 属性があるか確認します。
36        $attributes = $property->getAttributes(DefaultValue::class);
37
38        foreach ($attributes as $attribute) {
39            // 属性のインスタンスを取得します。
40            $defaultValueAttribute = $attribute->newInstance();
41
42            // プロパティがまだ初期化されていない場合のみデフォルト値を設定します。
43            // PHP 7.4 以降の isInitialized() メソッドで安全に確認できます。
44            if (!$property->isInitialized($object)) {
45                // ここで値を「設定 (set)」しています。
46                $property->setValue($object, $defaultValueAttribute->value);
47            }
48        }
49    }
50}
51
52/**
53 * デフォルト値属性を持つサンプルクラス。
54 */
55class User
56{
57    #[DefaultValue(1)]
58    public int $id;
59
60    #[DefaultValue(2023)]
61    public int $creationYear;
62
63    public string $name;
64
65    public function __construct(string $name)
66    {
67        $this->name = $name;
68    }
69}
70
71// --- 使用例 (単体で動作可能なコードとするため含みますが、出力は行いません) ---
72$user = new User("Alice");
73// 初期状態: $user->id と $user->creationYear は未初期化
74applyDefaultValuesBasedOnAttribute($user);
75// 実行後: $user->id は 1 に、$user->creationYear は 2023 に設定されます。
76
77$user2 = new User("Bob");
78$user2->id = 99; // 明示的に設定された値
79applyDefaultValuesBasedOnAttribute($user2);
80// 実行後: $user2->id は 99 のまま、$user2->creationYear は 2023 に設定されます。

PHPのT_ATTRIBUTEは、PHP 8で導入された「属性（Attribute）」という新しい構文を識別するために使われる定数です。属性とは、クラスやプロパティといったプログラムの要素に、追加情報を付与するための特別な記述方法を指します。

このサンプルコードでは、DefaultValueというカスタム属性を定義しています。これは#[Attribute(\Attribute::TARGET_PROPERTY)]と指定されており、特定のプロパティにのみ適用可能です。DefaultValue属性は、そのプロパティのデフォルト値を持つ役割を担います。

applyDefaultValuesBasedOnAttribute関数は、引数としてデフォルト値を設定したいオブジェクト（$object）を受け取ります。この関数は「リフレクション」という機能を用いて、実行時にオブジェクトの構造を調べ、各プロパティにDefaultValue属性が設定されているかを確認します。もし属性が存在し、そのプロパティがまだ初期化されていない場合、属性で定義されたデフォルト値をプロパティに設定します。ここで、キーワードphp setattributeが示す「設定する」という動作が、setValueメソッドによって具体的に行われています。

この関数はプロパティへの値の設定を終えると、void（何も返さない）を返します。Userクラスは、idやcreationYearプロパティにDefaultValue属性を付与した具体的な利用例です。このように属性とリフレクションを組み合わせることで、オブジェクトのプロパティに柔軟かつ自動的にデフォルト値を設定する仕組みを構築できます。

Copy
1<?php
2
3/**
4 * PHP 8の属性 (Attributes) の定義例です。
5 * T_ATTRIBUTE トークンは、この #[...] 構文を識別するために使用されます。
6 */
7#[Attribute(Attribute::TARGET_CLASS)]
8class MyExampleAttribute
9{
10    public function __construct(public string $message) {}
11}
12
13/**
14 * PHPコード内のT_ATTRIBUTEトークンを検索し、その使用方法を示す関数。
15 *
16 * T_ATTRIBUTE は、PHP 8で導入された属性構文 (例: #[MyExampleAttribute("...")]) を
17 * PHPの内部的なコード解析 (トークナイザー) の過程で識別するための定数です。
18 *
19 * この定数は、HTML要素の属性を設定する `DOMElement::setAttribute()` や、
20 * PDO接続オプションを設定する `PDO::setAttribute()` のようなメソッドとは
21 * 異なる目的で使用されます。これらのメソッドはオブジェクトのプロパティや挙動を「設定」しますが、
22 * T_ATTRIBUTE はコードの「構文を解析」する際に使われるものです。
23 *
24 * @return void
25 */
26function demonstrateTAttributeUsage(): void
27{
28    echo "PHPソースコード内のT_ATTRIBUTEトークンを検索します。\n\n";
29
30    // 現在のスクリプト自身のソースコードを取得します。
31    $sourceCode = file_get_contents(__FILE__);
32
33    if ($sourceCode === false) {
34        echo "エラー: ソースコードの読み込みに失敗しました。\n";
35        return;
36    }
37
38    // ソースコードをPHPトークンに分解します。
39    // PHP 8以降では、属性構文もトークンとして扱われます。
40    $tokens = token_get_all($sourceCode);
41
42    $foundTAttribute = false;
43    foreach ($tokens as $token) {
44        // トークンが配列形式の場合 (ID, 値, 行番号を含む)
45        if (is_array($token)) {
46            // トークンIDが T_ATTRIBUTE の場合
47            if ($token[0] === T_ATTRIBUTE) {
48                echo "  T_ATTRIBUTE トークンが見つかりました。\n";
49                // T_ATTRIBUTE の値は、属性宣言の開始を示す '[#' のうち '#' に続く '[' 文字です。
50                echo "    値: '" . $token[1] . "'\n";
51                echo "    行: " . $token[2] . "\n\n";
52                $foundTAttribute = true;
53            }
54        }
55    }
56
57    if (!$foundTAttribute) {
58        echo "現在のコード内にT_ATTRIBUTEトークンは見つかりませんでした。\n";
59    }
60}
61
62// T_ATTRIBUTEが識別する構文の使用例。
63// このクラス定義自体がトークナイザーの対象となり、T_ATTRIBUTEトークンを生成します。
64#[MyExampleAttribute("このクラスにはカスタム属性が設定されています。")]
65class MyClassWithAttribute
66{
67    // このクラスの内容はT_ATTRIBUTEのデモンストレーションには直接関係ありません。
68    // 属性構文が存在することを示すためのものです。
69}
70
71// 上記で定義した関数を実行し、T_ATTRIBUTEの検出をデモンストレーションします。
72demonstrateTAttributeUsage();
73
74?>

PHPのT_ATTRIBUTEは、PHP 8で導入された「属性 (Attributes)」と呼ばれる新しい構文を識別するための定数です。この定数は、コード内で#[...]という形式で記述される属性宣言を、PHPが内部的にソースコードを解析する（トークン化する）際に「これは属性の始まりである」と認識するための目印として機能します。

T_ATTRIBUTEは、例えばHTML要素の属性を設定するDOMElement::setAttribute()や、データベース接続オプションを設定するPDO::setAttribute()といったメソッドとは全く異なる目的で利用されます。これらのsetAttribute()メソッドがオブジェクトのプロパティや動作を「設定する」ものであるのに対し、T_ATTRIBUTEはPHPソースコードそのものの「構文を解析する」ために使われる、内部的なトークンIDです。

サンプルコードでは、まず自身のPHPソースコードを読み込み、token_get_all()関数を使ってソースコードを構成する個々の要素（トークン）に分解しています。そして、そのトークンの中からT_ATTRIBUTEという定数と一致するIDを持つトークンを探し出し、それが属性構文#[...]の開始部分であることを示しています。引数はなく、この定数自体が持つ整数値（トークンID）を戻り値として返します。これは、コードの構造を分析する際に特定の構文要素を識別するために用いられる、プログラミング言語の内部的な定数の一つです。