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

Copy
1<?php
2
3// 1. PHP 8で導入されたカスタムアトリビュートを定義します。
4// Attribute::TARGET_CLASS および Attribute::TARGET_METHOD を指定することで、
5// このアトリビュートがクラスとメソッドの両方に適用可能であることを示します。
6#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
7class MySampleAttribute
8{
9    public function __construct(
10        public string $message,
11        public int $level = 1
12    ) {}
13}
14
15// 2. 定義したアトリビュートを適用するクラスとメソッドを作成します。
16#[MySampleAttribute(message: "これはデモクラスです", level: 10)]
17class DemoClass
18{
19    #[MySampleAttribute(message: "このメソッドはデモ用です", level: 20)]
20    public function demoMethod(): void
21    {
22        echo "demoMethodが実行されました。\n";
23    }
24}
25
26// 3. ReflectionAttribute::__toString() の動作を確認します。
27// ReflectionAttributeクラスの__toString()メソッドは、
28// そのオブジェクトが文字列として扱われたときに自動的に呼び出され、
29// アトリビュートの情報を人間が読める形式の文字列で返します。
30
31echo "--- クラスのアトリビュート情報 ---\n";
32// DemoClassのReflectionClassオブジェクトを作成し、クラスのリフレクション情報を取得します。
33$classReflection = new ReflectionClass(DemoClass::class);
34
35// クラスに適用されているMySampleAttributeアトリビュートを全て取得します。
36$classAttributes = $classReflection->getAttributes(MySampleAttribute::class);
37
38// 取得したReflectionAttributeオブジェクトをループ処理します。
39foreach ($classAttributes as $classAttribute) {
40    // ReflectionAttributeオブジェクトを直接echoすると、
41    // PHPは自動的にそのオブジェクトの__toString()メソッドを呼び出し、
42    // 返された文字列を表示します。
43    echo "クラスアトリビュートを文字列化: " . $classAttribute . "\n";
44    echo "---------------------------\n";
45}
46
47echo "\n--- メソッドのアトリビュート情報 ---\n";
48// demoMethodのReflectionMethodオブジェクトを作成し、メソッドのリフレクション情報を取得します。
49$methodReflection = new ReflectionMethod(DemoClass::class, 'demoMethod');
50
51// メソッドに適用されているMySampleAttributeアトリビュートを全て取得します。
52$methodAttributes = $methodReflection->getAttributes(MySampleAttribute::class);
53
54// 取得したReflectionAttributeオブジェクトをループ処理します。
55foreach ($methodAttributes as $methodAttribute) {
56    // 同様に、メソッドのアトリビュートも__toString()が呼び出されて文字列化されます。
57    echo "メソッドアトリビュートを文字列化: " . $methodAttribute . "\n";
58    echo "---------------------------\n";
59}
60
61?>

PHP 8で導入されたReflectionAttributeクラスの__toString()メソッドは、このオブジェクトを文字列として扱う際に自動的に呼び出される特殊なマジックメソッドです。引数はなく、アトリビュートのクラス名と、そのコンストラクタに設定された引数の値を含む、人間が読める形式の文字列（string型）を返します。

このサンプルコードでは、まずカスタムアトリビュートMySampleAttributeを定義し、それをクラスとメソッドに適用しています。次に、ReflectionClassやReflectionMethodを使って、これらのアトリビュートに対応するReflectionAttributeオブジェクトを取得します。取得したReflectionAttributeオブジェクトを直接echo文で出力すると、PHPは自動的に__toString()メソッドを呼び出します。その結果、アトリビュートの具体的な内容（例: MySampleAttribute(message: "...", level: ...)）が文字列としてコンソールに表示され、リフレクションを通じてアトリビュートの情報を簡単に確認できることを示しています。これは、アトリビュートのデバッグや情報表示に役立つ機能です。

Copy
1<?php
2
3// 1. カスタム属性を定義します。
4// #[Attribute] を指定することで、このクラスがPHPの属性として使用できることを示します。
5// Attribute::TARGET_CLASS は、この属性がクラスに適用可能であることを意味します。
6// Attribute::TARGET_METHOD は、この属性がメソッドに適用可能であることを意味します。
7#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
8class MyDescriptionAttribute
9{
10    public string $text;
11
12    /**
13     * 属性のコンストラクタです。
14     * 属性が使用される際にこのコンストラクタが呼び出されます。
15     *
16     * @param string $text この属性に渡される説明テキスト
17     */
18    public function __construct(string $text)
19    {
20        $this->text = $text;
21    }
22}
23
24// 2. 定義した属性をクラスとメソッドに適用します。
25// PHP 8以降の属性構文を使って、メタデータ（付加情報）を定義します。
26#[MyDescriptionAttribute("これはMySampleClassクラスに対するカスタム説明です。")]
27class MySampleClass
28{
29    /**
30     * このメソッドにもカスタム属性を適用します。
31     */
32    #[MyDescriptionAttribute("これはmyMethodメソッドに対するカスタム説明です。")]
33    public function myMethod(): void
34    {
35        // メソッドの具体的な処理は、このサンプルでは重要ではありません。
36    }
37}
38
39// 3. リフレクションAPIを使用して、適用された属性情報を取得します。
40// ReflectionClassは、クラスに関する情報（メソッド、プロパティ、属性など）を
41// 実行時に取得するためのクラスです。
42$reflectionClass = new ReflectionClass(MySampleClass::class);
43
44echo "--- MySampleClass の属性情報 ---" . PHP_EOL;
45
46// クラスに適用されているすべての属性（ReflectionAttributeオブジェクトの配列）を取得します。
47$classAttributes = $reflectionClass->getAttributes();
48
49if (empty($classAttributes)) {
50    echo "クラスには属性が適用されていません。" . PHP_EOL;
51} else {
52    foreach ($classAttributes as $attribute) {
53        // ReflectionAttribute オブジェクトを直接 `echo` すると、
54        // PHPの自動的な型変換により、内部で __toString() メソッドが自動的に呼び出されます。
55        // これにより、属性の文字列表現が出力されます。
56        echo "属性オブジェクトの文字列表現 (__toString): " . $attribute . PHP_EOL;
57
58        // 属性のクラス名を取得します。
59        echo "属性名: " . $attribute->getName() . PHP_EOL;
60
61        // 属性の実際のインスタンス（MyDescriptionAttributeオブジェクト）を作成し、
62        // コンストラクタに渡された値にアクセスします。
63        $instance = $attribute->newInstance();
64        echo "属性値 (text): " . $instance->text . PHP_EOL;
65        echo "--------------------" . PHP_EOL;
66    }
67}
68
69echo PHP_EOL . "--- myMethod の属性情報 ---" . PHP_EOL;
70
71// MySampleClass の myMethod メソッドのリフレクションオブジェクトを取得します。
72$reflectionMethod = $reflectionClass->getMethod('myMethod');
73
74// メソッドに適用されているすべての属性を取得します。
75$methodAttributes = $reflectionMethod->getAttributes();
76
77if (empty($methodAttributes)) {
78    echo "メソッドには属性が適用されていません。" . PHP_EOL;
79} else {
80    foreach ($methodAttributes as $attribute) {
81        // ここでも、ReflectionAttribute オブジェクトを `echo` することで、
82        // __toString() メソッドが呼び出され、文字列表現が出力されます。
83        echo "属性オブジェクトの文字列表現 (__toString): " . $attribute . PHP_EOL;
84        echo "属性名: " . $attribute->getName() . PHP_EOL;
85        $instance = $attribute->newInstance();
86        echo "属性値 (text): " . $instance->text . PHP_EOL;
87        echo "--------------------" . PHP_EOL;
88    }
89}
90
91?>

PHP 8から導入されたReflectionAttributeクラスは、PHPの「属性（Attributes）」に関する情報を取得するためのクラスです。その中の特殊メソッド__toStringは、ReflectionAttributeオブジェクトが文字列として扱われる際に自動的に呼び出され、オブジェクト自身の文字列表現を返す役割を持ちます。このメソッドは引数を取らず、戻り値として、その属性がどのようなものかを示す構成情報を含んだ文字列を返します。

具体的には、ReflectionAttributeオブジェクトをechoコマンドで出力したり、文字列結合などの文字列コンテキストで使用したりすると、PHPが自動的にこの__toStringメソッドを呼び出します。これにより、開発者はReflectionAttributeオブジェクトがどの属性を表しているのかを、簡潔な文字列で容易に確認できます。

サンプルコードでは、MyDescriptionAttributeというカスタム属性を定義し、それをMySampleClassクラスと、そのmyMethodに適用しています。その後、リフレクションAPIを使用してこれらの属性情報を取得し、取得したReflectionAttributeオブジェクトをechoで直接出力しています。このechoの際に、内部で__toStringメソッドが自動的に実行され、画面には「属性オブジェクトの文字列表現」として、属性のクラス名などが含まれた情報が表示されます。これは、デバッグ時などに、現在扱っている属性の概要を手軽に確認する際に非常に便利です。