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

getAttributesメソッドは、PHPのバージョン8で導入された「属性（Attributes）」に関する情報を取得するメソッドです。このメソッドは、ReflectionClassというクラスに属しており、特定のクラスに適用されている属性の情報をプログラムから動的に読み取るために使用されます。

「属性」とは、クラス、メソッド、プロパティといったコードの要素に対して、追加のメタデータ（付加情報）を埋め込むための仕組みです。たとえば、Webフレームワークがルーティング情報をメソッドに直接記述したり、バリデーションルールをプロパティに付与したりする際に利用されます。

getAttributesメソッドを呼び出すと、対象となるクラスに宣言されているすべての属性、または特定の条件（例えば、特定の名前の属性のみ）に合致する属性のリストが、ReflectionAttributeオブジェクトの配列として返されます。各ReflectionAttributeオブジェクトからは、その属性の名前、引数、および関連するクラスインスタンスなどの詳細な情報を取得できます。

このメソッドは、特にフレームワークやライブラリの開発において非常に強力なツールとなります。実行時にコードの構造とそれに付与されたメタデータを分析し、それに基づいて自動的な処理や動的な設定を行うことが可能になるため、柔軟で拡張性の高いシステムを構築する上で不可欠な機能の一つと言えます。システムエンジニアにとって、コードの振る舞いをより深く理解し、高度なプログラミングを行うための重要な要素です。

Copy
1<?php
2
3#[Attribute(Attribute::TARGET_CLASS)]
4class ExampleAttribute
5{
6    public function __construct(public string $value) {}
7}
8
9#[ExampleAttribute('Hello from attribute')]
10class MyClass
11{
12    // クラスの定義
13}
14
15$reflectionClass = new ReflectionClass(MyClass::class);
16
17$attributes = $reflectionClass->getAttributes(ExampleAttribute::class);
18
19?>

?string $name = null, int $flags = 0

• ?string $name = null: 取得したい属性の名前を指定します。指定しない場合は、すべての属性が返されます。
• int $flags = 0: 属性の取得方法を制御するフラグを指定します。

ReflectionAttribute[]

ReflectionClass::getAttributesは、そのクラスに適用されているすべてのアノテーション（属性）の配列をReflectionAttributeオブジェクトとして返します。