ReflectionClass::getAttributes

(PHP 8)

ReflectionClass::getAttributes — Gets Attributes

说明

public ReflectionClass::getAttributes ( string|null $name = null , int $flags = 0 ) : array

Returns all attributes declared on this class as an array of ReflectionAttribute.

Warning

本函数还未编写文档，仅有参数列表。

参数

name
flags

返回值

Array of attributes, as a ReflectionAttribute object.

参见

ReflectionClassConstant::getAttributes() - Gets Attributes
ReflectionFunctionAbstract::getAttributes() - Gets Attributes
ReflectionParameter::getAttributes() - Gets Attributes
ReflectionProperty::getAttributes() - Gets Attributes

User Contributed Notes

sergiolibe at gmail dot com 06-Jul-2021 03:11


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"]