【PHP8.x】DOMEntityReference::attributesプロパティの使い方

Copy
1<?php
2
3/**
4 * PHP 8の「アトリビュート」を定義します。
5 * #[Attribute] をクラスの上に記述することで、そのクラスがアトリビュートとして
6 * 使えるようになります。
7 * アトリビュートは、コードに関する構造化されたメタデータをプログラム的に付与する仕組みです。
8 */
9#[Attribute(Attribute::TARGET_METHOD)]
10final class Route
11{
12    public string $path;
13    public string $method;
14
15    public function __construct(string $path, string $method = 'GET')
16    {
17        $this->path = $path;
18        $this->method = $method;
19    }
20}
21
22/**
23 * 比較対象となる、古いスタイルの「アノテーション」を使用するクラス。
24 * アノテーションは、PHPDoc形式の単なるコメントであり、プログラム的な構造を持ちません。
25 * 情報を読み取るには、コメント文字列を正規表現などで手動で解析する必要があります。
26 */
27class LegacyController
28{
29    /**
30     * ユーザー情報を取得します。
31     * @Route("/legacy/user", method="GET")
32     */
33    public function getUser(): void
34    {
35        // ...処理
36    }
37}
38
39/**
40 * PHP 8の「アトリビュート」を使用するクラス。
41 * アトリビュートは #[...] という構文で記述します。
42 * こちらは言語機能の一部であり、リフレクションAPIを通じて簡単に
43 * オブジェクトとして取得・利用できます。
44 */
45class ModernController
46{
47    #[Route('/modern/user', method: 'GET')]
48    public function getUser(): void
49    {
50        // ...処理
51    }
52}
53
54// --- メタデータの読み取りと比較 ---
55
56echo "--- 1. アノテーション (PHPDocコメント) の解析 ---\n";
57
58// Reflection APIを使ってLegacyControllerのメソッド情報を取得
59$reflectionLegacyMethod = new ReflectionMethod(LegacyController::class, 'getUser');
60$docComment = $reflectionLegacyMethod->getDocComment();
61
62echo "取得したPHPDocコメント文字列: " . $docComment . "\n";
63
64// コメント文字列から正規表現で情報を手動で抽出する必要がある
65if (preg_match('/@Route\("([^"]+)",\s*method="([^"]+)"\)/', $docComment, $matches)) {
66    $path = $matches[1];
67    $method = $matches[2];
68    echo "解析結果 -> Path: {$path}, Method: {$method}\n\n";
69}
70
71
72echo "--- 2. アトリビュートの解析 ---\n";
73
74// Reflection APIを使ってModernControllerのメソッド情報を取得
75$reflectionModernMethod = new ReflectionMethod(ModernController::class, 'getUser');
76
77// getAttributes()メソッドで、付与されたアトリビュートの情報を取得
78$attributes = $reflectionModernMethod->getAttributes(Route::class);
79
80if (!empty($attributes)) {
81    // アトリビュートのインスタンスを生成
82    $routeAttribute = $attributes[0]->newInstance();
83    echo "取得したAttributeオブジェクトのクラス名: " . get_class($routeAttribute) . "\n";
84    
85    // オブジェクトのプロパティとして情報に直接アクセスできる
86    $path = $routeAttribute->path;
87    $method = $routeAttribute->method;
88    echo "解析結果 -> Path: {$path}, Method: {$method}\n";
89}
90
91?>

このサンプルコードは、PHP 8で導入された「アトリビュート」と、それ以前から使われていたPHPDocコメントによる「アノテーション」の違いを比較し、アトリビュートの利便性を示しています。

LegacyControllerで使われているアノテーションは、/** ... */内に記述された単なるコメントです。プログラムからこの情報を利用するには、getDocComment()メソッドでコメントを文字列として取得し、正規表現などを使って手動で解析する必要があります。この方法は手間がかかり、コメントの書式が変わると正しく動作しなくなる可能性があります。

一方、ModernControllerで使われているアトリビュートは、#[...]という構文で記述されるPHPの言語機能です。これは構造化されたメタデータとして扱われます。リフレクションAPIのgetAttributes()メソッドを呼び出すと、付与されたアトリビュートの情報がオブジェクトの配列として返されます。さらに、newInstance()メソッドを実行することでアトリビュートクラス（この例ではRoute）のインスタンスが生成され、プロパティに直接アクセスして値を安全かつ簡単に取得できます。このようにアトリビュートは、コードに関する情報をプログラムから確実かつ容易に扱えるようにする、よりモダンで強力な仕組みです。