ReflectionParameter::getAttributes

(PHP 8)

ReflectionParameter::getAttributes — Gets Attributes

Опис

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

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

Параметри

name

Повернути примірники ReflectionAttribute для атрибутів з даною назвою класу.

flags

Прапорці, що визначають, як саме фільтрувати результати, якщо вказано параметр name.

0 (початкове значення) — повертаються результати для атрибутів, які мають назву класу name.

ReflectionAttribute::IS_INSTANCEOF — повертаються результати для атрибутів із застосуваннями instanceof.

Значення, що повертаються

Array of attributes, as a ReflectionAttribute object.

Приклади

Приклад #1 Basic usage

<?php
#[Attribute]
class Fruit {
}

#[Attribute]
class Red {
}

function fruitBasket(
   #[Fruit]
   #[Red]
   string $apple
) { }

$reflection = new ReflectionFunction('fruitBasket');
$parameter = $reflection->getParameters()[0];
$attributes = $parameter->getAttributes();
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

Поданий вище приклад виведе:

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

Приклад #2 Filtering results by class name

<?php
#[Attribute]
class Fruit {
}

#[Attribute]
class Red {
}

function fruitBasket(
   #[Fruit]
   #[Red]
   string $apple
) { }

$reflection = new ReflectionFunction('fruitBasket');
$parameter = $reflection->getParameters()[0];
$attributes = $parameter->getAttributes('Fruit');
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

Поданий вище приклад виведе:

Array
(
    [0] => Fruit
)

Приклад #3 Filtering results by class name, with inheritance

<?php
interface Color {
}

#[Attribute]
class Fruit {
}

#[Attribute]
class Red implements Color {
}

function fruitBasket(
   #[Fruit]
   #[Red]
   string $apple
) { }

$reflection = new ReflectionFunction('fruitBasket');
$parameter = $reflection->getParameters()[0];
$attributes = $parameter->getAttributes('Color', ReflectionAttribute::IS_INSTANCEOF);
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

Поданий вище приклад виведе:

Array
(
    [0] => Red
)

Прогляньте також

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