PHP 8のReflection APIで属性（アトリビュート）を読み取る方法

PHP 8では、クラス、プロパティ、クラス定数、メソッド、関数、パラメータなど、さまざまな要素に対して属性（アトリビュート）を宣言し、アクセスできるようになりました。

PHP 8のReflection APIは、対応するすべてのReflectionオブジェクトに対してgetAttributes()メソッドを提供しています。

getAttributes()メソッドは、ReflectionAttributeインスタンスの配列を返します。このインスタンスを通じて、属性名や引数を取得したり、指定された属性クラスのインスタンスを生成したりすることが可能です。

例：PHP 8でReflection APIを使って属性を読み取る

<?php
   #[Reading]
   #[Property(type: 'function', name: 'Student')]
   function Student()
   {
      return "Student";
   }
   function getAttributes(Reflector $reflection)
   {
      $attributes = $reflection->getAttributes();
      $finalresult = [];
      foreach ($attributes as $attribute)
      {
         $finalresult[$attribute->getName() ] = $attribute->getArguments();
      }
      return $finalresult;
   }
   $reflection = new ReflectionFunction("Student");
   print_r(getAttributes($reflection));
?>

このコードでは、まず#[Reading]と#[Property(...)]という2つの属性を関数Student()に付与しています。続いて、汎用関数getAttributes()を定義し、Reflectionオブジェクトからすべての属性を取得して、「属性名をキー、引数を値」とする連想配列に変換しています。最後にReflectionFunctionクラスを使ってStudent関数のリフレクションオブジェクトを生成し、結果を出力します。

なお、ReflectionAttributeが持つnewInstance()メソッドを呼び出せば、属性クラスの実際のインスタンスを生成することもできます。これにより、属性に定義されたメソッドやプロパティを実行時に活用できます。

出力結果

Array
(
   [Reading] => Array
   (
   )

   [Property] => Array
   (
      [type] => function
      [name] => Student
   )
)

出力を見ると、Reading属性は引数を持たないため空の配列になり、Property属性にはtypeとnameという2つの引数が格納されていることが確認できます。