ReflectionParameter::getAttributes

(PHP 8)

ReflectionParameter::getAttributes — 获取属性

描述

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

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

$reflection = new ReflectionFunction('fruitBasket');
$parameter = $reflection->getParameter('apple');
$attributes = $parameter->getAttributes();
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

上面的示例将输出

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

示例 #2 按类名筛选结果

<?php
#[Attribute]
class Fruit {
}

#[Attribute]
class Red {
}

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

$reflection = new ReflectionFunction('fruitBasket');
$parameter = $reflection->getParameter('apple');
$attributes = $parameter->getAttributes('Fruit');
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

上面的示例将输出

Array
(
    [0] => Fruit
)

示例 #3 按类名筛选结果，包括继承

<?php
interface Color {
}

#[Attribute]
class Fruit {
}

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

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