ReflectionClass::getAttributes

(PHP 8)

ReflectionClass::getAttributes — Gets Attributes

Description

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

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

Parameters

name

Filter the results to include only ReflectionAttribute instances for attributes matching this class name.

Unless ReflectionAttribute::IS_INSTANCEOF is passed in flags, no attribute class is autoloaded. The name is compared case-insensitively with the fully qualified class name of each attribute, and the class is not checked for existence.

flags

Flags for determining how to filter the results, if name is provided.

Default is 0 which will only return results for attributes that are of the class name.

The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, which will instead use instanceof for filtering.

Note:

When ReflectionAttribute::IS_INSTANCEOF is used, the class name specified by name is autoloaded before any attribute is examined. If it cannot be loaded, the error or exception thrown while loading it is propagated. If the class does not exist, an Error is thrown.

PHP also autoloads the class of every attribute declared on the element being reflected, including attributes that do not match the filter, because it uses instanceof to filter them. An attribute whose class does not exist is ignored. If an error or exception is thrown while loading an attribute class, for example because a parent class is missing or its file contains a syntax error, it is propagated, even if the attribute does not match the filter.

Return Values

Array of attributes, as a ReflectionAttribute object.

Examples

Example #1 Basic usage

<?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));
?>

The above example will output:

Array
(
    [0] => Fruit
    [1] => Red
)

Example #2 Filtering results by class name

<?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));
?>

The above example will output:

Array
(
    [0] => Fruit
)

Example #3 Filtering results by class name, with inheritance

<?php
interface Color {
}

#[Attribute]
class Fruit {
}

#[Attribute]
class Red implements Color {
}

#[Fruit]
#[Red]
class Apple {
}

$class = new ReflectionClass('Apple');
$attributes = $class->getAttributes(Color::class, ReflectionAttribute::IS_INSTANCEOF);
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

The above example will output:

Array
(
    [0] => Red
)