Attribute アトリビュート

(PHP 8)

はじめに

アトリビュートを使うと、コンピューターが解析できる構造化されたメタデータの情報を、コードの宣言時に埋め込むことができます。つまり、クラス、メソッド、関数、パラメータ、プロパティ、クラス定数にアトリビュートを指定することができます。アトリビュートで定義されたメタデータは、実行時にリフレクションAPI を使って調べることが出来ます。よって、アトリビュートは、コードに直接埋め込むことが出来る、設定のための言語とみなすことができます。

クラス概要

#[\Attribute(\Attribute::TARGET_CLASS)]
final class Attribute {

/* 定数 */

const int TARGET_CLASS;

const int TARGET_FUNCTION;

const int TARGET_METHOD;

const int TARGET_PROPERTY;

const int TARGET_CLASS_CONSTANT;

const int TARGET_PARAMETER;

const int TARGET_CONSTANT;

const int TARGET_ALL;

const int IS_REPEATABLE;

/* プロパティ */

public int $flags;

/* メソッド */

public function __construct(int $flags = Attribute::TARGET_ALL)

}

定義済み定数

Attribute::TARGET_CLASS
Attribute::TARGET_FUNCTION
Attribute::TARGET_METHOD
Attribute::TARGET_PROPERTY
Attribute::TARGET_CLASS_CONSTANT
Attribute::TARGET_PARAMETER
Attribute::TARGET_CONSTANT
Attribute::TARGET_ALL
Attribute::IS_REPEATABLE

プロパティ

flags

変更履歴

バージョン説明

8.5.0 Attribute::TARGET_CONSTANT が追加されました。抽象クラス、列挙型、インターフェイス、トレイトに #[\Attribute] を適用すると、コンパイル時にエラーが発生するようになりました。これより前のバージョンでは、このエラーは ReflectionAttribute::newInstance() がコールされたタイミングで、実行時にのみ報告されていました。

バージョン	説明
8.5.0	`Attribute::TARGET_CONSTANT` が追加されました。抽象クラス、列挙型、インターフェイス、トレイトに `#[\Attribute]` を適用すると、コンパイル時にエラーが発生するようになりました。これより前のバージョンでは、このエラーは ReflectionAttribute::newInstance() がコールされたタイミングで、実行時にのみ報告されていました。

参考

アトリビュートの概要