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

Copy
1<?php
2
3// (1) カスタム属性を定義します。
4// この属性はクラスやメソッドに適用でき、コンストラクタで引数を受け取ります。
5// `#[Attribute(...)]` は、このクラスがPHPの「属性（Attribute）」として使えることを示します。
6// `Attribute::TARGET_CLASS | Attribute::TARGET_METHOD` は、この属性をクラスとメソッドに適用できることを意味します。
7#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
8class MyCustomAttribute
9{
10    // 属性に渡される引数をプロパティとして定義します。
11    // PHP 8 のコンストラクタプロモーションを使用しています。
12    public function __construct(
13        public string $settingName, // 1つ目の引数（文字列）
14        public int $settingValue,   // 2つ目の引数（整数）
15        public bool $isActive = true // 3つ目の引数（真偽値、デフォルト値あり）
16    ) {
17    }
18}
19
20// (2) 定義したカスタム属性をクラスに適用します。
21// ここで属性のコンストラクタに具体的な値を渡しています。
22#[MyCustomAttribute("Application Name", 100, false)]
23class MyApplication
24{
25    // クラスの中身は、属性の取得とは直接関係ありませんが、
26    // 属性が適用される対象として定義します。
27    public function run(): void
28    {
29        echo "MyApplication is running.\n";
30    }
31}
32
33// (3) リフレクションAPIを使って、`MyApplication` クラスに適用された属性情報を取得します。
34// まず、`MyApplication` クラスのリフレクションオブジェクトを作成します。
35$reflectionClass = new ReflectionClass(MyApplication::class);
36
37echo "--- ReflectionAttribute::getArguments() の使用例 ---\n";
38echo "対象クラス: " . $reflectionClass->getName() . "\n\n";
39
40// クラスに適用されているすべての属性を取得します。
41// `getAttributes()` メソッドは、`ReflectionAttribute` オブジェクトの配列を返します。
42$attributes = $reflectionClass->getAttributes();
43
44if (empty($attributes)) {
45    echo "このクラスには属性が見つかりませんでした。\n";
46} else {
47    echo "見つかった属性:\n";
48    foreach ($attributes as $attribute) {
49        echo "  - 属性名: " . $attribute->getName() . "\n";
50
51        // (4) `ReflectionAttribute::getArguments()` を呼び出して、
52        // 属性のコンストラクタに渡された引数を配列として取得します。
53        // この配列のキーは引数のインデックス（位置）または引数名（名前付き引数使用時）です。
54        $arguments = $attribute->getArguments();
55
56        echo "    属性に渡された引数:\n";
57        if (empty($arguments)) {
58            echo "      (引数なし)\n";
59        } else {
60            // (5) 取得した引数（キーと値のペア）を分かりやすく表示します。
61            foreach ($arguments as $key => $value) {
62                // 引数の値が真偽値の場合は、`true` または `false` と表示します。
63                $displayValue = match (true) {
64                    is_bool($value) => $value ? 'true' : 'false',
65                    default => $value,
66                };
67                echo "      - 引数インデックス '{$key}': {$displayValue}\n";
68            }
69        }
70        echo "\n";
71    }
72}

PHP 8で導入された属性（Attribute）は、クラスやメソッドなどにメタデータ（付加情報）を定義する機能です。ReflectionAttributeクラスは、これらの属性に定義された情報をプログラムから動的に検査（リフレクション）するために使用されます。

ReflectionAttribute::getArguments()メソッドは、引数を受け取らず、この属性のコンストラクタに渡されたすべての引数を配列として取得するために利用されます。戻り値の配列は、キーが引数のインデックス（位置）または引数名（名前付き引数を使用した場合）となり、値が実際に渡された引数の値となります。

サンプルコードでは、MyCustomAttributeというカスタム属性が定義され、MyApplicationクラスに#[MyCustomAttribute("Application Name", 100, false)]として適用されています。ReflectionClassを使用してMyApplicationクラスの属性情報を取得した後、getArguments()メソッドを呼び出すことで、「Application Name」や「100」、「false」といった、属性のコンストラクタに渡された具体的な値が配列として取り出されています。この機能は、属性に埋め込まれた設定情報やメタデータを実行時に動的に読み取り、プログラムの振る舞いを制御したり、情報を表示したりする際に非常に便利です。

Copy
1<?php
2
3// PHP 8 で導入されたAttribute（属性）を定義します。
4// Attribute::TARGET_CLASS と Attribute::TARGET_METHOD を指定することで、
5// この属性がクラスとメソッドの両方に適用できることを示します。
6#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
7class MyCustomAttribute
8{
9    // Attributeのコンストラクタです。
10    // ここで定義された引数（$description, $level）が、
11    // ReflectionAttribute::getArguments() メソッドで取得される「パラメータ」になります。
12    public function __construct(
13        public string $description, // 属性の説明
14        public int $level = 0       // 属性のレベル (デフォルト値あり)
15    ) {}
16}
17
18// 定義した MyCustomAttribute をクラスに適用します。
19// "これはクラスレベルの属性です" という説明と、level: 1 を引数として渡しています。
20#[MyCustomAttribute("これはクラスレベルの属性です", level: 1)]
21class MySampleClass
22{
23    // 定義した MyCustomAttribute をメソッドに適用します。
24    // "これはメソッドレベルの属性です" という説明と、level: 5 を引数として渡しています。
25    #[MyCustomAttribute("これはメソッドレベルの属性です", level: 5)]
26    public function myMethod(): void
27    {
28        // このメソッドの実装は、属性の取得とは直接関係ありません。
29    }
30
31    // 別のメソッドに属性を適用し、引数の一部のみを指定する例です。
32    // $level はデフォルト値の 0 が使用されます。
33    #[MyCustomAttribute("引数が1つのみ指定されたメソッド")]
34    public function anotherMethod(): void
35    {
36        // ...
37    }
38}
39
40/**
41 * ReflectionAttribute::getArguments() メソッドの使用例を示す関数です。
42 * Attributeに渡された引数をリフレクションAPIを使って取得する方法をデモンストレーションします。
43 */
44function demonstrateAttributeArguments(): void
45{
46    echo "--- MySampleClass に適用されている属性の引数を取得 ---\n";
47
48    // MySampleClass のリフレクションオブジェクトを作成します。
49    $classReflection = new ReflectionClass(MySampleClass::class);
50
51    // クラスに適用されているすべての属性を取得し、一つずつループで処理します。
52    foreach ($classReflection->getAttributes() as $attribute) {
53        // 目的の MyCustomAttribute であることを確認します。
54        if ($attribute->getName() === MyCustomAttribute::class) {
55            echo "  検出されたAttribute名: " . $attribute->getName() . "\n";
56
57            // ReflectionAttribute::getArguments() を呼び出して、属性のコンストラクタに渡された引数を取得します。
58            // 戻り値は連想配列で、キーは引数名（名前付き引数の場合）、値は引数の値です。
59            $arguments = $attribute->getArguments();
60            echo "  取得された引数:\n";
61            foreach ($arguments as $key => $value) {
62                // 引数のキー（インデックスまたは名前）とその値を表示します。
63                // var_export(..., true) は値の型がわかる形で出力します。
64                echo "    - " . (is_string($key) ? "$key: " : "[$key]: ") . var_export($value, true) . "\n";
65            }
66        }
67    }
68
69    echo "\n--- MySampleClass::myMethod に適用されている属性の引数を取得 ---\n";
70
71    // MySampleClass::myMethod のリフレクションオブジェクトを作成します。
72    $methodReflection = new ReflectionMethod(MySampleClass::class, 'myMethod');
73
74    // メソッドに適用されているすべての属性を取得し、ループで処理します。
75    foreach ($methodReflection->getAttributes() as $attribute) {
76        if ($attribute->getName() === MyCustomAttribute::class) {
77            echo "  検出されたAttribute名: " . $attribute->getName() . "\n";
78            $arguments = $attribute->getArguments();
79            echo "  取得された引数:\n";
80            foreach ($arguments as $key => $value) {
81                echo "    - " . (is_string($key) ? "$key: " : "[$key]: ") . var_export($value, true) . "\n";
82            }
83        }
84    }
85
86    echo "\n--- MySampleClass::anotherMethod に適用されている属性の引数を取得 ---\n";
87
88    // MySampleClass::anotherMethod のリフレクションオブジェクトを作成します。
89    $anotherMethodReflection = new ReflectionMethod(MySampleClass::class, 'anotherMethod');
90
91    // メソッドに適用されているすべての属性を取得し、ループで処理します。
92    foreach ($anotherMethodReflection->getAttributes() as $attribute) {
93        if ($attribute->getName() === MyCustomAttribute::class) {
94            echo "  検出されたAttribute名: " . $attribute->getName() . "\n";
95            $arguments = $attribute->getArguments();
96            echo "  取得された引数:\n";
97            foreach ($arguments as $key => $value) {
98                echo "    - " . (is_string($key) ? "$key: " : "[$key]: ") . var_export($value, true) . "\n";
99            }
100        }
101    }
102}
103
104// 上記のデモンストレーション関数を実行します。
105demonstrateAttributeArguments();

PHP 8で導入された「Attribute（属性）」は、クラスやメソッド、プロパティなどにメタデータ（付加情報）をコードとして直接記述できる便利な機能です。ReflectionAttributeクラスは、プログラム実行時にこれらのAttributeに関する詳細な情報を動的に取得するために利用されます。

ReflectionAttribute::getArguments()メソッドは、特定のAttributeが定義される際にコンストラクタに渡された全ての引数（パラメータ）を取得する役割を持ちます。このメソッドには引数を渡す必要はありません。

戻り値は配列形式です。この配列は、Attributeのコンストラクタに渡された引数の名前（名前付き引数として渡された場合）または引数の順番を表す数値インデックスがキーとなり、それぞれの引数の値がセットされた連想配列として返されます。

例えば、サンプルコードの#[MyCustomAttribute("これはクラスレベルの属性です", level: 1)]というAttributeからgetArguments()を呼び出すと、["description" => "これはクラスレベルの属性です", "level" => 1]のような配列が取得されます。これにより、プログラムはAttributeに設定された具体的な値に基づいて、実行時に柔軟な処理を行うことが可能になります。これは、フレームワークが設定情報や動作規則を定義する際によく利用されます。