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

Copy
1<?php
2
3/**
4 * DOMCdataSection の nodeValue プロパティの使用方法を示すサンプルコード。
5 *
6 * DOMCdataSection は XML 内で特定のデータをマークアップせずにそのまま含めるための
7 * CDATA セクションを表します。nodeValue プロパティは、その CDATA セクション内の
8 * テキストコンテンツ（生のデータ）を取得するために使用されます。
9 */
10function demonstrateDomCdataSectionNodeValue(): void
11{
12    // 1. DOMDocument オブジェクトを作成します。
13    // XML バージョンとエンコーディングを指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力時にXMLを整形して見やすくします。
16    $dom->formatOutput = true;
17
18    // 2. ルート要素 'root' を作成し、ドキュメントに追加します。
19    $rootElement = $dom->createElement('root');
20    $dom->appendChild($rootElement);
21
22    // 3. CDATA セクションに含める生データを作成します。
23    // このデータはXMLパーサによって解析されず、そのまま扱われます。
24    $rawData = 'この文字列には <b>HTMLタグ</b> や < & > といった <script>危険な文字</script> も含まれます。';
25
26    // 4. DOMCdataSection オブジェクトを作成します。
27    // createCDATASection() メソッドで CDATA セクションを作成できます。
28    $cdataSection = $dom->createCDATASection($rawData);
29
30    // 5. 'data' という要素を作成し、その中に CDATA セクションを追加します。
31    $dataElement = $dom->createElement('data');
32    $dataElement->appendChild($cdataSection);
33    $rootElement->appendChild($dataElement);
34
35    echo "--- 生成された XML ドキュメント ---" . PHP_EOL;
36    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
37
38    // 6. DOMCdataSection オブジェクトから nodeValue プロパティを取得します。
39    // nodeValue は、CDATA セクション内の生のテキストコンテンツを文字列として返します。
40    $retrievedValue = $cdataSection->nodeValue;
41
42    echo "--- DOMCdataSection から取得した nodeValue ---" . PHP_EOL;
43    echo "取得された値: " . $retrievedValue . PHP_EOL;
44
45    // 取得した値が元の生データと一致するか確認します。
46    if ($retrievedValue === $rawData) {
47        echo "→ nodeValue は元の CDATA コンテンツと正確に一致します。" . PHP_EOL;
48    } else {
49        echo "→ エラー: nodeValue が元の CDATA コンテンツと一致しません。" . PHP_EOL;
50    }
51}
52
53// 関数を実行して、DOMCdataSection の nodeValue の動作を確認します。
54demonstrateDomCdataSectionNodeValue();
55
56?>

PHPのDOMCdataSectionクラスのnodeValueプロパティは、XMLドキュメント内でCDATAセクションとして扱われる部分のテキストコンテンツを取得するために使用されます。CDATAセクションとは、XMLパーサーによって解析されず、中に含まれる特殊文字（例: <, >, &）がそのままの意味で扱われる特別なブロックのことです。

このプロパティは引数を取らず、CDATAセクション内の生のテキストデータを文字列（string）として返します。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、XMLの構造を準備します。次に、HTMLタグや特殊文字を含む特定の生データを定義し、これをDOMDocumentのcreateCDATASectionメソッドを使ってDOMCdataSectionオブジェクトとして生成し、XMLドキュメントに追加しています。

その後、この作成されたDOMCdataSectionオブジェクトである$cdataSectionからnodeValueプロパティにアクセスすると、CDATAセクションに含まれていた元の生データが正確な文字列として取得されます。これは、XML内で特別なエスケープ処理を必要とせずに、任意のテキストを埋め込み、後でその内容をそのまま取り出すことが可能になることを示しています。例えば、HTMLスニペットやスクリプトコードなどをXMLデータ内に保持し、後で加工せずに利用したい場合に非常に有用な機能です。

Copy
1<?php
2
3/**
4 * DOMCdataSectionクラスのnodeValueプロパティの動作を示すサンプルコードです。
5 * XMLドキュメント内にCDATAセクションを作成し、その内容（nodeValue）を取得します。
6 * HTMLコンテンツをCDATAセクション内に埋め込むシナリオを想定しています。
7 */
8function demonstrateCdataSectionNodeValue(): void
9{
10    // 1. DOMDocumentオブジェクトを初期化し、XMLドキュメントを作成します。
11    // PHPのDOM拡張はXMLとHTMLの両方を扱えますが、CDATAセクションはXMLの概念です。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力整形を有効にすると、生成されるXMLが見やすくなります。
14
15    // ルート要素 'data' を作成し、ドキュメントに追加します。
16    $root = $dom->createElement('data');
17    $dom->appendChild($root);
18
19    // 2. CDATAセクションに含めるHTMLコンテンツを準備します。
20    // このコンテンツはXMLパーサーによって通常のXMLとして解析されず、生文字列として扱われます。
21    $htmlContent = '<div>
22    <h1>Hello, PHP DOM!</h1>
23    <p>This is some <strong>HTML</strong> content embedded in a CDATA section.</p>
24</div>';
25
26    // 3. DOMDocument::createCDATASection() メソッドでCDATAセクションを作成します。
27    // 引数には、CDATAセクションに含めたい文字列を渡します。
28    $cdataNode = $dom->createCDATASection($htmlContent);
29
30    // 作成したCDATAセクションをルート要素 'data' の子ノードとして追加します。
31    $root->appendChild($cdataNode);
32
33    // (オプション) 生成されたXMLドキュメントの内容を確認したい場合にコメントを解除してください。
34    // echo "--- 生成されたXMLドキュメント ---\n";
35    // echo $dom->saveXML();
36    // echo "--------------------------------\n\n";
37
38    // 4. ドキュメントからCDATAセクションを探し、その nodeValue を取得します。
39    // まず、ルート要素 'data' を取得します。
40    $elements = $dom->getElementsByTagName('data');
41
42    if ($elements->length > 0) {
43        $dataElement = $elements->item(0);
44
45        // 'data' 要素の子ノードを走査し、DOMCdataSectionのインスタンスを見つけます。
46        foreach ($dataElement->childNodes as $childNode) {
47            // ノードが DOMCdataSection のインスタンスであるかを確認します。
48            if ($childNode instanceof DOMCdataSection) {
49                // DOMCdataSectionのnodeValueプロパティを取得します。
50                // nodeValueはCDATAセクションの内容（文字列）を返します。
51                $cdataValue = $childNode->nodeValue;
52
53                echo "--- DOMCdataSectionのnodeValue ---\n";
54                echo $cdataValue . "\n";
55                echo "--------------------------------\n";
56                return; // 最初のCDATAセクションを見つけたら関数を終了します。
57            }
58        }
59    }
60
61    echo "CDATAセクションが見つかりませんでした。\n";
62}
63
64// 関数を実行して、DOMCdataSectionのnodeValueの動作を確認します。
65demonstrateCdataSectionNodeValue();

DOMCdataSection::nodeValueプロパティは、XMLドキュメント内で定義されるCDATAセクションの内容を文字列として取得するためのものです。CDATAセクションとは、XMLパーサーが内部のテキストを通常のXMLマークアップとして解釈せず、生のリテラルデータとして扱う特殊なセクションを指します。これにより、HTMLコードのように「<」や「&」といったXMLの特殊文字を、エスケープすることなくXMLドキュメント内に安全に埋め込むことが可能になります。

このサンプルコードでは、まずPHPのDOMDocumentクラスを使用してXMLドキュメントを初期化し、ルート要素であるdataを追加しています。次に、HTMLコンテンツを含む文字列を用意し、createCDATASection()メソッドを使ってこのHTMLコンテンツを格納したCDATAセクションノードを作成します。作成されたCDATAセクションノードは、data要素の子ノードとしてドキュメントに追加されます。その後、生成されたドキュメントからCDATAセクションノードを見つけ出し、そのnodeValueプロパティにアクセスすることで、CDATAセクション内に埋め込まれた元のHTMLコンテンツを正確な文字列として取得し、出力しています。

nodeValueプロパティは引数を必要とせず、常にCDATAセクションの生の内容を文字列として返します。システム開発において、XMLドキュメントにHTMLスニペットやプログラムコードなど、XMLの特殊文字を多く含むデータをそのまま埋め込み、後でその内容を取り出して利用したい場合に非常に役立つ機能です。