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

Copy
1<?php
2
3/**
4 * DOMNotation::getRootNode() メソッドの使用例。
5 *
6 * このスクリプトは、XML ドキュメント内の DOMNotation オブジェクトを取得し、
7 * その getRootNode() メソッドを呼び出してドキュメントのルートノード（DOMDocument オブジェクト自体）
8 * が返されることを示します。
9 */
10
11// 1. DOMDocument を作成し、<!DOCTYPE> 宣言に <NOTATION> を含む XML をロードします。
12// DOMNotation オブジェクトは、XML の DOCTYPE 宣言内で定義された記法 (notation) を表します。
13$xmlString = <<<XML
14<!DOCTYPE example_doc [
15  <!NOTATION MyNotation PUBLIC "My Public Identifier">
16]>
17<root_element>
18  <child_element/>
19</root_element>
20XML;
21
22$dom = new DOMDocument();
23// XML をロードし、パースエラーを抑制します（本番環境ではエラーハンドリングを推奨）。
24@$dom->loadXML($xmlString);
25
26// 2. DOMDocument から DOCTYPE オブジェクトを取得します。
27$docType = $dom->doctype;
28
29if ($docType instanceof DOMDocumentType) {
30    echo "DOCTYPE が見つかりました: " . $docType->name . "\n";
31
32    // 3. DOMDocumentType から NOTATIONs のマップ (DOMNamedNodeMap) を取得します。
33    $notations = $docType->notations;
34
35    if ($notations->length > 0) {
36        // 最初の DOMNotation オブジェクトを取得します。
37        $notation = $notations->item(0);
38
39        if ($notation instanceof DOMNotation) {
40            echo "DOMNotation オブジェクトが見つかりました: " . $notation->nodeName . "\n";
41
42            // 4. DOMNotation オブジェクトに対して getRootNode() メソッドを呼び出します。
43            // getRootNode() は、そのノードが属するドキュメントのルートノードを返します。
44            // DOMNotation の場合、通常は DOMDocument オブジェクト自身を返します。
45            $rootNode = $notation->getRootNode();
46
47            // 5. 返されたノードが DOMDocument オブジェクトであることを確認し、その情報を表示します。
48            if ($rootNode instanceof DOMDocument) {
49                echo "getRootNode() は DOMDocument オブジェクト自体を返しました。\n";
50                echo "ドキュメントのルート要素名: " . $rootNode->documentElement->nodeName . "\n";
51            } else {
52                echo "getRootNode() は予期しない型のノードを返しました: " . get_class($rootNode) . "\n";
53            }
54        } else {
55            echo "notations の最初の項目は DOMNotation オブジェクトではありませんでした。\n";
56        }
57    } else {
58        echo "DOCTYPE に NOTATION が見つかりませんでした。\n";
59    }
60} else {
61    echo "XML ドキュメントに DOCTYPE が見つかりませんでした。\n";
62}
63
64?>

DOMNotation::getRootNode()メソッドは、XMLドキュメントのDOCTYPE宣言内で定義された「記法（notation）」を表すDOMNotationオブジェクトが、どのドキュメントに属しているかを確認するために利用されます。このメソッドはオプションのint $options = 0という引数を受け取りますが、通常はデフォルト値でそのまま呼び出します。戻り値はDOMNode型で、具体的にはそのDOMNotationオブジェクトが属するXMLドキュメント全体のルートノード、つまりDOMDocumentオブジェクト自身が返されます。

サンプルコードでは、<!DOCTYPE>宣言にNOTATIONを含むXMLを読み込み、DOMDocumentTypeからDOMNotationオブジェクトを取得する過程を示しています。取得したDOMNotationオブジェクトに対してgetRootNode()を呼び出すことで、その記法が属する最上位のDOMDocumentオブジェクトが返されることを確認しています。この機能は、複雑なXML構造の中で特定のノードがどのドキュメントに紐付いているかをプログラム的に判別する際に役立ちます。

Copy
1<?php
2
3/**
4 * DOMNotation::getRootNode() メソッドの使用例を示します。
5 * このメソッドは、指定されたノードが属するツリーのルートノード（通常はDOMDocumentオブジェクト）を返します。
6 * DOMNotationはXMLのDOCTYPE宣言内で定義される記法を表します。
7 */
8function demonstrateDomNotationGetRootNode(): void
9{
10    // 1. XML文字列を定義します。DOCTYPE宣言で「gif」という記法(NOTATION)を定義します。
11    $xmlString = <<<'XML'
12<?xml version="1.0" encoding="UTF-8"?>
13<!DOCTYPE example [
14  <!-- 「gif」という名前の記法を定義します。これは通常、外部のデータ形式を参照するために使われます。 -->
15  <!NOTATION gif SYSTEM "image/gif">
16  <!ELEMENT root (child*)>
17  <!ELEMENT child EMPTY>
18]>
19<root>
20  <child/>
21</root>
22XML;
23
24    // 2. DOMDocumentオブジェクトを作成し、XML文字列を読み込みます。
25    $dom = new DOMDocument();
26    $dom->loadXML($xmlString);
27
28    // ドキュメントのDOCTYPE（Document Type Definition）オブジェクトを取得します。
29    $docType = $dom->doctype;
30
31    if ($docType === null) {
32        echo "エラー: ドキュメントにDOCTYPEが定義されていません。\n";
33        return;
34    }
35
36    // 3. DOMDocumentTypeオブジェクトから、定義された記法(notations)のリストを取得します。
37    // notaitonsプロパティは DOMNamedNodeMap オブジェクトを返します。
38    $notations = $docType->notations;
39
40    // 定義した記法「gif」を名前でリストから取得します。
41    /** @var DOMNotation|null $gifNotation */
42    $gifNotation = $notations->getNamedItem('gif');
43
44    if ($gifNotation === null) {
45        echo "エラー: 記法 'gif' が見つかりませんでした。\n";
46        return;
47    }
48
49    echo "取得した記法ノード名: " . $gifNotation->nodeName . "\n";
50    echo "記法のシステム識別子 (systemId): " . ($gifNotation->systemId ?: 'なし') . "\n";
51
52    // 4. 取得したDOMNotationオブジェクトに対して getRootNode() メソッドを呼び出します。
53    // このメソッドは、この記法ノードが属するXMLドキュメントの最上位のノード（DOMDocumentオブジェクト）を返します。
54    // 引数 $options は、現時点ではほとんどのケースでデフォルト値(0)を使用します。
55    $rootNode = $gifNotation->getRootNode();
56
57    // 5. 返されたノードがDOMDocumentオブジェクトであることを確認し、その情報を出力します。
58    echo "\n--- DOMNotation::getRootNode() が返したノード情報 ---\n";
59    echo "返されたノードのタイプ: " . $rootNode->nodeName . "\n";
60
61    if ($rootNode instanceof DOMDocument) {
62        echo "返されたノードは DOMDocument オブジェクトです。\n";
63        echo "ドキュメントのXMLバージョン: " . $rootNode->xmlVersion . "\n";
64        echo "ドキュメントのエンコーディング: " . $rootNode->xmlEncoding . "\n";
65    } else {
66        echo "返されたノードは DOMDocument オブジェクトではありません。\n";
67    }
68}
69
70// サンプル関数を実行して、DOMNotation::getRootNode() の動作を確認します。
71demonstrateDomNotationGetRootNode();

DOMNotation::getRootNode()メソッドは、XMLのDOCTYPE宣言内で定義される「記法」（NOTATION）を表すDOMNotationオブジェクトが属するXMLドキュメント全体の最上位ノードを取得する際に利用されます。記法は、XMLドキュメント内で外部の非XMLデータを参照する際などに使われる定義です。

このメソッドは、特定のDOMNotationオブジェクトからXMLドキュメントの根幹であるDOMDocumentオブジェクトへアクセスしたい場合に特に役立ちます。引数$optionsは追加の挙動を制御できますが、通常はデフォルト値の0で問題なく動作します。メソッドを実行すると、当該DOMNotationノードを含むXMLツリーのルートにあたるDOMDocumentオブジェクトがDOMNode型として返されます。

サンプルコードでは、XML内に定義された「gif」という記法をDOMNotationオブジェクトとして取得した後、このオブジェクトに対してgetRootNode()メソッドを呼び出しています。その結果、元となるDOMDocumentオブジェクトが正しく取得され、そのXMLバージョンやエンコーディングなどの情報を確認できることを示しています。これにより、ドキュメント内の特定の部分から全体へと容易にたどることが可能になります。