PHP: アトリビュートの文法

アトリビュートの文法

アトリビュートの文法は、複数の部分からなります。まず最初に、アトリビュートの宣言は常に #[ で始まり、それに対応する ] で囲みます。その内部では、ひとつ以上のアトリビュートが並び、それぞれをカンマで区切ります。アトリビュートの名前は、名前空間の基礎で説明している非修飾名、修飾名、完全修飾名が指定できます。アトリビュートの引数はオプションですが、括弧 () で囲みます。アトリビュートの引数はリテラル値か、定数式のみが指定できます。位置を指定した引数と、名前付き引数の両方が使えます。

アトリビュートの名前と引数は、アトリビュートのインスタンスがリフレクションAPIから要求された際、クラスとそのコンストラクタに渡す引数として解決されます。よって、それぞれのアトリビュート毎にクラスが存在するはずです。

例1 アトリビュートの文法

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

add a note

User Contributed Notes 1 note

down

yarns dot purport0n at icloud dot com ¶

4 months ago


It wasn't obvious to me for a while but you can subclass attributes

https://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