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

isRepeatedメソッドは、属性が繰り返し可能であるかを判定するメソッドです。

このメソッドは、PHP 8で導入された「属性（Attributes）」の情報を実行時に取得するReflectionAttributeクラスに属しています。属性とは、クラス、メソッド、プロパティといったプログラムの宣言に対して、追加の情報をメタデータとして付与できる機能です。プログラムの動作に影響を与える設定や、フレームワークでの振る舞いを定義する際などに利用されます。

isRepeatedメソッドは、現在検査している属性が、同じ宣言ターゲット（例えば、一つのクラスや一つのメソッド）に複数回適用することを許容されているかどうかを確認します。もし、その属性が定義時に#[Attribute(Attribute::IS_REPEATABLE)]のように「繰り返し可能」としてマークされている場合、このメソッドはtrueを返します。これは、同じ属性を#[MyAttribute] #[MyAttribute]のように複数回記述できることを意味します。

逆に、属性が繰り返し可能として定義されていない場合はfalseを返します。この機能は、リフレクションを通じてプログラムが自身の構造を動的に解析する際に、属性の適用ルールを適切に判断し、それに基づいた処理を実装するために利用されます。これにより、属性を使った柔軟なコード設計が可能となります。

Copy
1<?php
2
3#[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
4class MyRepeatableAttribute
5{
6    public function __construct(string $value) {}
7}
8
9#[MyRepeatableAttribute("value1")]
10#[MyRepeatableAttribute("value2")]
11class MyExampleClass {}
12
13$reflector = new ReflectionClass(MyExampleClass::class);
14$attributes = $reflector->getAttributes(MyRepeatableAttribute::class);
15
16$firstReflectionAttribute = $attributes[0];
17
18$isAttributeRepeated = $firstReflectionAttribute->isRepeated();

引数なし

引数はありません

bool

このメソッドは、ReflectionAttribute オブジェクトが繰り返し許容される属性であるかどうかを示す真偽値（bool）を返します。true の場合は繰り返し可能、false の場合は繰り返し不可です。