PHP: アトリビュートクラスを宣言する

アトリビュートクラスを宣言する

厳密に必須ではありませんが、アトリビュート毎にクラスを作成することを推奨します。もっとも簡単な場合、グローバル名前空間からuse文でインポートできるアトリビュート #[Attribute] を宣言した空のクラスだけが必要です。

例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

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