【PHP8.x】DOMCdataSection::previousElementSiblingプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMCdataSection の previousElementSibling プロパティの動作を示す関数です。
5 *
6 * このプロパティは、現在のノードの直前の「要素」兄弟ノードを返します。
7 * テキストノードやコメントノードは無視されます。
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、DOM 操作の基本的な流れと
9 * previousElementSibling の利用方法を示します。
10 */
11function demonstrateCdataPreviousElementSibling(): void
12{
13    // 新しい DOM ドキュメントを作成します
14    $dom = new DOMDocument();
15
16    // サンプル XML をロードします。
17    // ここでは、CDATA セクションの前に <item> 要素が存在する構造を作成しています。
18    $xmlString = '
19        <document>
20            <header>ドキュメントヘッダー</header>
21            <item id="first_item">最初のアイテムの内容</item>
22            <![CDATA[これは特殊文字 < や & を含む CDATA セクションです。]]>
23            <footer>ドキュメントフッター</footer>
24        </document>
25    ';
26    $dom->loadXML($xmlString);
27
28    // ルート要素 (ここでは <document>) の子ノードを走査し、
29    // DOMCdataSection 型のノードを探します。
30    $cdataNode = null;
31    foreach ($dom->documentElement->childNodes as $node) {
32        if ($node instanceof DOMCdataSection) {
33            $cdataNode = $node;
34            break; // 最初に見つかった CDATA セクションを使用
35        }
36    }
37
38    if ($cdataNode) {
39        echo "--- CDATA セクション情報 ---\n";
40        echo "見つかった CDATA セクションのデータ: " . $cdataNode->data . "\n\n";
41
42        // previousElementSibling プロパティを使用して、
43        // 直前の「要素」兄弟ノードを取得します。
44        // テキストノード、コメントノードなどはスキップされます。
45        $previousElement = $cdataNode->previousElementSibling;
46
47        echo "--- previousElementSibling の結果 ---\n";
48        if ($previousElement instanceof DOMElement) {
49            echo "直前の要素ノードが見つかりました。\n";
50            echo "そのタグ名: " . $previousElement->tagName . "\n";
51            echo "そのテキストコンテンツ: " . $previousElement->textContent . "\n";
52            // 要素ノードであれば、属性も取得できます
53            echo "そのID属性: " . $previousElement->getAttribute('id') . "\n";
54        } else {
55            echo "直前の要素ノードは見つかりませんでした (null)。\n";
56            echo "これは、CDATA セクションが最初の兄弟ノードである場合や、\n";
57            echo "直前に要素以外のノード（例: テキストノード、コメントノード）しかない場合に発生します。\n";
58        }
59    } else {
60        echo "サンプル XML 内に CDATA セクションが見つかりませんでした。\n";
61    }
62}
63
64// 上記で定義した関数を実行し、動作を確認します
65demonstrateCdataPreviousElementSibling();

PHPのDOMCdataSection::previousElementSiblingプロパティは、XMLやHTMLドキュメント内で特定のCDATAセクションノードの直前にある「要素（Element）」タイプの兄弟ノードを取得するために使用されます。このプロパティは引数を取りません。

戻り値は、直前の兄弟ノードが要素ノードである場合はDOMElementオブジェクトを返します。しかし、直前の兄弟ノードがテキストノード、コメントノードなど要素以外のノードである場合や、現在のノードが最初の兄弟ノードである場合にはnullを返します。つまり、要素ノードだけを対象とし、他のノードタイプは無視して検索が進められる点が特徴です。

サンプルコードでは、<item>要素の後にCDATAセクションが続くXML構造を用意しています。CDATAセクションノードを見つけた後、そのpreviousElementSiblingプロパティを使用すると、直前の兄弟ノードである<item>要素が取得され、そのタグ名やテキストコンテンツなどが表示される動作を確認できます。これにより、特定のデータを持つノードの前にある構造的な要素を効率的に特定することが可能です。

Copy
1<?php
2
3/**
4 * DOMCdataSection::previousElementSibling の使用例を示します。
5 * このプロパティは、現在のCDATAセクションノードの直前にある要素兄弟ノードを返します。
6 * テキストノードやコメントノードはスキップされます。
7 */
8function demonstratePreviousElementSibling(): void
9{
10    // 1. XML文字列を定義します。
11    // CDATAセクションの前にDOMElementノードが存在するように配置します。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<document>
15    <header>これはドキュメントのヘッダー要素です。</header>
16    <![CDATA[これはCDATAセクションです。XMLパーサによる内容の解析を防ぎます。]]>
17    <main>これはメインコンテンツの要素です。</main>
18    <!-- これは無視されるべきコメントノードです -->
19    <footer>これはフッター要素です。</footer>
20</document>
21XML;
22
23    // 2. DOMDocumentインスタンスを作成します。
24    $dom = new DOMDocument();
25    // スペースや改行がDOMTextノードとして扱われないように設定します。
26    // これにより、previousElementSiblingの動作がより明確になります。
27    $dom->preserveWhiteSpace = false;
28    $dom->formatOutput = true; // 出力整形を有効にします (ここではDOMの出力には使いませんが、一般的な設定です)
29
30    // 3. XML文字列をDOMDocumentにロードします。
31    $dom->loadXML($xmlString);
32
33    echo "--- DOMCdataSection::previousElementSibling のデモンストレーション ---\n";
34
35    // 4. ドキュメント内のCDATAセクションノードを検索します。
36    // 簡単のため、ルート要素の子ノードを直接走査します。
37    $cdataNode = null;
38    if ($dom->documentElement) { // ルート要素が存在することを確認
39        foreach ($dom->documentElement->childNodes as $node) {
40            if ($node instanceof DOMCdataSection) {
41                $cdataNode = $node;
42                break;
43            }
44        }
45    }
46
47    if ($cdataNode) {
48        echo "\nCDATAセクションノードが見つかりました。\n";
49        echo "  ノード名: " . $cdataNode->nodeName . "\n";
50        echo "  ノード値の抜粋: " . substr($cdataNode->nodeValue, 0, 50) . "...\n";
51
52        // 5. previousElementSiblingプロパティにアクセスします。
53        // このプロパティは、現在のノードの直前の兄弟ノードのうち、
54        // DOMElement型のノードのみを返します。
55        // 直前の兄弟がテキストノードやコメントノードの場合はそれらをスキップします。
56        $previousElement = $cdataNode->previousElementSibling;
57
58        echo "\nCDATAセクションの 'previousElementSibling' を確認します。\n";
59
60        if ($previousElement instanceof DOMElement) {
61            echo "  前の要素兄弟が見つかりました。\n";
62            echo "  要素名: " . $previousElement->nodeName . "\n";
63            echo "  要素のテキストコンテンツ: " . $previousElement->textContent . "\n";
64        } else {
65            echo "  前の要素兄弟は見つかりませんでした (null が返されました)。\n";
66            echo "  これは、前の兄弟ノードが存在しないか、前の兄弟ノードがDOMElement型ではない場合に発生します。\n";
67        }
68
69        // (参考情報) previousSiblingプロパティとの比較
70        // previousSiblingは、直前の兄弟ノードのタイプに関わらず、最初に見つかった兄弟ノードを返します。
71        $previousSibling = $cdataNode->previousSibling;
72        if ($previousSibling) {
73            echo "\n(参考) CDATAセクションの 'previousSibling' (要素に限らない) を確認します。\n";
74            echo "  前の兄弟ノードのタイプ: " . $previousSibling->nodeName . " (DOM_NODE_TYPE: " . $previousSibling->nodeType . ")\n";
75            if ($previousSibling instanceof DOMElement) {
76                echo "  前の兄弟ノードはDOMElementです。\n";
77            } elseif ($previousSibling instanceof DOMText) {
78                echo "  前の兄弟ノードはDOMTextです。値 (空白を含む可能性あり): '" . str_replace(["\n", "\r"], ['\\n', '\\r'], $previousSibling->nodeValue) . "'\n";
79            }
80        }
81    } else {
82        echo "ドキュメント内でCDATAセクションが見つかりませんでした。\n";
83    }
84
85    echo "\n--- デモンストレーション終了 ---\n";
86}
87
88// 関数を実行して、previousElementSiblingの動作を確認します。
89demonstratePreviousElementSibling();
90
91?>

PHP 8のDOMCdataSection::previousElementSiblingプロパティは、現在のCDATAセクションノードの直前にある「要素」タイプの兄弟ノードを取得するために利用されます。このプロパティは引数を取りません。

その特徴は、直前の兄弟ノードがテキストノードやコメントノードなど、DOMElement型ではない場合にそれらをスキップし、次に直前にあるDOMElement型のノードを返す点にあります。もし、直前に要素兄弟ノードが見つからない場合は、nullを返します。これにより、ドキュメントの構造から要素だけを選んで効率的に探索できます。

例えば、XML文書内でCDATAセクションの直前にテキストノードや改行、コメントノードがあっても、それらを無視して、そのさらに前にある要素ノードに直接アクセスすることが可能です。この挙動は、JavaScriptの同名プロパティと類似しており、要素間の移動をより簡潔に記述できます。

previousSiblingプロパティが直前のあらゆる種類の兄弟ノードを対象とするのに対し、previousElementSiblingは要素ノードに限定して検索するため、DOMツリーを要素単位で走査する際に非常に便利です。このプロパティを活用することで、XMLやHTMLのDOM操作がより直感的になります。