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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMCdataSectionのnodeNameプロパティの使用例を示します。
7 * CDATAセクションは、マークアップとして解釈されるべきではないテキストブロックを囲むために使用されます。
8 *
9 * @return void
10 */
11function showCdataSectionNodeNameExample(): void
12{
13    // 1. DOMDocumentオブジェクトをインスタンス化します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力するXMLをきれいに整形する設定
16    $dom->formatOutput = true;
17
18    // 2. ルート要素<data>を作成し、ドキュメントに追加します。
19    $rootElement = $dom->createElement('data');
20    $dom->appendChild($rootElement);
21
22    // 3. CDATAセクションに含めるテキストを定義します。
23    // このテキストはXMLパーサーによって解釈されません。
24    $cdataContent = 'if (x < 10 && y > 5) { return true; }';
25
26    // 4. CDATAセクションノードを作成します。
27    $cdataSection = $dom->createCDataSection($cdataContent);
28
29    // 5. 作成したCDATAセクションをルート要素の子として追加します。
30    $rootElement->appendChild($cdataSection);
31
32    // 6. DOMCdataSectionオブジェクトのnodeNameプロパティを取得して出力します。
33    // このプロパティは常に固定の文字列「#cdata-section」を返します。
34    echo 'The nodeName of DOMCdataSection is: ' . $cdataSection->nodeName . PHP_EOL;
35
36    // 参考: 生成されたXML全体を確認します。
37    echo '--- Generated XML ---' . PHP_EOL;
38    echo $dom->saveXML();
39}
40
41// 関数を実行します。
42showCdataSectionNodeNameExample();
43
44?>

このサンプルコードは、PHPのDOM拡張機能を使用してXMLドキュメントを扱い、特にDOMCdataSectionクラスとそのnodeNameプロパティの使用方法を示しています。DOMCdataSectionは、XML内で特殊な文字（例えば<や&など）を含むテキストを、XMLパーサーにマークアップとして解釈させずに、そのままデータとして埋め込む際に使用される要素です。

nodeNameプロパティは、DOMツリー内の各ノードの種類に応じた名前を文字列として返します。このプロパティは引数を一切取りません。DOMCdataSectionオブジェクトに対してこのnodeNameプロパティにアクセスすると、戻り値として常に固定値である「#cdata-section」という文字列が返されます。これは、そのノードがCDATAセクションであることを明確に示す標準的な名前です。

サンプルコードでは、まずDOMDocumentオブジェクトを生成し、XMLのルート要素を作成しています。次に、createCDataSectionメソッドを使って特定のテキストコンテンツを含むCDATAセクションノードを作成し、これをドキュメントに追加しています。最後に、作成した$cdataSectionオブジェクトのnodeNameプロパティを取得して出力することで、CDATAセクションノードの識別名が「#cdata-section」であることが確認できることを示しています。