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

Copy
1<?php
2
3/**
4 * DOMCharacterData::getRootNode() メソッドの使用例
5 *
6 * この関数は、DOMTextノード（DOMCharacterDataのサブクラス）を作成し、
7 * それが属するドキュメントのルートノードを取得します。
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、
9 * シンプルなXMLドキュメントの構築と検証を行います。
10 */
11function demonstrateGetRootNode(): void
12{
13    // 1. 新しいDOMDocumentオブジェクトを作成
14    //    このオブジェクトがドキュメントツリーのルートになります。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力されるXMLを見やすくするための設定
17    $dom->formatOutput = true; 
18
19    echo "--- ドキュメントツリーの構築 ---\n";
20
21    // 2. ルート要素を作成し、ドキュメントに追加
22    //    例: <root>
23    $rootElement = $dom->createElement('root');
24    $dom->appendChild($rootElement);
25    echo "  - '<root>' 要素を追加しました。\n";
26
27    // 3. 子要素を作成し、ルート要素に追加
28    //    例: <message>
29    $childElement = $dom->createElement('message');
30    $rootElement->appendChild($childElement);
31    echo "  - '<message>' 要素を追加しました。\n";
32
33    // 4. テキストノードを作成し、子要素に追加
34    //    DOMTextクラスはDOMCharacterDataクラスを継承しています。
35    //    例: <message>こんにちは、PHPの世界！</message>
36    $textNode = $dom->createTextNode('こんにちは、PHPの世界！');
37    $childElement->appendChild($textNode);
38    echo "  - テキストノード: '" . $textNode->nodeValue . "' を追加しました。\n";
39    echo "    このノードのクラス: " . get_class($textNode) . "\n\n";
40
41    echo "--- getRootNode() の使用 ---\n";
42
43    // 5. 作成したテキストノードから getRootNode() を呼び出す
44    //    このメソッドは、ノードが属するドキュメントツリーの最上位ノード（ルートノード）を返します。
45    //    通常、それはDOMDocumentオブジェクトそのものです。
46    $returnedRootNode = $textNode->getRootNode();
47
48    echo "getRootNode() が返したノードのクラス: " . get_class($returnedRootNode) . "\n";
49    // DOMDocumentのnodeNameは '#document' となります。
50    echo "getRootNode() が返したノードの名前: " . $returnedRootNode->nodeName . "\n";
51
52    // 6. 返されたノードが期待通り DOMDocument オブジェクトであることを検証
53    if ($returnedRootNode instanceof DOMDocument) {
54        echo "結果: getRootNode() は正しく DOMDocument オブジェクトを返しました。\n";
55
56        // さらに、それが元の $dom オブジェクトと同一のインスタンスであることも確認
57        if ($returnedRootNode === $dom) {
58            echo "結果: 返されたルートノードは、元の DOMDocument オブジェクトと同一のインスタンスです。\n";
59        } else {
60            echo "警告: 返されたルートノードは DOMDocument ですが、元のオブジェクトと同一ではありません。\n";
61        }
62    } else {
63        echo "エラー: getRootNode() は DOMDocument 以外のオブジェクトを返しました。\n";
64    }
65
66    echo "\n--- 最終的なドキュメントのXML表現 ---\n";
67    echo $dom->saveXML();
68}
69
70// サンプルコードを実行します
71demonstrateGetRootNode();
72

DOMCharacterData::getRootNode()メソッドは、XMLドキュメントの構造を表すDOM（Document Object Model）ツリーにおいて、任意のノードから、そのノードが属するドキュメントの最上位ノード（ルートノード）を取得するために利用されます。このメソッドはDOMCharacterDataクラスに属しており、具体的なテキストデータなどを扱うDOMTextノード（DOMCharacterDataを継承）などから呼び出すことができます。

引数?array $options = nullはオプションであり、通常は指定する必要はありません。このメソッドは、呼び出されたノードのルートノードをDOMNodeオブジェクトとして返します。多くの場合、これはXMLドキュメント全体を管理するDOMDocumentオブジェクトそのものです。

サンプルコードでは、最初に新しいDOMDocumentオブジェクトを作成し、これに<root>要素、<message>要素、そして「こんにちは、PHPの世界！」というテキストノードを順番に追加してXMLドキュメントの構造を構築しています。このテキストノードはDOMTextクラスのインスタンスであり、DOMCharacterDataクラスを継承しています。

次に、このテキストノードからgetRootNode()メソッドを呼び出しています。これにより、構築されたドキュメントツリーの最上位であるDOMDocumentオブジェクトが正確に取得されます。サンプルコードでは、返されたノードが期待通りDOMDocumentのインスタンスであり、最初に作成したDOMDocumentオブジェクトと同一のインスタンスであることも検証しており、どのノードからでもドキュメント全体の管理オブジェクトへアクセスできることを示しています。

Copy
1<?php
2
3/**
4 * DOMCharacterData::getRootNode() メソッドの使用例
5 *
6 * この関数は、DOMツリー内のテキストノード（DOMCharacterDataの子クラス）から
7 * getRootNode() メソッドを使用してツリーのルートノードを取得する方法を示します。
8 * 通常、DOMツリーのルートノードは DOMDocument オブジェクトになります。
9 */
10function demonstrateDomCharacterDataGetRootNode(): void
11{
12    // 1. DOMDocument オブジェクトを作成
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 出力を見やすく整形
15
16    // 2. ルート要素を作成し、DOMDocumentに追加
17    $rootElement = $dom->createElement('exampleRoot');
18    $dom->appendChild($rootElement);
19
20    // 3. テキストノードを作成し、ルート要素に追加
21    // DOMText は DOMCharacterData の具象クラスです。
22    $textNode = $dom->createTextNode('Hello, PHP DOM world!');
23    $rootElement->appendChild($textNode);
24
25    // 4. テキストノード（DOMCharacterData型）から getRootNode() を呼び出す
26    // 引数 ?array $options は通常 null を指定します。
27    $rootNode = $textNode->getRootNode();
28
29    echo "--- DOMText ノードからの getRootNode() ---" . PHP_EOL;
30    echo "返されたノードのクラス: " . get_class($rootNode) . PHP_EOL;
31
32    // 5. 取得したルートノードが期待通り DOMDocument のインスタンスか確認
33    if ($rootNode instanceof DOMDocument) {
34        echo "-> 取得したノードは DOMDocument のインスタンスです。" . PHP_EOL;
35        // 取得したルートノードが、最初に作成した $dom オブジェクトと同一であるか確認
36        if ($rootNode === $dom) {
37            echo "-> 取得したノードは、元の DOMDocument オブジェクトと同一です。" . PHP_EOL;
38        } else {
39            echo "-> エラー: 取得したノードは、元の DOMDocument オブジェクトとは異なります。" . PHP_EOL;
40        }
41    } else {
42        echo "-> エラー: 取得したノードは DOMDocument のインスタンスではありません。" . PHP_EOL;
43    }
44
45    echo PHP_EOL;
46
47    // 別の DOMCharacterData の子クラスである DOMComment でも試す
48    $commentNode = $dom->createComment('これはコメントノードです。');
49    $rootElement->appendChild($commentNode);
50
51    $rootNodeFromComment = $commentNode->getRootNode();
52
53    echo "--- DOMComment ノードからの getRootNode() ---" . PHP_EOL;
54    echo "返されたノードのクラス: " . get_class($rootNodeFromComment) . PHP_EOL;
55
56    if ($rootNodeFromComment instanceof DOMDocument) {
57        echo "-> 取得したノードは DOMDocument のインスタンスです。" . PHP_EOL;
58        if ($rootNodeFromComment === $dom) {
59            echo "-> 取得したノードは、元の DOMDocument オブジェクトと同一です。" . PHP_EOL;
60        }
61    }
62}
63
64// 関数を実行してサンプルコードの動作を示す
65demonstrateDomCharacterDataGetRootNode();
66

PHPのDOMCharacterData::getRootNode()メソッドは、DOM（Document Object Model）ツリー内の任意の文字データノードから、そのノードが属するドキュメントの最上位ノード（ルートノード）を取得するために利用されます。DOMCharacterDataは、DOMText（テキスト内容）やDOMComment（コメント）など、XMLやHTMLドキュメント内で文字データを保持するノードの抽象基底クラスです。

このメソッドは?array $options = nullというオプション引数を持ちますが、通常はnullを指定し、特別な設定は不要です。戻り値はDOMNode型であり、通常はDOMツリー全体を表現するDOMDocumentオブジェクトが返されます。

サンプルコードでは、DOMDocumentを生成し、その中にDOMElement、DOMTextノード、DOMCommentノードを配置してDOMツリーを構築しています。その後、作成したDOMTextノードやDOMCommentノード（どちらもDOMCharacterDataの子孫です）からgetRootNode()を呼び出しています。これにより、どの文字データノードから呼び出しても、最初に作成したDOMDocumentオブジェクトが正確にルートノードとして取得されることが確認できます。このメソッドは、特定のノードがどのドキュメントに属しているかを簡単に判断したい場合に役立ちます。