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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMNotationのattributesプロパティの動作を確認します。
7 *
8 * DOM仕様上、Notationノードは属性を持つことができません。
9 * そのため、PHPのDOM拡張機能において、DOMNotation->attributesプロパティは常にnullを返します。
10 * このサンプルコードは、DTDに定義されたNotationを取得し、そのattributesプロパティが
11 * 実際にnullであることを確認することで、この仕様を実証します。
12 */
13function checkDomNotationAttributes(): void
14{
15    // DTD (文書型定義) にNOTATION (記法) を含むXML文字列を定義します。
16    // 'jpeg' という名前の記法を宣言しています。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<!DOCTYPE doc [
20  <!NOTATION jpeg SYSTEM "image/jpeg">
21]>
22<doc />
23XML;
24
25    // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
26    $dom = new DOMDocument();
27    $dom->loadXML($xmlString);
28
29    // DocumentType (DTD) ノードを取得します。
30    // doctypeプロパティはDOMDocumentTypeオブジェクトまたはnullを返します。
31    $doctype = $dom->doctype;
32
33    if ($doctype === null) {
34        echo 'DTD (Document Type Definition) が見つかりませんでした。' . PHP_EOL;
35        return;
36    }
37
38    // DTD内の全てのNotationをDOMNamedNodeMapとして取得します。
39    // notationsプロパティは、記法が含まれているDOMNamedNodeMapまたはnullを返します。
40    $notations = $doctype->notations;
41
42    if ($notations === null || $notations->length === 0) {
43        echo 'Notation (記法) が見つかりませんでした。' . PHP_EOL;
44        return;
45    }
46
47    // 'jpeg' という名前のNotationノード (DOMNotationオブジェクト) を取得します。
48    /** @var DOMNotation $jpegNotation */
49    $jpegNotation = $notations->getNamedItem('jpeg');
50
51    // DOMNotation->attributes プロパティにアクセスします。
52    // このプロパティは常にnullを返すため、その値を確認します。
53    $attributes = $jpegNotation->attributes;
54
55    echo 'Notation名: ' . $jpegNotation->nodeName . PHP_EOL;
56
57    // var_dumpを使用して、プロパティがnullであることを表示します。
58    echo 'DOMNotation->attributes の値: ';
59    var_dump($attributes);
60
61    if ($attributes === null) {
62        echo '結論: DOMNotation->attributes は仕様通り、常にnullを返します。' . PHP_EOL;
63    }
64}
65
66// 関数を実行して結果を確認します。
67checkDomNotationAttributes();

このサンプルコードは、PHPのDOMNotationクラスに存在するattributesプロパティの動作を説明するものです。XMLの仕様では、記法（Notation）を表すノードは属性を持つことができません。この仕様に基づき、PHPのDOMNotationオブジェクトのattributesプロパティは、常にnullを返すように設計されています。

コードでは、まず文書型定義（DTD）内に'jpeg'という記法を定義したXML文字列を用意し、DOMDocumentで読み込みます。次に、DTDの中から'jpeg'記法のノード（DOMNotationオブジェクト）を取得し、そのattributesプロパティにアクセスして値を確認します。このプロパティは引数を取らず、仕様上の戻り値の型は属性のリストを表すDOMNamedNodeMapまたはnullですが、DOMNotationの場合は常にnullが返されます。

最終的にvar_dump関数を使ってプロパティの値を出力することで、実際にnullであることが表示されます。これにより、DOMNotation->attributesは仕様通り常にnullを返す、という動作を実証しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHP 8で導入された「Attribute」を定義します。
7 * これは構造化されたメタデータで、言語レベルで解釈されます。
8 * Attributeクラス自体は、#[Attribute]というAttributeでマークする必要があります。
9 */
10#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
11final class Route
12{
13    public function __construct(
14        public string $path,
15        public string $method = 'GET'
16    ) {
17    }
18}
19
20/**
21 * 比較対象として、従来の「Annotation」と新しい「Attribute」の両方を使用するクラスです。
22 */
23class UserController
24{
25    /**
26     * これは従来の「Annotation」です。
27     * PHPDocコメント内に記述され、単なる文字列として扱われます。
28     * 実行時に解釈するには、コメントを正規表現などで手動でパースする必要があります。
29     *
30     * @Route(path="/users", method="GET")
31     */
32    public function list(): void
33    {
34        // ユーザー一覧を取得する処理...
35    }
36
37    /**
38     * これがPHP 8の「Attribute」です。
39     * クラスのインスタンスとして扱われるため、IDEのサポートも受けやすく、
40     * リフレクションAPIを使って簡単に構造化されたデータとして取得できます。
41     */
42    #[Route(path: '/users/create', method: 'POST')]
43    public function create(): void
44    {
45        // ユーザーを作成する処理...
46    }
47}
48
49// --- リフレクションAPIを使ってメタデータを読み取る ---
50
51// UserControllerクラスのReflectionオブジェクトを作成
52$reflectionClass = new ReflectionClass(UserController::class);
53
54echo "UserController からメタ情報を読み取ります:" . PHP_EOL;
55echo "-----------------------------------------" . PHP_EOL;
56
57// クラスに定義された各メソッドを調べる
58foreach ($reflectionClass->getMethods() as $method) {
59    echo "メソッド: {$method->getName()}" . PHP_EOL;
60
61    // --- Attributeの読み取り (PHP 8+ の方法) ---
62    // getAttributes()で、指定したAttributeのReflectionAttributeオブジェクトの配列を取得
63    $attributes = $method->getAttributes(Route::class);
64
65    if (count($attributes) > 0) {
66        // newInstance()でAttributeクラスのインスタンスを生成
67        $routeAttribute = $attributes[0]->newInstance();
68        echo "  [Attribute] Path: {$routeAttribute->path}, Method: {$routeAttribute->method}" . PHP_EOL;
69    }
70
71    // --- Annotationの読み取り (従来の方法) ---
72    // getDocComment()でPHPDocコメントを文字列として取得
73    $docComment = $method->getDocComment();
74
75    if ($docComment !== false && str_contains($docComment, '@Route')) {
76        // 文字列なので、正規表現などで頑張ってパースする必要がある
77        // (ここでは簡易的なパース処理を実装)
78        preg_match('/@Route\(path="([^"]+)", method="([^"]+)"\)/', $docComment, $matches);
79        if (isset($matches[1]) && isset($matches[2])) {
80            $path = $matches[1];
81            $method = $matches[2];
82            echo "  [Annotation] Path: {$path}, Method: {$method} (文字列から抽出)" . PHP_EOL;
83        }
84    }
85    echo PHP_EOL;
86}

このサンプルコードは、PHP 8で導入された「Attribute」と、それ以前から使われてきた「Annotation」の違いを比較し、それぞれのメタ情報をプログラムで読み取る方法を示しています。

UserControllerクラスのlistメソッドに付与されている@Route(...)が、従来の「Annotation」です。これはPHPDocコメント内に記述された単なる文字列として扱われます。そのため、プログラムから内容を解釈するには、getDocComment()でコメント全体を文字列として取得し、正規表現などを用いて手動で解析（パース）する必要があります。

一方、createメソッドに付与されている#[Route(...)]がPHP 8の「Attribute」です。これは言語の構文として正式にサポートされており、Routeクラスのインスタンスとして扱われます。リフレクションAPIのgetAttributes()メソッドを使うことで、Attributeのオブジェクトを直接取得でき、newInstance()を呼び出すことでそのインスタンスを生成し、プロパティに安全にアクセスできます。

このようにAttributeは、Annotationと比べて型安全性が高く、IDEによる支援も受けやすいため、より信頼性の高い方法でコードにメタデータを付与できる仕組みです。