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

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成します。
4// XML/HTMLドキュメントの構造を操作するために使用します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true; // 出力を整形して読みやすくします。
7
8// ルート要素 'data' を作成し、DOMドキュメントに追加します。
9$root = $dom->createElement('data');
10$dom->appendChild($root);
11
12// CDATASectionの直前の兄弟ノードとなる要素 'info' を作成します。
13// この要素はCDATASectionの前に配置されます。
14$precedingElement = $dom->createElement('info', 'これはCDATAセクションの直前の情報です。');
15$root->appendChild($precedingElement);
16
17// CDATASectionノードを作成します。
18// CDATASectionは、特殊文字（<、>、&など）がエスケープされずにそのまま含まれるテキストブロックです。
19// リファレンス情報ではDom\CDATASectionとありますが、現在のPHP 8標準環境ではDOMCDATASectionクラスが利用されます。
20$cdataSection = $dom->createCDATASection('特別なデータ <XMLタグ> & エスケープされません。');
21$root->appendChild($cdataSection);
22
23// 作成したCDATASectionノードの previousSibling プロパティにアクセスします。
24// previousSibling は、現在のノードの直前の兄弟ノードを返します。
25// 直前の兄弟ノードが存在しない場合は null を返します。
26$previousSibling = $cdataSection->previousSibling;
27
28// 取得した previousSibling ノードが DOMNode のインスタンスであるか確認します。
29// リファレンス情報ではDom\Nodeを返すとありますが、現在のPHP 8ではDOMNodeが返されます。
30if ($previousSibling instanceof DOMNode) {
31    echo "CDATASectionの直前の兄弟ノードが見つかりました。\n";
32    echo "ノード名: " . $previousSibling->nodeName . "\n";
33    echo "ノード値: " . $previousSibling->nodeValue . "\n";
34    // ノードタイプを表示することで、それが要素ノード（DOMElement）であることがわかります。
35    echo "ノードタイプ: " . $previousSibling->nodeType . " (" . $previousSibling->nodeTypeToString() . ")\n";
36} else {
37    echo "CDATASectionの直前の兄弟ノードは見つかりませんでした。\n";
38    echo "これは、CDATASectionが親ノードの最初の子である場合などに発生します。\n";
39}

PHPのDom\CDATASection::previousSiblingプロパティは、XMLやHTMLなどのDOMツリーにおいて、現在のCDATAセクションノードの直前にある兄弟ノードを取得するために使用されます。このプロパティは引数を持ちません。戻り値は直前の兄弟ノードがDom\Node（PHP 8標準環境ではDOMNodeクラスのインスタンス）として返されるか、直前の兄弟ノードが存在しない場合はnullとなります。

サンプルコードではまず、DOMDocumentを作成し、XML構造の土台を準備します。次に、CDATAセクションの直前の兄弟ノードとなるinfo要素と、XMLタグなどの特殊文字がエスケープされずにそのまま含まれる特別なテキストデータを扱うためのCDATASectionノードを生成し、ドキュメントに追加します。

その後、$cdataSection->previousSiblingにアクセスすることで、直前の兄弟ノードを取得します。取得したノードがDOMNodeのインスタンスであれば、そのノードの名前や値、タイプを表示します。この例では、info要素が直前の兄弟ノードとして取得され、その内容が表示されることを確認できます。もし直前の兄弟ノードが存在しない場合（例えば、CDATAセクションが親ノードの最初の子である場合など）は、nullが返され、その旨が表示されます。このプロパティを利用することで、DOMツリー内のノード間の位置関係を簡単に調べることができます。

Copy
1<?php
2
3// このスクリプトは、PHP 8のDom\CDATASectionクラスのpreviousSiblingプロパティの使用例を示します。
4// previousSiblingプロパティは、現在のノードの直前の兄弟ノードを返します。
5// 直前の兄弟ノードが存在しない場合はnullを返します。
6
7// 1. 新しいDOMドキュメントを作成します。
8// XMLバージョン1.0、エンコーディングUTF-8を指定します。
9$dom = new DOMDocument('1.0', 'UTF-8');
10// 出力を整形するために設定します。これは必須ではありませんが、生成されるXMLが見やすくなります。
11$dom->formatOutput = true;
12
13// 2. ルート要素を作成し、DOMドキュメントに追加します。
14$rootElement = $dom->createElement('root');
15$dom->appendChild($rootElement);
16
17// 3. CDATASectionノードの直前の兄弟となる要素を作成し、ルート要素に追加します。
18// この'dataDescription'要素が、後で取得するCDATASectionの直前の兄弟ノードになります。
19$siblingElement = $dom->createElement('dataDescription', 'この要素はCDATASectionの直前の兄弟です。');
20$rootElement->appendChild($siblingElement);
21
22// 4. CDATASectionノードを作成し、ルート要素に追加します。
23// CDATASectionは、内部のマークアップ（例: <raw_data>）がXMLとしてパースされずに、
24// 単なるテキストデータとして扱われる特殊なXMLセクションです。
25$cdataContent = '<?xml version="1.0"?><raw_data>これはCDATA内の生データです。</raw_data>';
26$cdataSection = $dom->createCDATASection($cdataContent);
27$rootElement->appendChild($cdataSection);
28
29// 5. 構築されたXMLドキュメントの内容を表示して確認します。
30echo "--- 構築されたXMLドキュメント ---\n";
31echo $dom->saveXML() . "\n\n";
32
33// 6. Dom\CDATASectionオブジェクトのpreviousSiblingプロパティを使用して、
34//    直前の兄弟ノードを取得します。
35//    このプロパティはDom\Nodeオブジェクト、または直前の兄弟が存在しない場合はnullを返します。
36$previousSiblingNode = $cdataSection->previousSibling;
37
38echo "--- CDATASectionのpreviousSiblingプロパティの確認 ---\n";
39
40// 7. 取得した兄弟ノードが存在するかどうかを確認し、その情報を表示します。
41if ($previousSiblingNode !== null) {
42    echo "CDATASectionの直前の兄弟ノードが見つかりました。\n";
43    echo "  ノード名 (nodeName): " . $previousSiblingNode->nodeName . "\n";
44    echo "  ノードタイプ (nodeType): " . $previousSiblingNode->nodeType . " (例: 1 は要素ノード、3 はテキストノード)\n";
45    echo "  ノード値 (nodeValue): " . $previousSiblingNode->nodeValue . "\n";
46
47    // もし取得したノードがDom\Element（要素ノード）であれば、タグ名も表示します。
48    // Dom\ElementはDom\Nodeを継承した、XML/HTMLの要素を表すクラスです。
49    if ($previousSiblingNode instanceof Dom\Element) {
50        echo "  タグ名 (tagName、要素の場合): " . $previousSiblingNode->tagName . "\n";
51    }
52} else {
53    // この例では`dataDescription`要素が直前の兄弟として存在するはずなので、
54    // ここは実行されませんが、CDATASectionが親ノードの最初の子であった場合はnullが返されます。
55    echo "CDATASectionの直前の兄弟ノードは見つかりませんでした。\n";
56}
57
58?>

このサンプルコードは、PHP 8のDom\CDATASectionクラスが持つpreviousSiblingプロパティの使用例を示しています。このプロパティは、XMLドキュメント内で特定のDom\CDATASectionノードの直前にある兄弟ノードを取得するために利用されます。兄弟ノードとは、同じ親ノードを共有する隣接したノードのことです。

previousSiblingプロパティにアクセスすると、現在のDom\CDATASectionノードの直前の兄弟ノードがDom\Nodeオブジェクトとして返されます。もし直前に兄弟ノードが存在しない、つまり現在のノードが親の最初の子ノードである場合は、このプロパティはnullを返します。

コードでは、まず新しいDOMドキュメントを作成し、ルート要素とその子ノードとして、通常の要素（dataDescription）とCDATASectionノードの順で追加しています。この構成により、CDATASectionノードの直前にはdataDescription要素が存在する状態になります。その後、CDATASectionオブジェクトのpreviousSiblingプロパティにアクセスすることで、dataDescription要素がDom\Nodeオブジェクトとして正確に取得される様子を確認できます。取得されたノードのnodeNameやnodeValueなどの情報が表示され、それが期待通りの直前の兄弟ノードであることがわかります。このプロパティは、DOMツリーを走査し、ノード間の関連性を理解する上で非常に有用です。