SymfonyCon Disneyland Paris 2022

ReflectionClass::getAttributes

(PHP 8)

ReflectionClass::getAttributesアトリビュートを取得する

説明

public ReflectionClass::getAttributes(?string $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
)

参考

add a note

User Contributed Notes 2 notes

up
2
sandrenyl at gmail dot com
6 months ago
When using the method getAttributes() to fetch attributes based on a parent class, the proper flag constant is ReflectionAttribute::IS_INSTANCEOF (which equals 2 as mentionned by sergiolibe).

<?php
$reflectionClass
->getAttributes(SomeParentAttribute::class, ReflectionAttribute::IS_INSTANCEOF);
?>
up
1
sergiolibe at gmail dot com
11 months ago
When using getAttributes() with specific attribute class and flags, flag 0 will return just matching attributes with specified class, and 2 will return matching attributes with specified class and children of that class:
<?php
   
#[Attribute(\Attribute::TARGET_CLASS)]
   
class SomeAttribute {}

   
#[Attribute(\Attribute::TARGET_CLASS)]
   
class ChildAttribute extends SomeAttribute {}

   
#[SomeAttribute]
    #[SomeChildAttribute]
   
class SomeClass {}

   
$rc = new ReflectionClass(SomeClass::class);

   
$r_atts = $rc->getAttributes(SomeAttribute::class, 0); // 0 is default, just given class
   
echo json_encode(array_map(fn(ReflectionAttribute $r_att) => $r_att->getName(), $r_atts)), PHP_EOL;

   
$r_atts = $rc->getAttributes(SomeAttribute::class, 2); // given class and children classes
   
echo json_encode(array_map(fn(ReflectionAttribute $r_att) => $r_att->getName(), $r_atts)), PHP_EOL;
?>

output:
["SomeAttribute"]
["SomeAttribute","ChildAttribute"]
To Top