ReflectionFunctionAbstract::getAttributes

(PHP 8)

ReflectionFunctionAbstract::getAttributes — 获取属性

描述

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