ReflectionProperty::getAttributes
(PHP 8)
ReflectionProperty::getAttributes — アトリビュートを取得する
説明
このクラスプロパティで宣言されている全てのアトリビュートを、 ReflectionAttribute の配列として返します。
パラメータ
name-
指定したクラス名にマッチするアトリビュートの、 ReflectionAttribute のみを含むようにフィルタします。
flags-
nameが指定されていた場合に、 結果をどうフィルタするかを決めるフラグ。デフォルトは
0です。 この場合、アトリビュートのクラス名がnameであるものだけを返します。他の利用可能なオプションは、
ReflectionAttribute::IS_INSTANCEOFです。 この場合、フィルタリングにinstanceofを使います。
戻り値
アトリビュートの配列を、 ReflectionAttribute オブジェクトの配列として返します。
例
例1 基本的な使い方
<?php
#[Attribute]
class Fruit {
}
#[Attribute]
class Red {
}
class Basket {
#[Fruit]
#[Red]
public string $apple = 'apple';
}
$property = new ReflectionProperty('Basket', 'apple');
$attributes = $property->getAttributes();
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>上の例の出力は以下となります。
Array
(
[0] => Fruit
[1] => Red
)
例2 クラス名で結果をフィルタする
<?php
#[Attribute]
class Fruit {
}
#[Attribute]
class Red {
}
class Basket {
#[Fruit]
#[Red]
public string $apple = 'apple';
}
$property = new ReflectionProperty('Basket', 'apple');
$attributes = $property->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 Color {
}
class Basket {
#[Fruit]
#[Red]
public string $apple = 'apple';
}
$property = new ReflectionProperty('Basket', 'apple');
$attributes = $property->getAttributes('Color', ReflectionAttribute::IS_INSTANCEOF);
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>上の例の出力は以下となります。
Array
(
[0] => Red
)
参考
- ReflectionClass::getAttributes() - アトリビュートを取得する
- ReflectionClassConstant::getAttributes() - アトリビュートを取得する
- ReflectionFunctionAbstract::getAttributes() - アトリビュートを取得する
- ReflectionParameter::getAttributes() - アトリビュートを取得する
add a note
User Contributed Notes
There are no user contributed notes for this page.
