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

Copy
1<?php
2
3/**
4 * DOMDocument を使用して CDATASection を作成し、その nodeValue を取得するサンプルです。
5 * システムエンジニアを目指す初心者向けに、PHP 8 の Dom\CDATASection::nodeValue の使い方を示します。
6 */
7function demonstrateCDATASectionNodeValue(): void
8{
9    // 1. DOMDocument オブジェクトを作成します。
10    // XML 宣言を含め、整形された出力になるように設定します。
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true; // 出力を読みやすくするために整形します。
13
14    // 2. ルート要素を作成し、ドキュメントに追加します。
15    $root = $dom->createElement('data');
16    $dom->appendChild($root);
17
18    // 3. CDATASection オブジェクトを作成します。
19    // CDATASection は、XML パーサーに内部のテキストを文字データとして扱うように指示します。
20    // これにより、XML の特殊文字 (<, >, &, ", ') をエスケープせずに記述できます。
21    $cdataContent = 'このテキストには <special> な & 文字が含まれており、"エスケープ" 不要です。';
22    $cdataSection = $dom->createCDATASection($cdataContent);
23
24    // 4. 作成した CDATASection をルート要素に追加します。
25    $root->appendChild($cdataSection);
26
27    echo "--- CDATASection の nodeValue の取得と表示 ---\n";
28
29    // 5. CDATASection の nodeValue プロパティを使って内容を取得します。
30    // nodeValue は CDATASection に含まれるテキストコンテンツを string として返します。
31    $retrievedValue = $cdataSection->nodeValue;
32
33    echo "取得した CDATASection の nodeValue: " . $retrievedValue . "\n";
34    echo "元のコンテンツ:                   " . $cdataContent . "\n";
35
36    // 取得した値が元のコンテンツと一致するか確認します。
37    if ($retrievedValue === $cdataContent) {
38        echo "nodeValue は元のコンテンツと一致します。\n";
39    } else {
40        echo "nodeValue は元のコンテンツと一致しません。\n";
41    }
42
43    echo "\n--- DOMDocument の XML 出力 (CDATASection が含まれる) ---\n";
44
45    // 6. DOMDocument 全体を XML 文字列として出力し、CDATASection が正しく表現されていることを確認します。
46    echo $dom->saveXML();
47}
48
49// 関数を実行してサンプルコードの動作を確認します。
50demonstrateCDATASectionNodeValue();
51

PHP 8におけるDom\CDATASection::nodeValueプロパティは、XMLドキュメント内でCDATAセクションとして扱われる部分のテキストコンテンツを取得するために使用されます。CDATAセクションとは、<や&といったXMLの特殊文字をエスケープすることなくそのまま記述できる特別な領域のことです。このnodeValueプロパティにアクセスすると、CDATAセクションに含まれるテキストデータが文字列（string）として返されます。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、その中にcreateCDATASection()メソッドを使ってCDATAセクションを生成しています。次に、この生成された$cdataSectionオブジェクトのnodeValueプロパティを呼び出すことで、CDATAセクションに格納されているテキストコンテンツを簡単に取得し、その内容を表示しています。nodeValueの戻り値の型はstring|nullですが、Dom\CDATASectionのインスタンスに対してこのプロパティを使用した場合、通常は必ず文字列が返されます。引数はありません。このようにnodeValueを活用することで、CDATAセクション内のテキストデータを効率的に操作することが可能です。

Copy
1<?php
2
3/**
4 * Dom\CDATASection の nodeValue と textContent、
5 * および Dom\Element の nodeValue と textContent の違いをデモンストレーションします。
6 * システムエンジニアを目指す初心者向けに、各プロパティの挙動を分かりやすく示します。
7 */
8function demonstrateDomNodeValues(): void
9{
10    // DOMDocument オブジェクトを作成します。
11    // PHP 8 では、名前空間付きの Dom\Document クラスが推奨されます。
12    $dom = new Dom\Document('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 生成されるXMLを見やすくフォーマットします。
14
15    // ルート要素を作成し、ドキュメントに追加します。
16    $rootElement = $dom->createElement('root');
17    $dom->appendChild($rootElement);
18
19    echo "--- Dom\\CDATASection の場合 ---\n";
20
21    // Dom\CDATASection ノードを作成します。
22    // CDATASection は、XML/HTMLマークアップとして解析されたくないテキストブロックを格納するために使用されます。
23    // 例えば、HTMLタグや特殊文字 (<, >, &) が含まれていても、それらがそのままのテキストとして扱われます。
24    $cdataContent = 'この中に<b>HTMLタグ</b>や特殊文字 < & > が含まれていても、XMLマークアップとして解析されず、プレーンテキストとして扱われます。';
25    $cdataSection = $dom->createCDATASection($cdataContent);
26
27    // CDATASection ノードをルート要素に追加します。
28    $rootElement->appendChild($cdataSection);
29
30    // Dom\CDATASection の nodeValue を取得します。
31    // nodeValue は、このノード自身のテキストコンテンツを返します。
32    echo 'Dom\\CDATASection の nodeValue: ' . $cdataSection->nodeValue . "\n";
33
34    // Dom\CDATASection の textContent を取得します。
35    // textContent も、このノード自身のテキストコンテンツを返します。
36    // Dom\CDATASection の場合、nodeValue と textContent は通常、まったく同じ値を返します。
37    echo 'Dom\\CDATASection の textContent: ' . $cdataSection->textContent . "\n";
38    echo "\n";
39
40    echo "--- Dom\\Element (通常要素) の場合 ---\n";
41
42    // 通常の要素ノード (例: <paragraph>) を作成します。
43    $paragraphElement = $dom->createElement('paragraph');
44
45    // テキストノードと子要素を追加して、より複雑なコンテンツを作成します。
46    $paragraphElement->appendChild($dom->createTextNode('これは '));
47    $boldElement = $dom->createElement('b', '強調されたテキスト');
48    $paragraphElement->appendChild($boldElement);
49    $paragraphElement->appendChild($dom->createTextNode(' を含む通常の要素です。'));
50
51    // 通常の要素ノードをルート要素に追加します。
52    $rootElement->appendChild($paragraphElement);
53
54    // Dom\Element の nodeValue を取得します。
55    // 要素ノード (Dom\Element) の nodeValue は、通常 null です。
56    // 要素ノードは子ノード（テキストノードや他の要素ノードなど）を持つ「コンテナ」であり、
57    // それ自体には直接のテキストコンテンツがないためです。
58    echo 'Dom\\Element の nodeValue (paragraph): ' . var_export($paragraphElement->nodeValue, true) . "\n";
59
60    // Dom\Element の textContent を取得します。
61    // textContent は、その要素ノードとすべての子孫ノード（テキストノード、他の要素の子孫など）の
62    // テキストコンテンツを連結したものを返します。これにより、要素内の可視テキスト全体を簡単に取得できます。
63    echo 'Dom\\Element の textContent (paragraph): ' . $paragraphElement->textContent . "\n";
64    echo "\n";
65
66    echo "--- 結論 ---\n";
67    echo "・Dom\\CDATASection の場合、nodeValue と textContent は同じ値 (CDATA内のテキスト) を返します。\n";
68    echo "・Dom\\Element (通常要素) の場合、nodeValue は通常 null です。\n";
69    echo "・Dom\\Element の textContent は、その要素とすべての子孫要素のテキストを結合したものを返します。\n";
70    echo "  これにより、要素の可視テキスト全体を簡単に取得できます。\n";
71}
72
73// デモンストレーション関数を実行します。
74demonstrateDomNodeValues();

Dom\CDATASectionクラスのnodeValueプロパティは、XMLドキュメント内で定義されたCDATAセクションノードが含むテキストコンテンツを取得するために使用されます。このプロパティに引数はなく、戻り値はstring型、または該当する値がない場合はnullとなります。CDATAセクションは、<や&のような特殊文字を含むテキストを、XMLのマークアップとしてではなく、純粋なテキストとして扱いたい場合に利用されます。

サンプルコードでは、Dom\CDATASectionのnodeValueが、CDATAセクション内に記述されたテキストをそのまま返すことを示しています。このとき、Dom\CDATASectionにおけるtextContentプロパティもnodeValueと同じ値を返します。

しかし、一般的な要素ノードであるDom\Elementの場合と比較すると、nodeValueの挙動に違いがあります。Dom\ElementのnodeValueは通常nullを返します。これは、要素ノードが子ノード（テキストノードや他の要素ノードなど）を格納する「コンテナ」であり、要素自体に直接のテキストコンテンツがないためです。一方、Dom\ElementのtextContentは、その要素ノードと、その要素に含まれるすべての子孫ノードのテキストコンテンツを結合したものを返します。これにより、要素内の目に見える全てのテキストを一度に取得することができます。

したがって、nodeValueはノードの種類によって取得できる内容が異なり、特にDom\CDATASectionにおいては、そのセクション内のテキストデータを直接取得する際に活用されます。