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

Copy
1<?php
2
3/**
4 * DOMDocument を使用して CDATASection を作成し、
5 * その firstChild プロパティの挙動を示すサンプル関数です。
6 *
7 * Dom\CDATASection は、その性質上、子ノードを持たないため、
8 * firstChild プロパティは常に null を返します。
9 */
10function demonstrateCdataSectionFirstChild(): void
11{
12    // 1. DOMDocument オブジェクトを初期化
13    // XML バージョンとエンコーディングを指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    $dom->formatOutput = true; // 出力されるXMLを見やすく整形します
16
17    // 2. ルート要素を作成し、DOMDocument に追加
18    $root = $dom->createElement('data');
19    $dom->appendChild($root);
20
21    // 3. CDATASection を含む要素を作成し、ルート要素に追加
22    $item = $dom->createElement('item');
23    $root->appendChild($item);
24
25    // 4. CDATASection ノードを作成
26    // CDATASection は、XML パーサが内容をマークアップとして解釈しないようにする特殊なテキストノードです。
27    // HTMLタグや特殊文字をそのまま格納できます。
28    $cdataContent = '<h1>Welcome!</h1> <p>This is raw content with & special characters.</p>';
29    $cdata = $dom->createCDATASection($cdataContent);
30    $item->appendChild($cdata);
31
32    echo "--- 生成されたXML ---\n";
33    echo $dom->saveXML(); // 生成されたXMLを出力して構造を確認
34    echo "\n---------------------\n\n";
35
36    // 5. DOMDocument から作成した CDATASection ノードを取得
37    // XPath を使用して、特定の CDATASection ノードを効率的に見つけます。
38    $xpath = new DOMXPath($dom);
39    // 'item/text()[self::CDATASection]' は、'item' 要素の子であるCDATASectionノードを検索します。
40    $cdataNodes = $xpath->query('//item/text()[self::CDATASection]');
41
42    if ($cdataNodes->length > 0) {
43        /**
44         * @var Dom\CDATASection $foundCdata
45         * XPathで取得したノードリストから最初のCDATASectionノードを取り出します。
46         * PHP 8 では Dom\CDATASection が推奨される型ヒントです。
47         */
48        $foundCdata = $cdataNodes->item(0);
49
50        echo "取得したノードのクラス名: " . get_class($foundCdata) . "\n";
51        echo "CDATASection の nodeValue (格納されているコンテンツ): " . $foundCdata->nodeValue . "\n";
52        // CDATASection の length プロパティは、格納されているテキストデータの長さを返します。
53        echo "CDATASection の length (コンテンツの長さ): " . $foundCdata->length . "\n";
54
55        // 6. Dom\CDATASection の firstChild プロパティにアクセス
56        // CDATASection はテキストノードの一種であり、自身がテキストデータを持っているため、
57        // 内部にさらに子ノードを持つことはありません。
58        $firstChildOfCdata = $foundCdata->firstChild;
59
60        echo "\nCDATASection の firstChild の確認:\n";
61        if ($firstChildOfCdata === null) {
62            echo "-> firstChild は null です (Dom\\CDATASection は子ノードを持ちません)。\n";
63        } else {
64            // このブロックは通常実行されません
65            echo "-> firstChild が見つかりました (予期せぬ挙動): " . $firstChildOfCdata->nodeName . "\n";
66        }
67
68    } else {
69        echo "CDATASection ノードが見つかりませんでした。\n";
70    }
71}
72
73// 上記の関数を実行して、Dom\CDATASection::firstChild の挙動を確認します。
74demonstrateCdataSectionFirstChild();

PHP 8におけるDom\CDATASectionクラスのfirstChildプロパティは、XMLドキュメント内のノードの最初の子ノードを取得するために使用されます。このプロパティは引数を取らず、戻り値としてDOMNodeオブジェクト、または子ノードが存在しない場合はnullを返します。

CDATASectionは、XMLパーサが内容をマークアップとして解釈せず、テキストデータとしてそのまま扱わせるための特別なノードです。これにより、XML内部にHTMLタグや特殊文字など、マークアップと衝突する可能性のある生データを安全に埋め込むことができます。

その性質上、CDATASectionノードは自身がテキストデータを保持する「葉ノード」であり、内部にさらに他の子ノードを持つことはありません。したがって、Dom\CDATASectionインスタンスに対してfirstChildプロパティにアクセスしても、常にnullが返されます。

上記のサンプルコードでは、DOMDocumentを使用してCDATASectionを含むXMLドキュメントを作成し、その後に作成したCDATASectionオブジェクトのfirstChildプロパティにアクセスする様子を示しています。これにより、CDATASectionの子ノードが存在しないため、firstChildがnullを返すという挙動が具体的に確認できます。