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

Copy
1<?php
2
3// PHP 8で導入された属性（Attribute）を定義します。
4// #[Attribute] を使うことで、このクラス自体がPHPの属性として利用可能になります。
5// Attribute::TARGET_CLASS は、この属性がクラスにのみ適用可能であることを示します。
6#[Attribute(Attribute::TARGET_CLASS)]
7class VersionAttribute
8{
9    // 属性のコンストラクタで、属性に渡される引数を受け取ることができます。
10    public function __construct(public string $versionNumber) {}
11}
12
13// 別のクラスレベル属性を定義します。
14#[Attribute(Attribute::TARGET_CLASS)]
15class AuthorAttribute
16{
17    public function __construct(public string $name, public string $email = 'info@example.com') {}
18}
19
20// 複数の属性が付与されたサンプルクラスです。
21// これらの属性は、このクラスのメタデータとして機能します。
22#[VersionAttribute('1.0.0')]
23#[AuthorAttribute('山田太郎', 'taro.yamada@example.com')]
24class MyDataClass
25{
26    // このクラスの属性情報を取得するため、内部にメソッドやプロパティは定義しません。
27}
28
29// ReflectionClass を使って MyDataClass のリフレクション情報を取得します。
30// これにより、実行時にクラスの構造やメタデータ（属性など）を調べることができます。
31$reflectionClass = new ReflectionClass(MyDataClass::class);
32
33echo "--- クラス '" . MyDataClass::class . "' に付与された全ての属性 ---" . PHP_EOL;
34
35// ReflectionClass::getAttributes() を引数なしで呼び出すと、
36// クラスに付与された全ての属性（ReflectionAttribute オブジェクトの配列）を取得できます。
37$allAttributes = $reflectionClass->getAttributes();
38
39if (empty($allAttributes)) {
40    echo "このクラスには属性が付与されていません。" . PHP_EOL;
41} else {
42    foreach ($allAttributes as $attribute) {
43        // ReflectionAttribute::getName() で属性の完全修飾名を取得します。
44        echo "  属性名: " . $attribute->getName() . PHP_EOL;
45        // ReflectionAttribute::getArguments() で属性のコンストラクタに渡された引数を配列で取得します。
46        echo "  引数  : " . json_encode($attribute->getArguments()) . PHP_EOL;
47        echo "-------------------------------------" . PHP_EOL;
48    }
49}
50
51echo PHP_EOL;
52
53echo "--- クラス '" . MyDataClass::class . "' に付与された 'VersionAttribute' の情報 ---" . PHP_EOL;
54
55// getAttributes() メソッドに特定の属性の完全修飾名（FQCN）を渡すと、
56// その特定の属性のみをフィルタリングして取得できます。
57$versionAttributes = $reflectionClass->getAttributes(VersionAttribute::class);
58
59if (empty($versionAttributes)) {
60    echo "このクラスには 'VersionAttribute' は付与されていません。" . PHP_EOL;
61} else {
62    foreach ($versionAttributes as $attribute) {
63        echo "  属性名: " . $attribute->getName() . PHP_EOL;
64        echo "  引数  : " . json_encode($attribute->getArguments()) . PHP_EOL;
65
66        // ReflectionAttribute::newInstance() を使うと、属性クラス（ここでは VersionAttribute）
67        // のインスタンスを生成し、そのプロパティにアクセスできます。
68        $instance = $attribute->newInstance();
69        echo "  VersionAttributeインスタンスのバージョン番号: " . $instance->versionNumber . PHP_EOL;
70        echo "-------------------------------------" . PHP_EOL;
71    }
72}
73
74?>

ReflectionClass::getAttributesメソッドは、PHP 8で導入された「属性（Attribute）」の情報を、実行時に取得するための機能です。属性とは、クラス、メソッド、プロパティなどに付加されるメタデータで、プログラムの動作に影響を与えることなく追加情報を提供します。

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

第一引数$nameに属性の完全修飾名を指定すると、その特定の属性のみをフィルタリングして取得できます。これにより、特定の目的の属性情報を効率的に利用することができます。ReflectionClass::getAttributesを使用することで、アプリケーションは実行時にクラスのメタデータを動的に調べ、その情報に基づいて柔軟な処理を行うことが可能になります。

Copy
1<?php
2
3// PHP 8以降で導入された属性（Attributes）を使用します。
4// まず、デモンストレーション用のカスタム属性インターフェースを定義します。
5interface MyAttributeInterface
6{
7    public function getInfo(): string;
8}
9
10// 次に、カスタム属性クラスを定義します。
11// #[Attribute(\Attribute::TARGET_CLASS)] は、この属性がクラスにのみ適用できることを示します。
12// MyAttributeInterface を実装しています。
13#[Attribute(\Attribute::TARGET_CLASS)]
14class MyClassAttribute implements MyAttributeInterface
15{
16    public string $purpose;
17
18    public function __construct(string $purpose)
19    {
20        $this->purpose = $purpose;
21    }
22
23    public function getInfo(): string
24    {
25        return "Purpose: " . $this->purpose;
26    }
27}
28
29// もう一つのカスタム属性クラスを定義します。
30// これは MyAttributeInterface を実装しません。
31#[Attribute(\Attribute::TARGET_CLASS)]
32class VersionAttribute
33{
34    public string $version;
35
36    public function __construct(string $version)
37    {
38        $this->version = $version;
39    }
40}
41
42// 属性を適用するサンプルクラスを定義します。
43// ここではMyClassAttribute、VersionAttribute、および組み込みのDeprecated属性を使用しています。
44#[MyClassAttribute("このクラスはReflectionClass::getAttributesメソッドのデモ用です。")]
45#[VersionAttribute("1.2.3")]
46#[Deprecated('このクラスは将来的に非推奨になる可能性があります。', '1.0')]
47class MySampleClass
48{
49    public function sayHello(): string
50    {
51        return "Hello from MySampleClass!";
52    }
53}
54
55/**
56 * ReflectionClass::getAttributes() メソッドの使用方法をデモンストレーションします。
57 * この関数は、MySampleClassに適用された属性を取得し、表示します。
58 */
59function demonstrateReflectionClassAttributes(): void
60{
61    echo "--- ReflectionClass::getAttributes() のデモンストレーション ---" . PHP_EOL . PHP_EOL;
62
63    // 1. MySampleClass の ReflectionClass インスタンスを作成します。
64    //    これにより、クラスに関する情報（属性を含む）にアクセスできるようになります。
65    $reflectionClass = new ReflectionClass(MySampleClass::class);
66    echo "対象クラス: " . $reflectionClass->getName() . PHP_EOL . PHP_EOL;
67
68    // 2. クラスに適用されている全ての属性を取得します。
69    //    引数を指定しない場合、全ての属性が返されます。
70    echo "--- クラスに適用されている全ての属性 ---" . PHP_EOL;
71    $allAttributes = $reflectionClass->getAttributes();
72
73    if (empty($allAttributes)) {
74        echo "属性が見つかりませんでした。" . PHP_EOL;
75    } else {
76        foreach ($allAttributes as $attribute) {
77            echo "  属性名: " . $attribute->getName() . PHP_EOL;
78            echo "  引数: " . json_encode($attribute->getArguments()) . PHP_EOL;
79            // 属性のインスタンスを作成して、そのプロパティやメソッドにアクセスできます。
80            // $instance = $attribute->newInstance();
81            // 例: echo "  インスタンス情報: " . $instance->someProperty . PHP_EOL;
82            echo PHP_EOL;
83        }
84    }
85
86    echo PHP_EOL;
87
88    // 3. 特定の属性クラス名でフィルターして属性を取得します。
89    //    最初の引数 ($name) に属性の完全修飾クラス名を指定します。
90    echo "--- MyClassAttribute 型の属性 ---" . PHP_EOL;
91    $myClassAttributes = $reflectionClass->getAttributes(MyClassAttribute::class);
92
93    if (empty($myClassAttributes)) {
94        echo "MyClassAttribute 型の属性は見つかりませんでした。" . PHP_EOL;
95    } else {
96        foreach ($myClassAttributes as $attribute) {
97            echo "  属性名: " . $attribute->getName() . PHP_EOL;
98            echo "  引数: " . json_encode($attribute->getArguments()) . PHP_EOL;
99            // 属性のインスタンスを作成し、定義されたメソッドを呼び出します。
100            $instance = $attribute->newInstance();
101            echo "  情報 (インスタンスから): " . $instance->getInfo() . PHP_EOL;
102            echo PHP_EOL;
103        }
104    }
105
106    echo PHP_EOL;
107
108    // 4. インターフェースを実装している属性をフィルターして取得します (IS_INSTANCEOFフラグを使用)。
109    //    $name 引数にはインターフェースまたは親クラス名を指定します。
110    //    $flags 引数に ReflectionAttribute::IS_INSTANCEOF を指定すると、
111    //    $name で指定されたインターフェースを実装している、または親クラスを継承している属性のみが返されます。
112    echo "--- MyAttributeInterface を実装する属性 ---" . PHP_EOL;
113    $interfaceAttributes = $reflectionClass->getAttributes(MyAttributeInterface::class, ReflectionAttribute::IS_INSTANCEOF);
114
115    if (empty($interfaceAttributes)) {
116        echo "MyAttributeInterface を実装する属性は見つかりませんでした。" . PHP_EOL;
117    } else {
118        foreach ($interfaceAttributes as $attribute) {
119            echo "  属性名: " . $attribute->getName() . PHP_EOL;
120            echo "  引数: " . json_encode($attribute->getArguments()) . PHP_EOL;
121            // インターフェースを実装していることが分かっているので、そのメソッドを安全に呼び出せます。
122            $instance = $attribute->newInstance();
123            echo "  情報 (インスタンスから): " . $instance->getInfo() . PHP_EOL;
124            echo PHP_EOL;
125        }
126    }
127}
128
129// デモンストレーション関数を実行します。
130demonstrateReflectionClassAttributes();

ReflectionClass::getAttributes()は、PHP 8で導入された属性（Attributes）の情報を取得するためのメソッドです。このメソッドは、指定されたクラスに適用されている属性をプログラム的に検査することを可能にします。

まず、対象のクラスからReflectionClassのインスタンスを作成します。次に、このインスタンスを通じてgetAttributes()を呼び出します。引数なしで呼び出すと、そのクラスに適用されている全ての属性がReflectionAttributeオブジェクトの配列として返されます。

最初の引数$nameに属性の完全修飾クラス名を指定すると、特定の型の属性だけをフィルターして取得できます。例えば、MyClassAttribute::classを指定すると、MyClassAttribute型の属性のみが返されます。

二番目の引数$flagsにReflectionAttribute::IS_INSTANCEOFフラグを指定し、$nameにインターフェース名や親クラス名を渡すことで、そのインターフェースを実装している、または親クラスを継承している属性のみを取得することも可能です。

戻り値はReflectionAttributeオブジェクトの配列です。各ReflectionAttributeオブジェクトからは、属性の名前、コンストラクタに渡された引数、そして属性クラス自体のインスタンスを生成することができます。この機能は、フレームワークなどでクラスに付与されたメタデータに基づいて、動的に処理を行う際に非常に役立ちます。