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

Copy
1<?php
2
3// PHP 8以降で導入されたアトリビュートを定義します。
4// #[Attribute] アトリビュート自体もアトリビュートで修飾できます。
5// Attribute::TARGET_METHOD はこのアトリビュートがメソッドにのみ適用可能であることを示します。
6// Attribute::IS_REPEATABLE は同じアトリビュートを複数回適用できることを示します。
7#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
8class MyCustomAttribute
9{
10    // アトリビュートのコンストラクタで引数を受け取ります。
11    public function __construct(public string $message) {}
12}
13
14// もう一つ別のアトリビュートを定義します。
15#[Attribute(Attribute::TARGET_METHOD)]
16class AnotherMethodAttribute
17{
18    public function __construct(public int $id) {}
19}
20
21// アトリビュートが付与される対象のクラスとメソッドを定義します。
22class MyService
23{
24    // processDataメソッドに定義したアトリビュートを付与します。
25    #[MyCustomAttribute("Hello from PHP 8!")]
26    #[MyCustomAttribute("Welcome to Reflection!")]
27    #[AnotherMethodAttribute(id: 42)]
28    public function processData(): string
29    {
30        return "Data processed.";
31    }
32
33    public function getStatus(): string
34    {
35        return "Service is running.";
36    }
37}
38
39// ReflectionClass を使用して MyService クラスのリフレクションオブジェクトを作成します。
40$reflectionClass = new ReflectionClass(MyService::class);
41
42// processData メソッドの ReflectionMethod オブジェクトを取得します。
43$reflectionMethod = $reflectionClass->getMethod('processData');
44
45echo "--- processData() メソッドに付与された全てのアトリビュート ---\n";
46
47// getAttributes() を引数なしで呼び出すと、メソッドに付与された全てのアトリビュートが取得できます。
48// 戻り値は ReflectionAttribute オブジェクトの配列です。
49$allAttributes = $reflectionMethod->getAttributes();
50
51if (empty($allAttributes)) {
52    echo "アトリビュートは見つかりませんでした。\n";
53} else {
54    foreach ($allAttributes as $attribute) {
55        // アトリビュートの完全修飾名を取得します。
56        echo "アトリビュート名: " . $attribute->getName() . "\n";
57
58        // アトリビュートの引数を配列で取得します。
59        echo "引数: " . json_encode($attribute->getArguments()) . "\n";
60
61        // アトリビュートクラスのインスタンスを作成します。
62        // これにより、アトリビュートのコンストラクタで設定されたプロパティにアクセスできます。
63        $instance = $attribute->newInstance();
64
65        if ($instance instanceof MyCustomAttribute) {
66            echo "  -> MyCustomAttribute のメッセージ: " . $instance->message . "\n";
67        } elseif ($instance instanceof AnotherMethodAttribute) {
68            echo "  -> AnotherMethodAttribute のID: " . $instance->id . "\n";
69        }
70        echo "------\n";
71    }
72}
73
74echo "\n--- MyCustomAttribute 型のアトリビュートのみを取得 ---\n";
75
76// getAttributes() の第一引数にアトリビュートのクラス名を指定すると、
77// その型のアトリビュートのみをフィルタリングして取得できます。
78$myCustomTypeAttributes = $reflectionMethod->getAttributes(MyCustomAttribute::class);
79
80if (empty($myCustomTypeAttributes)) {
81    echo "MyCustomAttribute 型のアトリビュートは見つかりませんでした。\n";
82} else {
83    foreach ($myCustomTypeAttributes as $attribute) {
84        echo "アトリビュート名: " . $attribute->getName() . "\n";
85        $instance = $attribute->newInstance();
86        echo "  -> メッセージ: " . $instance->message . "\n";
87    }
88}
89
90?>

「ReflectionMethod::getAttributes」は、PHP 8で導入された「アトリビュート」を、リフレクション機能を使ってメソッドから動的に取得するためのメソッドです。これにより、実行時にコードの構造を詳細に解析できます。

このメソッドを引数なしで呼び出すと、対象のメソッドに付与されている全てのアトリビュートが「ReflectionAttribute」オブジェクトの配列として返されます。各「ReflectionAttribute」オブジェクトからは、「getName()」でアトリビュートの完全修飾名を取得したり、「getArguments()」でアトリビュートに渡された引数を取得できます。さらに、「newInstance()」メソッドを使用すると、アトリビュートクラスのインスタンスを生成し、そのプロパティ（コンストラクタで定義されたもの）にアクセスすることが可能です。

第一引数にアトリビュートのクラス名（例: MyCustomAttribute::class）を指定すると、その型のアトリビュートのみをフィルタリングして取得できます。これにより、特定の型のアトリビュートのみに関心がある場合に便利です。サンプルコードでは、まずprocessDataメソッドに付与された全てのアトリビュートを取得し、その後にMyCustomAttribute型のアトリビュートだけを抽出して情報を取り出しています。この機能は、フレームワークやライブラリがユーザー定義のアトリビュートを解析し、振る舞いを変更する際などに活用されます。