【PHP8.x】ReflectionAttribute::getName()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHP 8で導入された属性（Attributes）を定義します。
5 * #[Attribute] を使用することで、このクラスが他のコード要素にメタデータとして付与できることを示します。
6 */
7#[Attribute]
8class ExampleAttribute
9{
10    public string $message;
11
12    public function __construct(string $message = "デフォルトメッセージ")
13    {
14        $this->message = $message;
15    }
16}
17
18/**
19 * 定義した属性をクラスに適用します。
20 * クラス名の直前に #[ExampleAttribute('Hello PHP 8')] のように記述します。
21 */
22#[ExampleAttribute('Hello PHP 8')]
23class TargetClass
24{
25    // このクラスには属性が付与されています。
26}
27
28/**
29 * ReflectionAttribute::getName() メソッドの使用例を示します。
30 * クラスに付与された属性の名前（完全修飾名）を取得します。
31 */
32function demonstrateReflectionAttributeGetName(): void
33{
34    echo "ReflectionAttribute::getName() デモンストレーション:\n";
35
36    // TargetClass のリフレクションオブジェクトを作成します。
37    // これにより、クラスに関するメタデータにアクセスできます。
38    $reflectionClass = new ReflectionClass(TargetClass::class);
39
40    // TargetClass に付与されているすべての属性を取得します。
41    // 戻り値は ReflectionAttribute オブジェクトの配列です。
42    $attributes = $reflectionClass->getAttributes();
43
44    // 属性が存在するか確認します。
45    if (!empty($attributes)) {
46        // 最初の属性オブジェクトを取得します。
47        // 今回は1つの属性のみ付与しているため、配列の最初の要素を取得します。
48        $firstAttribute = $attributes[0];
49
50        // ReflectionAttribute::getName() を使用して、属性の完全修飾名を取得します。
51        // この場合、取得される名前は ExampleAttribute クラスの完全修飾名になります。
52        $attributeName = $firstAttribute->getName();
53
54        echo "クラス '" . TargetClass::class . "' に付与された属性の名前: " . $attributeName . "\n";
55
56        // 取得した属性名が期待通りか確認します。
57        // PHP 8では、属性クラスの完全修飾名が返されます。
58        if ($attributeName === ExampleAttribute::class) {
59            echo "期待通りの属性名 '" . ExampleAttribute::class . "' が取得されました。\n";
60        } else {
61            echo "属性名が期待と異なります。\n";
62        }
63    } else {
64        echo "クラス '" . TargetClass::class . "' に属性が見つかりませんでした。\n";
65    }
66}
67
68// 関数を実行してデモンストレーションを開始します。
69demonstrateReflectionAttributeGetName();

ReflectionAttribute::getName()メソッドは、PHP 8で導入された「属性（Attributes）」に関する情報を、プログラムの実行中に動的に取得するリフレクション機能の一部です。このメソッドは、対象の属性の完全修飾名を文字列（string型）で返します。

このメソッドは引数を一切必要とせず、呼び出されたReflectionAttributeオブジェクトが表す属性クラスの完全修飾名を文字列として直接返します。例えば、#[ExampleAttribute]という属性がコードに付与されている場合、getName()メソッドからは"ExampleAttribute"という文字列が返されます。

サンプルコードでは、まずExampleAttributeというカスタム属性を定義し、それをTargetClassに適用しています。その後、TargetClassのリフレクション情報からこの属性をReflectionAttributeオブジェクトとして取得し、そのオブジェクトに対してgetName()メソッドを呼び出しています。これにより、属性名であるExampleAttribute::class（すなわち"ExampleAttribute"）が正確に取得され、画面に表示されます。この機能を使うことで、プログラムは適用されている属性の種類を動的に判別し、その情報に基づいて適切な処理を実行できるようになります。

Copy
1<?php
2
3// 1. カスタム属性の定義
4// `#[Attribute]` を使用して、このクラスが属性として機能することを示します。
5// `Attribute::TARGET_CLASS` は、この属性がクラスにのみ適用可能であることを示します。
6#[Attribute(Attribute::TARGET_CLASS)]
7class MyCustomAttribute
8{
9    public string $description;
10
11    public function __construct(string $description = 'Default description')
12    {
13        $this->description = $description;
14    }
15}
16
17// 2. 定義した属性をクラスに適用
18// ここで `MyCustomAttribute` を `MySampleClass` に適用します。
19#[MyCustomAttribute(description: 'This is a sample class with a custom attribute.')]
20class MySampleClass
21{
22    // クラスのプロパティやメソッド
23    public function __construct()
24    {
25        // コンストラクタ
26    }
27}
28
29/**
30 * ReflectionAttribute::getName() メソッドの使用例を示します。
31 * このメソッドは、属性の完全修飾クラス名 (FQCN) を返します。
32 *
33 * @return void
34 */
35function demonstrateReflectionAttributeGetName(): void
36{
37    echo "--- ReflectionAttribute::getName() のデモンストレーション ---\n\n";
38
39    // `MySampleClass` のリフレクションを作成します。
40    $reflector = new ReflectionClass(MySampleClass::class);
41
42    // クラスに適用されているすべての属性を取得します。
43    $attributes = $reflector->getAttributes();
44
45    if (empty($attributes)) {
46        echo "エラー: " . MySampleClass::class . " に属性が見つかりませんでした。\n";
47        return;
48    }
49
50    foreach ($attributes as $attribute) {
51        // `ReflectionAttribute::getName()` を呼び出し、属性のFQCNを取得します。
52        // このFQCNには、属性クラスが定義されている名前空間も含まれます。
53        $attributeFullyQualifiedName = $attribute->getName();
54
55        echo "属性の完全修飾クラス名 (FQCN): " . $attributeFullyQualifiedName . "\n";
56        echo "  - この名前は、属性の定義に利用されたクラスの名前空間を含みます。\n";
57
58        // FQCNから名前空間とクラス名を分解する例（'getnamespace' キーワードに関連）
59        $lastBackslashPos = strrpos($attributeFullyQualifiedName, '\\');
60        if ($lastBackslashPos !== false) {
61            $namespace = substr($attributeFullyQualifiedName, 0, $lastBackslashPos);
62            $className = substr($attributeFullyQualifiedName, $lastBackslashPos + 1);
63            echo "  - 名前空間部分: " . ($namespace ?: "グローバル名前空間") . "\n";
64            echo "  - クラス名部分: " . $className . "\n";
65        } else {
66            echo "  - 名前空間: グローバル名前空間\n";
67            echo "  - クラス名: " . $attributeFullyQualifiedName . "\n";
68        }
69
70        // 属性のインスタンスを取得して、そのプロパティにアクセスすることも可能です。
71        $attributeInstance = $attribute->newInstance();
72        echo "  - 属性インスタンスのプロパティ (description): " . $attributeInstance->description . "\n";
73        echo "\n";
74    }
75}
76
77// 関数を実行して結果を表示します。
78demonstrateReflectionAttributeGetName();

PHP 8のReflectionAttribute::getName()メソッドは、プログラムの実行中にクラスなどに付加された属性（Attribute）の情報を取得する「リフレクション」機能の一部です。このメソッドは、引数を受け取らず、対象の属性がどのクラスによって定義されたかを示す「完全修飾クラス名 (FQCN)」を文字列として返します。FQCNとは、クラス名にそのクラスが所属する名前空間を含めた、一意の識別子です。

サンプルコードでは、まずMyCustomAttributeという独自の属性を定義し、それをMySampleClassに適用しています。次に、ReflectionClassを使ってMySampleClassのリフレクション情報を取得し、そのクラスに適用されている属性のリストを取り出します。取得したReflectionAttributeオブジェクトからgetName()メソッドを呼び出すと、例えばMyCustomAttributeというFQCNが得られます。このFQCNには、属性が定義されている名前空間も含まれるため、どの属性が適用されているかを正確に識別し、必要に応じて名前空間部分を特定することも可能です。