ReflectionProperty::getAttributes

(PHP 8)

ReflectionProperty::getAttributes — Obtém atributos

Descrição

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

Retorna todos os atributos declarados nesta propriedade de classe como um array de ReflectionAttribute.

Parâmetros

name

Filtra os resultados para incluir apenas instâncias de ReflectionAttribute para atributos correspondentes a este nome de classe.

flags

Flags para determinar como filtrar os resultados, se name for fornecido.

O padrão é 0, que retornará apenas os resultados para atributos que são da classe name.

A única outra opção disponível é usar ReflectionAttribute::IS_INSTANCEOF, que usará instanceof para filtragem.

Valor Retornado

Array de atributos, como um objeto ReflectionAttribute.

Exemplos

Example #1 Uso básico

<?php
#[Attribute]
class Fruit {
}

#[Attribute]
class Red {
}

class Basket {
    #[Fruit]
    #[Red]
    public string $apple = 'apple';
}

$property = new ReflectionProperty('Basket', 'apple');
$attributes = $property->getAttributes();
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

O exemplo acima produzirá:

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

Example #2 Filtrando resultados pelo nome da classe

<?php
#[Attribute]
class Fruit {
}

#[Attribute]
class Red {
}

class Basket {
    #[Fruit]
    #[Red]
    public string $apple = 'apple';
}

$property = new ReflectionProperty('Basket', 'apple');
$attributes = $property->getAttributes('Fruit');
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

O exemplo acima produzirá:

Array
(
    [0] => Fruit
)

Example #3 Filtrando resultados pelo nome da classe, com herança

<?php
interface Color {
}

#[Attribute]
class Fruit {
}

#[Attribute]
class Red implements Color {
}

class Basket {
    #[Fruit]
    #[Red]
    public string $apple = 'apple';
}

$property = new ReflectionProperty('Basket', 'apple');
$attributes = $property->getAttributes('Color', ReflectionAttribute::IS_INSTANCEOF);
print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
?>

O exemplo acima produzirá:

Array
(
    [0] => Red
)