ReflectionFunctionAbstract::getAttributes

(PHP 8)

ReflectionFunctionAbstract::getAttributes — Получает атрибуты

Описание

public function ReflectionFunctionAbstract::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 {
}

class Factory {
    #[Fruit]
    #[Red]
    public function makeApple(): string
    {
        return 'apple';
    }
}

$method = new ReflectionMethod('Factory', 'makeApple');
$attributes = $method->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]
function makeApple(): string
{
    return 'apple';
}

$function = new ReflectionFunction('makeApple');
$attributes = $function->getAttributes();
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

Результат выполнения приведённого примера: 

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

Пример #3 Фильтрация результатов по имени класса

<?php
#[Attribute]
class Fruit {
}

#[Attribute]
class Red {
}

#[Fruit]
#[Red]
function makeApple(): string
{
    return 'apple';
}

$function = new ReflectionFunction('makeApple');
$attributes = $function->getAttributes('Fruit');
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

Результат выполнения приведённого примера: 

Array
(
    [0] => Fruit
)

Пример #4 Фильтрация результатов по имени класса, с наследованием

<?php
interface Color {
}

#[Attribute]
class Fruit {
}

#[Attribute]
class Red implements Color {
}

#[Fruit]
#[Red]
function makeApple(): string
{
    return 'apple';
}

$function = new ReflectionFunction('makeApple');
$attributes = $function->getAttributes('Color', ReflectionAttribute::IS_INSTANCEOF);
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

Результат выполнения приведённого примера: 

Array
(
    [0] => Red
)

Смотрите также