(PHP 8)
ReflectionClass::getAttributes — アトリビュートを取得する
$name
= null
, int $flags
= 0): arrayこのクラスで宣言されている全てのアトリビュートを ReflectionAttribute の配列として返します。
name
指定したクラス名にマッチするアトリビュートの、 ReflectionAttribute のみを含むようにフィルタします。
flags
name
が指定されていた場合に、
結果をどうフィルタするかを決めるフラグ。
デフォルトは 0
です。
この場合、アトリビュートのクラス名が
name
であるものだけを返します。
他の利用可能なオプションは、
ReflectionAttribute::IS_INSTANCEOF
です。
この場合、フィルタリングに
instanceof
を使います。
アトリビュートの配列を、 ReflectionAttribute オブジェクトの配列として返します。
例1 基本的な使用法
<?php
#[Attribute]
class Fruit {
}
#[Attribute]
class Red {
}
#[Fruit]
#[Red]
class Apple {
}
$class = new ReflectionClass('Apple');
$attributes = $class->getAttributes();
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>
上の例の出力は以下となります。
Array ( [0] => Fruit [1] => Red )
例2 クラス名で結果をフィルタする
<?php
#[Attribute]
class Fruit {
}
#[Attribute]
class Red {
}
#[Fruit]
#[Red]
class Apple {
}
$class = new ReflectionClass('Apple');
$attributes = $class->getAttributes('Fruit');
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>
上の例の出力は以下となります。
Array ( [0] => Fruit )
例3 クラス名、かつ継承も考慮して結果をフィルタする
<?php
interface Color {
}
#[Attribute]
class Fruit {
}
#[Attribute]
class Red implements Colour {
}
#[Fruit]
#[Red]
class Apple {
}
$class = new ReflectionClass('Apple');
$attributes = $class->getAttributes('Colour', ReflectionAttribute::IS_INSTANCEOF);
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>
上の例の出力は以下となります。
Array ( [0] => Red )