PHP: Declarando Classes de Atributos

Declarando Classes de Atributos

Embora não seja estritamente necessário, é recomendável criar uma classe real para cada atributo. No caso mais simples, apenas uma classe vazia é necessária com o atributo #[Attribute] declarado que pode ser importado do namespace global com uma declaração use.

Exemplo #1 Classe de Atributo Simples

<?php

namespace Example;

use Attribute;

#[Attribute]
class MyAttribute
{
}

Para restringir o tipo de declaração ao qual um atributo pode ser atribuído, uma máscara de bits pode ser passada como o primeiro argumento para a declaração #[Attribute].

Exemplo #2 Usando a especificação de destino para restringir onde os atributos podem ser usados

<?php

namespace Example;

use Attribute;

#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)]
class MyAttribute
{
}

Declarar MyAttribute em outro tipo agora lançará uma exceção durante a chamada para ReflectionAttribute::newInstance()

Os seguintes alvos podem ser especificados:

Attribute::TARGET_CLASS
Attribute::TARGET_FUNCTION
Attribute::TARGET_METHOD
Attribute::TARGET_PROPERTY
Attribute::TARGET_CLASS_CONSTANT
Attribute::TARGET_PARAMETER
Attribute::TARGET_ALL

Por padrão, um atributo só pode ser usado uma vez por declaração. Se o atributo deve ser repetível nas declarações, ele deve ser especificado como parte da máscara de bits para a declaração #[Attribute].

Exemplo #3 Usando IS_REPEATABLE para permitir o atributo em uma declaração várias vezes

<?php

namespace Example;

use Attribute;

#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)]
class MyAttribute
{
}

add a note

User Contributed Notes 1 note

down

esdras-schonevald ¶

3 years ago


#! Require PHP >= 8.0

#! This is a Sample

<?php

declare(strict_types = 1);

#[Attribute]
class Foo
{
    function __construct(){
        echo "Running " . __METHOD__ . PHP_EOL;
    }
}

#[Attribute(Attribute::TARGET_CLASS|Attribute::IS_REPEATABLE)]
class Bar {
    function __construct(?string ...$args){
        echo "Running " . __METHOD__ ,
            " args: " . implode(", ", $args) . PHP_EOL;
    }
}

#[Attribute(Attribute::TARGET_ALL)]
class Baz {
    function __construct(
        private string $parameter
    ){
        echo "Running " . __METHOD__ ,
            " arg: " . $this->parameter . PHP_EOL;
    }
}

#[Foo]                                      // [0]
#[Bar]                                      // [1]
#[Bar("Banana")]                            // [2]
#[Bar("Banana", "Apple", "Lemon", "Grape")] // [3]
#[Baz("The Only One")]                      // [4]
class Qux
{
}

// Getting class attribute with ReflectionClass
$ref    =   new ReflectionClass(Qux::class);
$attrs  =   $ref->getAttributes(); // Array of attributes

$attrs[0]->newInstance(); // "Running Foo::__construct"
$attrs[1]->newInstance(); // "Running Bar::__construct args: "
$attrs[2]->newInstance(); // "Running Bar::__construct args: Banana"
$attrs[3]->newInstance(); // "Running Bar::__construct args: Banana, Apple, Lemon, Grape"
$attrs[4]->newInstance(); // "Running Baz::__construct arg: The Only One"

add a note