Объявление классов атрибутов

Создавать классы для атрибутов не обязательно, но крайне рекомендуется. В самом простом случае требуется просто пустой класс с атрибутом #[Attribute], который можно импортировать из глобального пространства имён с помощью оператора use.

Пример #1 Простой класс с атрибутом

<?php

namespace Example;

use 
Attribute;

#[Attribute]
class MyAttribute
{
}

Для ограничения того, с каким типом деклараций можно использовать конкретный атрибут, можно передать битовую маску первым параметром в #[Attribute].

Пример #2 Ограничение допустимых сущностей для использования атрибута

<?php

namespace Example;

use 
Attribute;

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

После этого аннотирование атрибутом MyAttribute чего-либо, отличающегося от метода или функции, приведёт к выбрасыванию исключения при вызове ReflectionAttribute::newInstance().

Можно указать следующие сущности:

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

По умолчанию атрибут можно использовать только один раз для каждой сущности. Если нужна возможность указывать несколько одинаковых атрибутов для одной сущности - можно выставить соответствующий флаг в битовой маске для декларации #[Attribute].

Пример #3 Использование IS_REPEATABLE для разрешения использовать атрибут в объявлении несколько раз

<?php

namespace Example;

use 
Attribute;

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

User Contributed Notes 1 note

up
0
esdras-schonevald
5 months 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"
To Top