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

Copy
1<?php
2
3// DomDocument を作成
4$dom = new DOMDocument();
5
6// CDATA セクションを含む XML 文字列をロード
7$dom->loadXML('<root><![CDATA[Hello, World!]]></root>');
8
9// CDATA セクションを取得
10$cdata = $dom->documentElement->firstChild;
11
12// textContent プロパティを使用してテキストコンテンツを取得
13$textContent = $cdata->textContent;
14
15// 結果を出力
16echo $textContent . PHP_EOL; // Hello, World!
17
18?>

PHPのDOM拡張におけるDom\CDATASectionクラスのtextContentプロパティは、CDATAセクションのテキストコンテンツを取得するために使用します。このプロパティは引数を必要としません。戻り値はstring型、もしくはテキストコンテンツが存在しない場合はnullを許容する?string型となります。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、CDATAセクションを含むXML文字列をロードしています。loadXML()メソッドを使ってXMLを読み込み、ルート要素の子ノード（CDATAセクション）を取得します。そして、取得したCDATAセクションオブジェクトに対してtextContentプロパティにアクセスすることで、CDATAセクション内のテキストコンテンツを取得できます。

この例では、CDATAセクションの内容が"Hello, World!"であるため、$cdata->textContentは"Hello, World!"という文字列を返します。最後に、echo文でこのテキストコンテンツを出力しています。textContentプロパティを使うことで、XMLドキュメント内のCDATAセクションから簡単にテキストデータを取り出すことができます。

Copy
1<?php
2
3/**
4 * Dom\CDATASection の textContent プロパティと nodeValue プロパティの比較をデモンストレーションします。
5 *
6 * システムエンジニアを目指す初心者向けに、Dom\CDATASection が含まれる要素に対して
7 * これらのプロパティがどのように振る舞うかを明確に示します。
8 */
9function demonstrateCdataTextContentComparison(): void
10{
11    // XML ドキュメントを新規作成し、出力整形を有効にします。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true;
14
15    // ルート要素 <data> を作成し、ドキュメントに追加します。
16    $rootElement = $dom->createElement('data');
17    $dom->appendChild($rootElement);
18
19    // CDATASection に含める文字列（XML特殊文字を含む）を定義します。
20    // CDATASection は、XML パーサーがマークアップとして解釈しない生テキストを格納するために使用されます。
21    $cdataContent = '<script>alert("Hello & World <tag>");</script>';
22
23    // DOMCDATASection ノードを作成します。
24    $cdataNode = $dom->createCDATASection($cdataContent);
25
26    // CDATASection ノードをルート要素の子として追加します。
27    $rootElement->appendChild($cdataNode);
28
29    // 生成された XML を出力して、構造を確認します。
30    echo "--- 生成された XML ---\n";
31    echo $dom->saveXML();
32    echo "\n";
33
34    echo "--- Dom\\CDATASection ノード自体へのアクセス ---\n";
35    // CDATASection ノードの nodeValue は、そのCDATAセクションの生のコンテンツを返します。
36    echo "CDATASection::nodeValue:   " . $cdataNode->nodeValue . "\n";
37    // CDATASection ノードの textContent も、そのCDATAセクションの生のコンテンツを返します。
38    // CDATASection ノードの場合、nodeValue と textContent は通常同じ内容を返します。
39    echo "CDATASection::textContent: " . $cdataNode->textContent . "\n";
40    echo "（Dom\\CDATASection ノードの場合、nodeValue と textContent は同じ内容を返します。）\n\n";
41
42    echo "--- CDATASection を含む親要素 (Dom\\Element) へのアクセス ---\n";
43    // 親要素 (Dom\Element) の nodeValue は通常 null です。
44    // nodeValue は要素ノード自体にはテキスト値がないためです。
45    echo "Parent Element::nodeValue:   " . ($rootElement->nodeValue === null ? 'null' : $rootElement->nodeValue) . " (要素ノードの nodeValue は通常 null です)\n";
46    // 親要素 (Dom\Element) の textContent は、その要素のすべての子孫テキストノード（CDATASectionも含む）を連結した値を返します。
47    echo "Parent Element::textContent: " . $rootElement->textContent . "\n";
48    echo "（Dom\\Element ノードの場合、nodeValue は null ですが、textContent はすべての子孫テキストノードの連結された値を返します。）\n\n";
49}
50
51// 関数を実行してデモンストレーションを開始します。
52demonstrateCdataTextContentComparison();

このサンプルコードは、PHPのDOM拡張を用いて、Dom\CDATASectionオブジェクトのtextContentプロパティとnodeValueプロパティの挙動の違いを解説するものです。Dom\CDATASectionは、XMLドキュメント内でエスケープ処理されないテキストを扱う際に使用します。

まず、DOMDocumentオブジェクトを作成し、ルート要素を追加します。次に、XML特殊文字を含む文字列をcreateCDATASection()でDom\CDATASectionノードとして作成し、ルート要素の子要素として追加します。

Dom\CDATASectionノード自体にアクセスした場合、nodeValueプロパティとtextContentプロパティはどちらもCDATAセクションの生のコンテンツ（<script>alert("Hello & World <tag>");</script>）を返します。textContentプロパティは、CDATAセクションのテキスト内容を取得するために使用され、戻り値は文字列型（string）またはnullです。

一方、CDATAセクションを含む親要素（Dom\Element）のnodeValueは通常nullとなります。しかし、親要素のtextContentプロパティは、その要素の子孫にあるすべてのテキストノード（CDATAセクションを含む）の内容を連結した文字列を返します。この例では、ルート要素のtextContentはCDATAセクションの内容全体を返します。

このコードを通して、XMLドキュメントにおけるCDATAセクションの扱いと、textContentプロパティの役割を理解することができます。