PHP: Sintaxis de atributos

Sintaxis de atributos

La sintaxis de atributos consta de varios componentes clave. Una declaración de atributo comienza con #[ y termina con ]. Dentro de esta, se pueden listar uno o más atributos, separados por comas. El nombre del atributo puede ser no cualificado, cualificado o totalmente cualificado, como se describe en Uso de los espacios de nombres: lo básico. Los argumentos para el atributo son opcionales y se encierran entre paréntesis (). Los argumentos solo pueden ser valores literales o expresiones constantes. Se admite la sintaxis de argumentos posicionales y nombrados.

Los nombres de los atributos y sus argumentos se resuelven en una clase, y los argumentos se pasan a su constructor cuando se solicita una instancia del atributo a través de la API de Reflection. Por lo tanto, se recomienda crear una clase para cada atributo.

Ejemplo #1 Sintaxis de atributos

<?php
// a.php
namespace MyExample;

use Attribute;

#[Attribute]
class MyAttribute
{
    const VALUE = 'value';

    private $value;

    public function __construct($value = null)
    {
        $this->value = $value;
    }
}

// b.php

namespace Another;

use MyExample\MyAttribute;

#[MyAttribute]
#[\MyExample\MyAttribute]
#[MyAttribute(1234)]
#[MyAttribute(value: 1234)]
#[MyAttribute(MyAttribute::VALUE)]
#[MyAttribute(array("key" => "value"))]
#[MyAttribute(100 + 200)]
class Thing
{
}

#[MyAttribute(1234), MyAttribute(5678)]
class AnotherThing
{
}

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

yarns dot purport0n at icloud dot com ¶

1 year ago

It wasn't obvious to me for a while but you can subclass attributeshttps://3v4l.org/TrMTe<?php#[Attribute(Attribute::TARGET_PROPERTY)]class PropertyAttributes {    public function __construct(        public readonly ?string $name = null,        public readonly ?string $label = null,    ) {} }#[Attribute(Attribute::TARGET_PROPERTY)]class IntegerPropertyAttributes extends PropertyAttributes {    public function __construct(        ?string $name = null,        ?string $label = null,        public readonly ?int $default = null,        public readonly ?int $min = null,        public readonly ?int $max = null,        public readonly ?int $step = null,    ) {        parent::__construct($name, $label);    } }#[Attribute(Attribute::TARGET_PROPERTY)]class FloatPropertyAttributes extends PropertyAttributes {    public function __construct(        ?string $name = null,        ?string $label = null,        public readonly ?float $default = null,        public readonly ?float $min = null,        public readonly ?float $max = null,    ) {        parent::__construct($name, $label);    } }class MyClass {     #[IntegerPropertyAttributes('prop', 'property: ', 5, 0, 10, 1)]     public int $prop; }$refl = new ReflectionProperty('MyClass', 'prop');$attributes = $refl->getAttributes();    foreach ($attributes as $attribute) {       var_dump($attribute->getName());       var_dump($attribute->getArguments());       var_dump($attribute->newInstance());    }?>

＋add a note