【PHP8.x】Attribute::TARGET_ALL定数の使い方

Copy
1<?php
2
3use Attribute;
4
5/**
6 * PHP 8で導入されたカスタム属性の定義例です。
7 * `Attribute::TARGET_ALL` を使用することで、この属性がPHPコード内のあらゆる宣言（クラス、メソッド、プロパティ、関数、定数、パラメータ）に適用可能であることを示します。
8 *
9 * 注: HTMLの `target="_blank"` の「ターゲット」とは異なり、PHPの属性における「ターゲット」は、
10 * この属性をどのPHPコードの要素に付けられるかを指定するものです。
11 */
12#[Attribute(Attribute::TARGET_ALL)]
13class MyUniversalAttribute
14{
15    public function __construct(public string $purpose)
16    {
17    }
18}
19
20/**
21 * `MyUniversalAttribute` を様々なPHP要素に適用する例です。
22 */
23#[MyUniversalAttribute("このクラスの目的はデモンストレーションです。")]
24class MyDemoClass
25{
26    #[MyUniversalAttribute("このプロパティはユーザー名を表します。")]
27    public string $username = "Guest";
28
29    #[MyUniversalAttribute("このメソッドはユーザーに挨拶します。")]
30    public function sayHello(
31        #[MyUniversalAttribute("このパラメータは挨拶のメッセージです。")] string $message
32    ): void {
33        echo $message . ", " . $this->username . "!\n";
34    }
35
36    #[MyUniversalAttribute("この定数はデモのバージョンを示します。")]
37    public const DEMO_VERSION = 1;
38}
39
40#[MyUniversalAttribute("この関数は汎用的な処理を実行します。")]
41function performGenericTask(): void
42{
43    echo "汎用的なタスクが実行されました。\n";
44}
45
46// 属性自体はコードの実行に直接影響しませんが、リフレクションAPIを通じてメタデータとして利用できます。
47$instance = new MyDemoClass();
48$instance->sayHello("こんにちは");
49performGenericTask();

PHP 8で導入された「属性（Attribute）」は、クラスやメソッドといったPHPコードの要素に、追加のメタデータ（付加情報）をプログラム的に付与する機能です。Attribute::TARGET_ALLは、カスタム属性を定義する際に、その属性をPHPコード内のあらゆる宣言（クラス、メソッド、プロパティ、関数、定数、パラメータなど）に適用可能であることを指定するための定数です。この定数自体は引数を持たず、内部的に整数値を返します。

サンプルコードでは、#[Attribute(Attribute::TARGET_ALL)]と指定することで、MyUniversalAttributeというカスタム属性が、クラス、プロパティ、メソッド、その引数、定数、そして独立した関数といった、多岐にわたるPHPの構成要素に適用されている様子を示しています。属性は、#[]構文を使って対象の要素の直前に記述されます。

ここで言う「ターゲット」は、HTMLのtarget="_blank"のようにウェブページのリンク先指定とは異なり、PHPの属性が「どのPHPコード要素に付けられるか」という適用対象を指します。属性がコードの実行に直接影響を与えることはありませんが、リフレクションAPIを通じて実行時にそのメタデータを取得し、フレームワークやツールで活用されるのが主な目的です。

Copy
1<?php
2
3// Attribute::TARGET_ALL は、PHP 8 で導入された属性（Attribute）が適用可能な
4// 宣言ターゲット（クラス、メソッド、プロパティ、関数、定数、パラメータなど）
5// を指定するためのビットマスク定数です。
6// この定数を指定すると、定義した属性を可能なすべてのターゲットに適用できるようになります。
7
8// 1. Attribute::TARGET_ALL を使ってカスタム属性を定義します。
9// #[Attribute(Attribute::TARGET_ALL)] は、この MyUniversalAttribute が
10// どのような PHP 要素にも適用できることを示します。
11#[Attribute(Attribute::TARGET_ALL)]
12class MyUniversalAttribute
13{
14    public string $description;
15
16    public function __construct(string $description = '適用された場所')
17    {
18        $this->description = $description;
19    }
20}
21
22// 2. MyUniversalAttribute が Attribute::TARGET_ALL の設定により
23// 様々な PHP 宣言に適用できることを示します。
24
25// クラスに属性を適用
26#[MyUniversalAttribute('これはクラスに適用された属性です')]
27class SampleClass
28{
29    // プロパティに属性を適用
30    #[MyUniversalAttribute('これはプロパティに適用された属性です')]
31    public string $propertyName = 'Sample';
32
33    // クラス定数に属性を適用
34    #[MyUniversalAttribute('これはクラス定数に適用された属性です')]
35    public const CLASS_CONSTANT = 123;
36
37    // メソッドに属性を適用
38    #[MyUniversalAttribute('これはメソッドに適用された属性です')]
39    public function sampleMethod(
40        // メソッドのパラメータに属性を適用
41        #[MyUniversalAttribute('これはパラメータに適用された属性です')]
42        string $param
43    ): void {
44        echo "{$this->propertyName} のメソッドを実行: {$param}\n";
45    }
46}
47
48// 3. Attribute::TARGET_ALL の値を出力します。これは int 型のビットマスク値です。
49// 通常、この値は属性の宣言時に内部的に使用されるため、直接出力することは稀です。
50echo "Attribute::TARGET_ALL の値: " . Attribute::TARGET_ALL . "\n\n";
51
52// 4. リフレクションAPIを使って、属性が各ターゲットに正しく適用されていることを確認します。
53// これにより、Attribute::TARGET_ALL の効果が具体的に示されます。
54function demonstrateTargetAllUsage(): void
55{
56    echo "--- MyUniversalAttribute の適用状況を確認 ---" . "\n";
57
58    $reflectionClass = new ReflectionClass(SampleClass::class);
59
60    // クラスに属性が適用されているか
61    if (!empty($reflectionClass->getAttributes(MyUniversalAttribute::class))) {
62        echo "クラス 'SampleClass' に属性が適用されています。\n";
63    }
64
65    // プロパティに属性が適用されているか
66    if (!empty($reflectionClass->getProperty('propertyName')->getAttributes(MyUniversalAttribute::class))) {
67        echo "プロパティ '\$propertyName' に属性が適用されています。\n";
68    }
69
70    // クラス定数に属性が適用されているか
71    if (!empty($reflectionClass->getReflectionConstant('CLASS_CONSTANT')->getAttributes(MyUniversalAttribute::class))) {
72        echo "クラス定数 'CLASS_CONSTANT' に属性が適用されています。\n";
73    }
74
75    // メソッドに属性が適用されているか
76    if (!empty($reflectionClass->getMethod('sampleMethod')->getAttributes(MyUniversalAttribute::class))) {
77        echo "メソッド 'sampleMethod()' に属性が適用されています。\n";
78    }
79
80    // パラメータに属性が適用されているか
81    $parameters = $reflectionClass->getMethod('sampleMethod')->getParameters();
82    if (!empty($parameters) && !empty($parameters[0]->getAttributes(MyUniversalAttribute::class))) {
83        echo "パラメータ '\$param' に属性が適用されています。\n";
84    }
85    echo "------------------------------------------" . "\n";
86}
87
88// デモンストレーション関数を実行します。
89demonstrateTargetAllUsage();
90

PHP 8で導入されたAttribute::TARGET_ALLは、カスタム属性を定義する際に、その属性をPHPのどの要素に適用できるかを指定するための特別な定数です。これはビットマスクとして機能し、引数はなく、整数型（int）の値を返します。この定数を属性の定義時に指定すると、作成した属性をクラス、メソッド、プロパティ、クラス定数、関数、パラメータなど、PHPのあらゆる宣言ターゲットに適用できるようになります。

サンプルコードでは、まず#[Attribute(Attribute::TARGET_ALL)]という記述を用いて、MyUniversalAttributeというカスタム属性を定義しています。これにより、この属性がPHPコード内のどこにでも適用可能になります。続いて、MyUniversalAttributeが実際にクラス、プロパティ、クラス定数、メソッド、さらにはメソッドのパラメータにまで適用されている例が示されています。

Attribute::TARGET_ALLの具体的な整数値も出力されていますが、これは属性の定義時に内部的に使用されるため、通常は直接扱うことは稀です。コードの後半では、PHPのリフレクションAPIを利用して、定義された属性がそれぞれのターゲットに正しく適用されていることをプログラム的に確認しています。この確認によって、Attribute::TARGET_ALLが指定された属性が多様なPHP要素に適用できるという機能が具体的に示され、その挙動を深く理解できます。