【PHP8.x】notationsプロパティの使い方

Copy
1<?php
2
3/**
4 * XML DTD (Document Type Definition) 内の NOTATION 宣言を処理するサンプルコードです。
5 *
6 * PHPの文脈で「アノテーション」は通常、PHPDocコメントなどを使ったメタデータ付与を指しますが、
7 * XML DTD の `NOTATION` 宣言は、XML文書内で特定のデータ形式や外部リソースタイプを
8 * 「注釈（アノテーション）」として定義する機能を提供します。
9 * このコードは、DOMDocumentType::notations プロパティを使って、
10 * これらの NOTATION 宣言の情報を取得し表示します。
11 *
12 * @return void
13 */
14function demonstrateXmlNotations(): void
15{
16    // NOTATION 宣言を含むXML文字列を定義します。
17    // NOTATION は、XML文書が参照する外部エンティティの形式を宣言するために使用されます。
18    $xmlString = <<<XML
19<?xml version="1.0"?>
20<!DOCTYPE document [
21  <!-- 以下の NOTATION は、文書内で参照される外部エンティティのタイプを定義します。 -->
22  <!-- 例えば、'gif' という NOTATION は GIF 画像ファイルを指すことを宣言します。 -->
23  <!NOTATION gif PUBLIC "-//W3C//DTD GIF 89a//EN" "">
24  <!NOTATION jpeg SYSTEM "http://example.com/image/jpeg-viewer">
25  <!NOTATION pdf PUBLIC "ISO 32000-1:2008" "http://example.com/application/pdf-reader">
26]>
27<document>
28    <!-- ここで定義した NOTATION を ENTITY などで参照できますが、この例では参照はしていません。 -->
29    <item type="image/gif">sample.gif</item>
30    <item type="image/jpeg">sample.jpg</item>
31    <item type="application/pdf">document.pdf</item>
32</document>
33XML;
34
35    // DOMDocument オブジェクトを作成し、XMLをロードします。
36    $dom = new DOMDocument();
37    // XMLのパースエラーを抑制し、代わりに LibXML エラーとして捕捉します。
38    libxml_use_internal_errors(true);
39
40    if (!$dom->loadXML($xmlString)) {
41        echo "エラー: XMLのロードに失敗しました。\n";
42        foreach (libxml_get_errors() as $error) {
43            echo "  LibXMLエラー: " . trim($error->message) . "\n";
44        }
45        libxml_clear_errors(); // エラーをクリア
46        return;
47    }
48
49    // XML文書の DOMDocumentType オブジェクトを取得します。
50    // これは DTD (Document Type Definition) の情報を含みます。
51    $doctype = $dom->doctype;
52
53    // DOMDocumentType が存在するか確認します。
54    if ($doctype instanceof DOMDocumentType) {
55        echo "--- XML DTD Notations 情報 ---\n";
56
57        // DOMDocumentType::notations プロパティから、
58        // DTD 内に宣言された全ての NOTATION を含む DOMNamedNodeMap を取得します。
59        // DOMNamedNodeMap は、名前でアクセスできるノードのコレクションです。
60        $notations = $doctype->notations;
61
62        if ($notations->length > 0) {
63            echo "DTD内で " . $notations->length . " 個の NOTATION が見つかりました:\n";
64            // DOMNamedNodeMap をループして、各 NOTATION の情報を表示します。
65            foreach ($notations as $notation) {
66                // 各 $notation は DOMNotation オブジェクトです。
67                if ($notation instanceof DOMNotation) {
68                    echo "  NOTATION名: " . $notation->nodeName . "\n";
69                    echo "    PUBLIC ID: " . ($notation->publicId ?? 'N/A') . "\n"; // 公開識別子
70                    echo "    SYSTEM ID: " . ($notation->systemId ?? 'N/A') . "\n"; // システム識別子 (URIなど)
71                }
72            }
73        } else {
74            echo "DTD内に NOTATION 宣言は見つかりませんでした。\n";
75        }
76    } else {
77        echo "XMLドキュメントに DTD が見つからないか、DOMDocumentType オブジェクトではありません。\n";
78    }
79
80    libxml_clear_errors(); // 処理後、LibXMLのエラーフラグをクリア
81}
82
83// 関数を実行します
84demonstrateXmlNotations();

PHPのDOMDocumentType::notationsプロパティは、XMLのDTD（Document Type Definition）内に定義されたNOTATION宣言の情報を取得するために使用されます。NOTATIONとは、XML文書が参照する外部エンティティのデータ形式やリソースタイプを定義するための宣言です。

このプロパティは引数を取らず、戻り値としてDOMNamedNodeMap型のオブジェクトを返します。DOMNamedNodeMapは、名前でアクセスできるノードのコレクションで、ここではDTD内に宣言された各NOTATIONがDOMNotationオブジェクトとして格納されています。

サンプルコードでは、NOTATION宣言を含むXML文字列をDOMDocumentにロードし、$dom->doctypeからDOMDocumentTypeオブジェクトを取得しています。そして、そのnotationsプロパティにアクセスすることで、DTD内に定義された全てのNOTATION情報を取得しています。取得したDOMNamedNodeMapをループ処理することで、各NOTATION宣言の名称（nodeName）、公開識別子（publicId）、システム識別子（systemId）といった詳細情報を表示しています。これにより、XML DTDに定義された外部リソースの型情報をプログラムから簡単に把握できます。なお、PHPにおける「アノテーション」とは通常PHPDocコメントなどを指しますが、XML DTDのNOTATIONは異なる概念です。