【PHP8.x】Dom\CDATASection::nextSiblingプロパティの使い方

Copy
1<?php
2
3/**
4 * Dom\CDATASection の nextSibling プロパティの使用例を示す関数です。
5 *
6 * この関数は、XML ドキュメントをプログラムで構築し、
7 * Dom\CDATASection ノードの次の兄弟ノードを取得する方法を実演します。
8 * システムエンジニアを目指す初心者の方にも分かりやすいよう、
9 * CDATA セクションと通常の要素を兄弟として配置し、
10 * nextSibling プロパティの挙動を確認します。
11 */
12function demonstrateCdataNextSibling(): void
13{
14    // 1. 新しい DOM ドキュメントを作成します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力を整形して見やすくします。
17    $dom->formatOutput = true;
18
19    // 2. ルート要素 <root> を作成し、ドキュメントに追加します。
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // 3. 親要素 <container> を作成し、ルート要素に追加します。
24    $container = $dom->createElement('container');
25    $root->appendChild($container);
26
27    // 4. Dom\CDATASection ノードを作成し、<container> に追加します。
28    //    CDATAセクション内のテキストはマークアップとして解釈されません。
29    $cdataNode = $dom->createCDATASection('これはCDATAセクション内のデータです。特殊文字 <>& もエスケープされません。');
30    $container->appendChild($cdataNode);
31
32    // 5. CDATAセクションの「次の兄弟」となる要素 <nextSiblingElement> を作成し、<container> に追加します。
33    //    このノードが $cdataNode の nextSibling となります。
34    $nextSiblingElement = $dom->createElement('nextSiblingElement', '私はCDATAセクションの次の兄弟要素です。');
35    $container->appendChild($nextSiblingElement);
36
37    // 6. さらに別の要素 <anotherElement> を追加します。
38    //    これは $nextSiblingElement の次の兄弟となりますが、$cdataNode の次の兄弟ではありません。
39    $anotherElement = $dom->createElement('anotherElement', '私はその次の要素です。');
40    $container->appendChild($anotherElement);
41
42    echo "--- 生成されたXMLドキュメントの構造 ---\n";
43    echo $dom->saveXML();
44    echo "----------------------------------------\n\n";
45
46    // 7. $cdataNode の nextSibling プロパティにアクセスし、次の兄弟ノードを取得します。
47    //    戻り値は Dom\Node オブジェクトか、兄弟ノードが存在しない場合は null です。
48    $foundSibling = $cdataNode->nextSibling;
49
50    echo "CDATAセクションの次の兄弟ノードを検索中...\n";
51
52    if ($foundSibling instanceof Dom\Node) {
53        // 次の兄弟ノードが見つかった場合、その情報を表示します。
54        echo "見つかりました！\n";
55        echo "  ノード名: " . $foundSibling->nodeName . "\n";
56        // ノードタイプは数値で返されるため、定数と比較すると分かりやすいです。
57        echo "  ノードタイプ: " . $foundSibling->nodeType . " (XML_ELEMENT_NODE = " . XML_ELEMENT_NODE . ")\n";
58        echo "  ノード値: " . $foundSibling->nodeValue . "\n";
59    } else {
60        // 次の兄弟ノードが見つからなかった場合。
61        echo "次の兄弟ノードは見つかりませんでした。\n";
62    }
63
64    echo "\n--- nextSibling が null を返すケースの例 ---\n";
65
66    // CDATAセクションが親要素内の最後のノードである場合の例を作成します。
67    $dom2 = new DOMDocument('1.0', 'UTF-8');
68    $root2 = $dom2->createElement('root2');
69    $dom2->appendChild($root2);
70    $cdataNodeOnly = $dom2->createCDATASection('私は親要素の最後のCDATAです。');
71    $root2->appendChild($cdataNodeOnly);
72
73    echo $dom2->saveXML();
74    echo "------------------------------------------\n\n";
75
76    $foundSiblingOnly = $cdataNodeOnly->nextSibling;
77
78    echo "最後のCDATAセクションの次の兄弟ノードを検索中...\n";
79    if ($foundSiblingOnly instanceof Dom\Node) {
80        echo "見つかりました！ノード名: " . $foundSiblingOnly->nodeName . "\n";
81    } else {
82        echo "次の兄弟ノードは見つかりませんでした。(期待通り、nullが返されました)\n";
83    }
84}
85
86// 関数を実行して動作を確認します。
87demonstrateCdataNextSibling();

PHP 8のDom\CDATASection::nextSiblingプロパティは、XMLドキュメント内で特定のCDATAセクションノードの直後に位置する「次の兄弟ノード」を取得するために使用されます。このプロパティには引数がなく、現在のCDATAセクションノードの親要素内に次の兄弟ノードが存在する場合、そのDom\Nodeオブジェクトを戻り値として返します。もし次の兄弟ノードが存在しない場合はnullを返します。

このサンプルコードでは、まずDOMドキュメントを作成し、container要素内にDom\CDATASectionノードと、その後に続くnextSiblingElement要素を追加しています。これにより、Dom\CDATASectionノードの次の兄弟としてnextSiblingElementが存在する状態を作り出しています。$cdataNode->nextSiblingにアクセスすると、nextSiblingElementがDom\Nodeオブジェクトとして取得され、そのノード名やタイプ、値が表示されることを確認できます。

また、コードの後半では、CDATAセクションが親要素内の最後のノードである場合にnextSiblingプロパティがnullを返す例も示されており、プロパティの正確な挙動が理解できます。このように、nextSiblingプロパティは、XMLツリー構造内でのノード間の順序関係をプログラムでナビゲートする際に非常に有用です。