【PHP8.x】flagsプロパティの使い方

Copy
1<?php
2
3/**
4 * Enum を Attribute フラグとして使用する例
5 */
6
7enum Permission: int
8{
9    case Read = 1;
10    case Write = 2;
11    case Execute = 4;
12}
13
14#[Attribute(flags: true)]
15class AccessControl
16{
17    public function __construct(public Permission $permission) {}
18}
19
20#[AccessControl(Permission::Read)]
21class Document
22{
23    // ...
24}
25
26$reflection = new ReflectionClass(Document::class);
27$attributes = $reflection->getAttributes(AccessControl::class);
28
29foreach ($attributes as $attribute) {
30    $instance = $attribute->newInstance();
31    echo "Permission: " . $instance->permission->name . PHP_EOL; // Permission: Read
32    echo "Value: " . $instance->permission->value . PHP_EOL; // Value: 1
33}

このサンプルコードは、PHP 8 で導入された Attribute 機能と Enum を組み合わせて、フラグとして属性を定義する方法を示しています。

まず、Permission という Enum を定義しています。この Enum は int 型をベースとし、Read, Write, Execute という3つのケースを持ち、それぞれ 1, 2, 4 という整数値を割り当てています。これらの値は、ビット演算で組み合わせることを想定したフラグとして利用できます。

次に、AccessControl という Attribute クラスを定義しています。#[Attribute(flags: true)] という記述により、このクラスが Attribute として使用されることを宣言しています。flags: true は、この Attribute が Enum のフラグを受け取ることを示します。コンストラクタでは、Permission Enum を引数として受け取り、プロパティ $permission に格納します。

Document クラスは、#[AccessControl(Permission::Read)] という Attribute を持っています。これにより、Document クラスに AccessControl Attribute が付与され、その引数として Permission::Read が渡されます。

コードの後半部分では、Reflection API を使用して Document クラスの Attribute 情報を取得しています。ReflectionClass で Document クラスをリフレクションし、getAttributes(AccessControl::class) で AccessControl Attribute を取得します。

最後に、取得した Attribute インスタンスから $permission プロパティの値を取り出し、その名前 (name) と値 (value) を出力しています。この例では、Permission: Read と Value: 1 が出力されます。

このように、Attribute と Enum を組み合わせることで、クラスやメソッドに付与するメタデータをより柔軟かつ型安全に定義することができます。flags: true を使用することで、Enum のフラグを Attribute の引数として扱うことが可能になり、より表現力豊かなコードを実現できます。