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

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

Хотя и нет строго требования, лучше выполнять рекомендацию — создавать класс для каждого атрибута. В самом простом случае необходимо создать пустой класс с атрибутом #[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] с флагом Attribute::IS_REPEATABLE в битовой маске.

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

<?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