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

Copy
1<?php
2
3/**
4 * Dom\CDATASection クラスの childNodes プロパティの動作を実演する関数。
5 * CDATASection はテキストデータをラップする特殊なノードであり、
6 * その内部に他のDOMノードを持つことはないため、childNodes は常に空のリストを返します。
7 */
8function demonstrateCdataSectionChildNodes(): void
9{
10    // 1. 新しいDOMドキュメントを作成します。
11    // XMLバージョンとエンコーディングを指定します。
12    $dom = new Dom\Document('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力XMLを見やすく整形します。
14
15    // 2. ルート要素を作成し、ドキュメントに追加します。
16    $rootElement = $dom->createElement('document');
17    $dom->appendChild($rootElement);
18
19    // 3. CDATAセクションを作成します。
20    // CDATAセクション内の内容はマークアップとしてパースされず、プレーンテキストとして扱われます。
21    $cdataContent = 'この中に<tag>や&エンティティ;があっても</tag>、テキストとして扱われます。';
22    $cdataSection = $dom->createCDATASection($cdataContent);
23
24    // 4. CDATAセクションをルート要素の子として追加します。
25    $rootElement->appendChild($cdataSection);
26
27    echo "--- 生成されたXMLドキュメント ---\n";
28    echo $dom->saveXML();
29    echo "\n";
30
31    echo "--- Dom\\CDATASection::childNodes の確認 ---\n";
32
33    // 5. 作成したCDATAセクションノードから childNodes プロパティにアクセスします。
34    // このプロパティは、ノードの子ノードを含む DOMNodeList を返します。
35    $childNodes = $cdataSection->childNodes;
36
37    // 6. 取得した DOMNodeList の長さを表示します。
38    echo "Dom\\CDATASection の childNodes の数: " . $childNodes->length . "\n";
39
40    // 7. CDATASection は子ノードを持たないことを確認し、説明を出力します。
41    if ($childNodes->length === 0) {
42        echo "Dom\\CDATASection は子ノードを持たないため、childNodes は空の DOMNodeList を返しました。\n";
43        echo "これは、CDATASection が単一のテキストブロックとして機能し、\n";
44        echo "その中に別の要素やノードを階層的に含む構造ではないためです。\n";
45    } else {
46        echo "予期しない子ノードが見つかりました。これは通常のCDATASecionの動作ではありません。\n";
47    }
48}
49
50// 上記の関数を実行して、Dom\CDATASection::childNodes の動作を確認します。
51demonstrateCdataSectionChildNodes();

Dom\CDATASectionクラスのchildNodesプロパティは、XMLドキュメント内でCDATAセクションとして扱われるノードの子ノード一覧を取得するために使用されます。このプロパティに引数はなく、ノードの子ノードを格納したDOMNodeListオブジェクトを返します。

しかし、CDATAセクションは、その内部のコンテンツをマークアップとして解析せず、純粋なテキストデータとして扱います。つまり、CDATAセクション自体が単一のテキストブロックとして機能し、その中にさらに別のXML要素やノードを階層的に含む構造ではありません。

したがって、Dom\CDATASectionオブジェクトのchildNodesプロパティにアクセスすると、常に子ノードを持たない長さ0のDOMNodeListが返されます。サンプルコードもこの挙動を示しており、CDATAセクションがテキストコンテンツをラップする特殊なノードであり、構造的な子ノードを持たないことを確認できます。この特性は、CDATAセクションの役割を理解する上で重要です。

Copy
1<?php
2
3// DOMDocument のインスタンスを作成します。
4// XML ドキュメントのバージョンとエンコーディングを指定します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6
7// ルート要素 'data' を作成し、DOMDocument に追加します。
8$rootElement = $dom->createElement('data');
9$dom->appendChild($rootElement);
10
11// CDATASection ノードを作成します。
12// CDATASection は、XML パーサーに内部のテキストをそのままの文字データとして扱い、
13// 特殊文字をエスケープしないように指示するために使用されます。
14$cdataContent = "このコンテンツはエスケープされません: <script>alert('Hello');</script>";
15$cdataSection = $dom->createCDATASection($cdataContent);
16
17// 作成した CDATASection をルート要素に追加します。
18$rootElement->appendChild($cdataSection);
19
20// Dom\CDATASection オブジェクトの childNodes プロパティにアクセスします。
21// CDATASection は、その性質上、内部に構造化された子ノード（例: 他の要素やテキストノード）を
22// 持ちません。そのため、childNodes プロパティは常に空の DOMNodeList を返します。
23$childNodesList = $cdataSection->childNodes;
24
25// 取得した DOMNodeList の情報を表示します。
26// DOMNodeList は、ノードのコレクションを表すオブジェクトです。
27echo "Dom\\CDATASection::childNodes の結果:\n";
28echo "戻り値の型: " . get_class($childNodesList) . "\n"; // 戻り値が DOMNodeList であることを示します
29echo "子ノードの数: " . $childNodesList->length . "\n";   // CDATASection に子ノードがないため、通常は 0 となります
30
31?>

PHP 8におけるDom\CDATASection::childNodesプロパティは、XMLドキュメント内のCDATAセクションノードが持つ子ノードのリストを取得するために用いられます。このプロパティは引数を取りません。

CDATASectionとは、XMLパーサーに内部のテキストデータをそのままの文字データとして扱い、HTMLタグなどで使用される特殊文字（例: <や&）をエスケープしないように指示するための特別なノードです。この性質上、CDATASectionの内部には、通常のXML要素やテキストノードのような構造化された子ノードは存在しません。

そのため、Dom\CDATASection::childNodesプロパティにアクセスすると、常に空のDOMNodeListオブジェクトが戻り値として返されます。DOMNodeListはノードのコレクションを表すオブジェクトですが、CDATASectionにおいてはそのlengthプロパティが常に0となります。

サンプルコードでは、DOMDocumentを作成し、エスケープされないコンテンツを含むCDATASectionノードを追加しています。その後、このCDATASectionオブジェクトのchildNodesプロパティにアクセスすることで、戻り値がDOMNodeList型であり、かつ子ノードの数が0であることを確認しています。これは、CDATASectionの特性と、それに対するchildNodesプロパティの挙動を示すものです。