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

Copy
1<?php
2
3/**
4 * DOMCdataSection::childNodes プロパティの使用例。
5 *
6 * DOMCdataSection は、XML/HTML ドキュメント内の CDATA セクションを表します。
7 * CDATA セクションは純粋なテキストデータを保持し、通常は子ノードを持ちません。
8 * この例では、CDATA セクションが空の DOMNodeList を返すことを示します。
9 */
10function demonstrateDomCdataSectionChildNodes(): void
11{
12    // 1. 新しい DOM ドキュメントを作成します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力を整形して読みやすくします。
15    $dom->formatOutput = true;
16
17    // 2. ルート要素 'root' を作成し、ドキュメントに追加します。
18    $root = $dom->createElement('root');
19    $dom->appendChild($root);
20
21    // 3. CDATA セクションに含めるテキスト内容を定義します。
22    // このテキストはマークアップとして解釈されません。
23    $cdataContent = 'This is raw text with <special characters> & "quotes".';
24
25    // 4. DOMCdataSection オブジェクトを作成します。
26    $cdataNode = $dom->createCDATASection($cdataContent);
27
28    // 5. 作成した CDATA セクションをルート要素の子として追加します。
29    $root->appendChild($cdataNode);
30
31    echo "--- 生成された XML ドキュメント ---\n";
32    echo $dom->saveXML();
33    echo "\n";
34
35    echo "--- DOMCdataSection の情報 ---\n";
36    // CDATA セクションの実際のテキスト内容を表示します。
37    echo "CDATA セクションのテキスト内容 (nodeValue): " . $cdataNode->nodeValue . "\n";
38    echo "CDATA セクションのノード名 (nodeName): " . $cdataNode->nodeName . "\n";
39    echo "CDATA セクションのノードタイプ (nodeType): " . $cdataNode->nodeType . " (DOM_CDATA_SECTION_NODE)\n";
40
41    // 6. DOMCdataSection オブジェクトの childNodes プロパティにアクセスします。
42    // DOMCdataSection はテキストノードであるため、子ノードは存在しません。
43    $childNodes = $cdataNode->childNodes;
44
45    echo "CDATA セクションの子ノード数: " . $childNodes->length . "\n";
46
47    // 7. 子ノードリストが空であることを確認します。
48    if ($childNodes->length === 0) {
49        echo "期待通り、DOMCdataSection ノードは子ノードを持ちません。\n";
50        echo "childNodes プロパティは空の DOMNodeList を返しました。\n";
51    } else {
52        echo "エラー: DOMCdataSection ノードに子ノードが見つかりました。\n";
53        foreach ($childNodes as $child) {
54            echo " - 子ノード名: " . $child->nodeName . ", 型: " . $child->nodeType . "\n";
55        }
56    }
57}
58
59// 関数を実行してサンプルコードの動作を確認します。
60demonstrateDomCdataSectionChildNodes();

PHPのDOMCdataSection::childNodesプロパティは、XMLやHTMLドキュメントにおけるCDATAセクションノードの子ノードリストを取得するために使用されます。CDATAセクションとは、その内部のテキストデータがマークアップとして解析されず、特殊な文字を含んでいてもそのままの文字列として扱われる特別な領域のことです。例えば、XMLタグと紛らわしいプログラムコードの断片などを安全にドキュメント内に埋め込む際に利用されます。

このchildNodesプロパティは引数を取らず、そのノードが持つ子ノードのリストをDOMNodeListオブジェクトとして戻り値で返します。しかし、DOMCdataSectionノード自体は純粋なテキストデータのみを保持するノードであり、構造的な子ノードを持つことはありません。

そのため、DOMCdataSectionインスタンスに対してchildNodesプロパティにアクセスすると、常に要素を含まない、つまり長さがゼロの空のDOMNodeListオブジェクトが返されます。サンプルコードでは、新しいDOMDocumentを作成し、CDATAセクションノードを追加した後、このchildNodesプロパティが実際に空のリストを返すことを確認しています。これにより、CDATAセクションが純粋なテキストコンテンツのみを扱い、子ノード構造を持たないという挙動が明確に示されます。

Copy
1<?php
2
3/**
4 * DOMCdataSection クラスとその childNodes プロパティの使用例を示します。
5 * XMLドキュメントからCDATAセクションノードを特定し、
6 * その childNodes プロパティがどのような振る舞いをするかを確認します。
7 *
8 * DOMCdataSection は DOMText の一種であり、その仕様上、子ノードを持つことはありません。
9 * したがって、childNodes プロパティは常に空の DOMNodeList を返します。
10 */
11function demonstrateCdataSectionChildNodes(): void
12{
13    // 1. CDATAセクションを含むXML文字列を作成
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<root>
17    <item id="1">
18        <title>サンプルタイトル</title>
19        <!-- description要素内にCDATAセクションを配置 -->
20        <description><![CDATA[
21            この部分は<b>CDATAセクション</b>です。
22            HTMLタグや特殊文字はエスケープされずにそのまま扱われます。
23            改行も保持されます。
24            <script>alert("Hello!");</script>
25        ]]></description>
26        <notes>これは通常のテキストです。</notes>
27    </item>
28    <item id="2">
29        <title>別のアイテム</title>
30        <description>通常のテキストを含む説明。</description>
31    </item>
32</root>
33XML;
34
35    // 2. DOMDocumentを作成し、XMLをロード
36    $dom = new DOMDocument();
37    // エラーを抑制し、XMLの読み込みを試みる
38    if (!$dom->loadXML($xmlString)) {
39        echo "XMLのロードに失敗しました。" . PHP_EOL;
40        return;
41    }
42    // 整形のための設定 (CDATAセクションの内容には影響しません)
43    $dom->preserveWhiteSpace = false;
44    $dom->formatOutput = true;
45
46    echo "--- ロードされたXMLドキュメント ---" . PHP_EOL;
47    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
48
49    // 3. DOMXPathを作成し、XPathクエリを使用する準備
50    $xpath = new DOMXPath($dom);
51
52    echo "--- CDATAセクションノードの検索と childNodes の確認 ---" . PHP_EOL;
53
54    // XPathを使って、CDATAセクションを含む可能性のある <description> 要素を取得
55    $descriptionElements = $xpath->query('//item/description');
56
57    if ($descriptionElements->length === 0) {
58        echo "XPathクエリ '//item/description' で要素が見つかりませんでした。" . PHP_EOL;
59        return;
60    }
61
62    foreach ($descriptionElements as $element) {
63        echo "現在の親要素: <" . $element->nodeName . ">" . PHP_EOL;
64        echo "  親要素の内容 (textContent): '" . trim($element->textContent) . "'" . PHP_EOL;
65
66        // <description> 要素の子ノードを走査
67        // CDATAセクションはDOMCdataSectionオブジェクトとして扱われます
68        foreach ($element->childNodes as $childNode) {
69            if ($childNode instanceof DOMCdataSection) {
70                echo "  -> DOMCdataSection ノードを発見！" . PHP_EOL;
71                echo "     DOMCdataSection の内容 (nodeValue): '" . trim($childNode->nodeValue) . "'" . PHP_EOL;
72
73                // DOMCdataSection の childNodes プロパティにアクセス
74                $cdataChildNodes = $childNode->childNodes;
75                echo "     DOMCdataSection::childNodes の数: " . $cdataChildNodes->length . PHP_EOL;
76
77                if ($cdataChildNodes->length === 0) {
78                    echo "     (DOMCdataSection ノードは、DOMText の一種であり、仕様上子ノードを持たないため、\n" .
79                         "     childNodes プロパティは常に空の DOMNodeList を返します。)" . PHP_EOL;
80                } else {
81                    // 理論上、このブロックは実行されません
82                    echo "     子ノードが存在します (予期しない動作):" . PHP_EOL;
83                    foreach ($cdataChildNodes as $subChild) {
84                        echo "       - タイプ: " . $subChild->nodeName . ", 値: " . $subChild->nodeValue . PHP_EOL;
85                    }
86                }
87            } elseif ($childNode instanceof DOMText) {
88                // 通常のテキストノードも子ノードを持ちません
89                echo "  -> DOMText ノードを発見！" . PHP_EOL;
90                echo "     DOMText の内容 (nodeValue): '" . trim($childNode->nodeValue) . "'" . PHP_EOL;
91                echo "     DOMText::childNodes の数: " . $childNode->childNodes->length . PHP_EOL;
92            } else {
93                echo "  -> その他のノード: <" . $childNode->nodeName . "> (タイプ: " . $childNode->nodeType . ")" . PHP_EOL;
94            }
95        }
96        echo PHP_EOL;
97    }
98}
99
100// 関数を実行してサンプルコードの動作を確認
101demonstrateCdataSectionChildNodes();

PHP 8では、XML文書を扱うためのDOM拡張機能が提供されており、その中でDOMCdataSectionクラスは、XML内のCDATAセクションという特別なテキストブロックを表します。このDOMCdataSectionクラスが持つchildNodesプロパティは、引数を取らず、そのノードの子ノードをDOMNodeListとして返します。

しかし、DOMCdataSectionはテキストノードの一種であり、HTMLタグのように子要素を持つ構造ではないため、仕様上、子ノードを持つことはありません。したがって、このchildNodesプロパティにアクセスすると、常に要素数ゼロの空のDOMNodeListが戻り値として返されます。

サンプルコードでは、CDATAセクションを含むXML文字列をDOMDocumentに読み込み、DOMXPathを使ってXML内から<description>要素を見つけます。その後、その<description>要素の子ノードを走査し、DOMCdataSection型のノードが見つかった場合に、そのchildNodesプロパティにアクセスしています。コードの実行結果から、DOMCdataSection::childNodesプロパティが常に空のDOMNodeListを返すことを確認でき、DOMCdataSectionノードが子ノードを持たないという特性を理解することができます。