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

Copy
1<?php
2
3/**
4 * PHP 8のAttributeを定義します。
5 * #[Attribute] をクラスの前に記述することで、そのクラスがAttributeとして
6 * 使用できることを示します。
7 * これは、コメントとして記述されるアノテーションとは異なり、
8 * PHPの言語機能として組み込まれた構造化メタデータです。
9 */
10#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
11class Route
12{
13    private string $path;
14    private array $methods;
15
16    /**
17     * Attributeの引数を受け取るコンストラクタです。
18     *
19     * @param string $path URLのパスパターン
20     * @param array $methods 許可するHTTPメソッド
21     */
22    public function __construct(string $path, array $methods = ['GET'])
23    {
24        $this->path = $path;
25        $this->methods = $methods;
26    }
27
28    /**
29     * ルート情報を表示するメソッド。
30     *
31     * @param string $handlerName 処理を担当するメソッド名
32     */
33    public function printInfo(string $handlerName): void
34    {
35        $httpMethods = implode(', ', $this->methods);
36        echo "  - Path: {$this->path}\n";
37        echo "    Methods: [{$httpMethods}]\n";
38        echo "    Handler: {$handlerName}\n\n";
39    }
40}
41
42/**
43 * Web APIのコントローラを模したクラス。
44 * メソッドにRoute Attributeを付与して、エンドポイント情報を定義します。
45 */
46class ApiController
47{
48    #[Route('/api/users/{id}', methods: ['GET'])]
49    public function getUser(int $id): void
50    {
51        // ユーザー情報を取得する処理（ダミー）
52    }
53
54    #[Route('/api/users', methods: ['POST'])]
55    public function createUser(): void
56    {
57        // ユーザーを作成する処理（ダミー）
58    }
59}
60
61/**
62 * リフレクションAPIを使って、クラスに付与されたAttribute情報を読み取ります。
63 * これにより、プログラム実行時にメタデータを解釈し、動的な処理（例: ルーティング）
64 * を行うことができます。
65 *
66 * @param string $className 情報を解析するクラス名
67 */
68function inspectRoutes(string $className): void
69{
70    echo "Inspecting routes for class: {$className}\n\n";
71    $reflectionClass = new ReflectionClass($className);
72
73    // クラス内の各メソッドを調べる
74    foreach ($reflectionClass->getMethods() as $method) {
75        // メソッドに付与されたRoute Attributeを取得
76        $attributes = $method->getAttributes(Route::class);
77
78        foreach ($attributes as $attribute) {
79            // Attributeのインスタンスを生成
80            $route = $attribute->newInstance();
81            // Attributeの持つ情報を利用して処理を実行
82            $route->printInfo($className . '::' . $method->getName());
83        }
84    }
85}
86
87// ApiControllerクラスに定義されたルート情報を表示
88inspectRoutes(ApiController::class);
89
90?>

このサンプルコードは、PHP 8で導入された「Attribute（アトリビュート）」機能の基本的な使い方を示しています。Attributeは、クラスやメソッドに構造化されたメタデータ（付加情報）を直接関連付けるための言語機能です。

まず、#[Attribute]を付けたRouteクラスを定義しています。これにより、RouteクラスはAttributeとして使用できるようになります。このクラスのコンストラクタは、Attributeに渡される引数、ここではURLのパスとHTTPメソッドを受け取ります。

次に、ApiControllerクラスの各メソッド（getUserやcreateUser）の前に#[Route(...)]という形式で、先ほど定義したRoute Attributeを記述しています。これにより、各メソッドがどのURLに対応する処理なのかという情報を、コード内に直接埋め込むことができます。

最後に、inspectRoutes関数では「リフレクション」という機能を使っています。ReflectionClassを用いてクラスの構造を解析し、getAttributesメソッドでメソッドに付与されたRoute Attributeの情報を取得します。getAttributesメソッドは、見つかったAttributeの情報をReflectionAttributeオブジェクトの配列として返します。そして、newInstanceメソッドを呼び出すことでAttributeのインスタンスが生成され、コンストラクタで設定したパスなどの値にアクセスして、ルーティング情報を表示するような動的な処理が可能になります。

これは、従来コメントとして記述されていたアノテーションとは異なり、PHPの言語機能として構文エラーなどをチェックできる、より安全で強力な仕組みです。