【PHP8.x】Dom\CDATASection::appendChild()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\CDATASection::appendChild の動作を実演します。
7 *
8 * CDATAセクションは子ノードを持つことができないため、
9 * appendChildを呼び出すと DOMException がスローされます。
10 * このサンプルでは、その挙動を確認します。
11 */
12function demonstrateCdataAppendChildBehavior(): void
13{
14    // 1. DOMDocumentオブジェクトを生成
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力されるXMLを整形する
17    $dom->formatOutput = true;
18
19    // 2. ルート要素を作成してドキュメントに追加
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // 3. CDATAセクションを作成し、ルート要素に追加
24    $cdataContent = '<p>This is some content that should not be parsed.</p>';
25    $cdataNode = $dom->createCDATASection($cdataContent);
26    $root->appendChild($cdataNode);
27
28    // 4. CDATAセクションに追加を試みる子要素を作成
29    $childNode = $dom->createElement('child', 'This node cannot be appended.');
30
31    echo "--- 処理前のXML ---" . PHP_EOL;
32    echo $dom->saveXML();
33    echo PHP_EOL;
34
35    try {
36        // 5. CDATAセクションに子要素を追加しようと試みる
37        // ここで DOMException がスローされる
38        $cdataNode->appendChild($childNode);
39    } catch (DOMException $e) {
40        // 6. 期待される例外を捕捉し、エラーメッセージを表示
41        echo "--- 例外が発生しました ---" . PHP_EOL;
42        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
43        echo "説明: CDATAセクションは子ノードを持つことができないため、appendChildは失敗します。" . PHP_EOL;
44    }
45
46    echo PHP_EOL . "--- 処理後のXML (変更なし) ---" . PHP_EOL;
47    echo $dom->saveXML();
48}
49
50// 関数を実行
51demonstrateCdataAppendChildBehavior();

このPHPサンプルコードは、Dom\CDATASection::appendChildメソッドの特殊な動作を解説します。appendChildメソッドは、引数で指定したノードを子として追加し、成功した場合はその追加したノードを戻り値として返します。しかし、Dom\CDATASectionクラスのインスタンスに対してこのメソッドを使用すると、挙動が異なります。

コードでは、まずDOMドキュメントとルート要素を作成し、その中にCDATAセクションを追加しています。CDATAセクションは、XMLパーサーに解釈させずにそのまま表示したい文字列データを格納するためのもので、XMLの仕様上、内部に子ノード（子要素）を持つことができません。

次に、このCDATAセクションに対して、新しく作成した子要素をappendChildで追加しようと試みています。この操作はXMLのルールに反するため、処理は成功せず、代わりにDOMExceptionという種類の例外（エラー）が発生します。このサンプルコードではtry-catch構文を用いて、この予期された例外を安全に捕捉し、エラーメッセージを表示することで、その挙動を明確に示しています。

結果として、CDATAセクションにノードが追加されることはなく、XMLの構造は処理前の状態から変わりません。このコードは、Dom\CDATASectionに子ノードを追加しようとすると必ず失敗するという重要なルールを実証するものです。

Copy
1<?php
2
3/**
4 * Dom\CDATASection::appendChild メソッドの挙動を示すサンプルコードです。
5 *
6 * Dom\CDATASection はテキストノードの一種であり、子ノードを持つことができません。
7 * そのため、appendChild メソッドを呼び出すと DOMException (HierarchyRequestError) が発生します。
8 * この関数では、CDATASection の基本的な作成と、appendChild を呼び出した際のエラーを捕捉し、説明します。
9 */
10function demonstrateCdataSectionAppendChild(): void
11{
12    // 1. DOMDocument オブジェクトを作成
13    $dom = new Dom\Document('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 出力時にXMLを整形
15
16    // 2. ルート要素を作成し、ドキュメントに追加
17    $rootElement = $dom->createElement('data');
18    $dom->appendChild($rootElement);
19
20    // 3. CDATASection ノードを作成
21    // CDATAセクションは、XMLパーサに解析させたくない、エスケープされていないテキストデータ
22    // (例: HTMLマークアップやスクリプトコードなど) を含めるために使用されます。
23    $rawContent = 'これは <b>HTML</b> タグを含むテキストで、&amp; などの特殊文字も含まれます。';
24    $cdataNode = $dom->createCDATASection($rawContent);
25
26    // 4. 作成した CDATASection を親要素 (ルート要素) に追加
27    // ここでは Dom\Element::appendChild を使用します。
28    echo "--- CDATASection を親要素に追加 ---" . PHP_EOL;
29    $rootElement->appendChild($cdataNode);
30    echo "CDATASection が親要素 '<data>' に追加されました。" . PHP_EOL;
31
32    // 5. 現在の XML 構造を出力
33    echo PHP_EOL . "--- 生成されたXMLドキュメント ---" . PHP_EOL;
34    echo $dom->saveXML() . PHP_EOL;
35
36    // 6. Dom\CDATASection::appendChild を呼び出す試み
37    echo PHP_EOL . "--- Dom\CDATASection::appendChild を呼び出す試み ---" . PHP_EOL;
38    try {
39        // CDATASection は子ノードを持つことができないため、
40        // 以下の appendChild の呼び出しは DOMException をスローします。
41        echo "Dom\CDATASection::appendChild を呼び出します..." . PHP_EOL;
42        $dummyNode = $dom->createTextNode('このテキストは追加されません'); // ダミーの子ノード
43        $cdataNode->appendChild($dummyNode); // ここでエラーが発生する
44
45        // エラーが発生した場合、この行は実行されません。
46        echo "このメッセージは表示されません。" . PHP_EOL;
47    } catch (Dom\DOMException $e) {
48        // DOMException を捕捉し、エラーメッセージを表示
49        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
50        echo "説明: Dom\CDATASection は Dom\Text を継承しており、" . PHP_EOL;
51        echo "テキストノードは子ノードを持つことができません。そのため、" . PHP_EOL;
52        echo "appendChild メソッドは HierarchyRequestError をスローします。" . PHP_EOL;
53        echo "CDATASection は、その内部に単一のテキストデータのみを保持します。" . PHP_EOL;
54    }
55}
56
57// 関数の実行
58demonstrateCdataSectionAppendChild();
59
60?>

Dom\CDATASection::appendChildは、通常、指定されたDOMNodeオブジェクトを自身の子ノードとして追加するメソッドです。引数DOMNode $nodeは追加しようとするノードを、戻り値Dom\Nodeは成功した場合に追加されたノード自身を返します。

しかし、Dom\CDATASectionはXMLドキュメント内で、特殊文字をエスケープせずにテキストデータを格納するためのノードであり、その内部に他の子ノードを持つことはできません。これは、Dom\CDATASectionがDom\Textノードの一種であるためです。

このため、Dom\CDATASectionのインスタンスに対してappendChildメソッドを呼び出すと、XMLツリーの階層構造のルールに違反するため、Dom\DOMException型のHierarchyRequestErrorが発生します。

サンプルコードでは、まずDom\Documentオブジェクトを用いてCDATAセクションを作成し、それを適切な親要素の子として追加する正しい方法を示しています。これはCDATAセクションがXMLツリーに組み込まれる標準的な手順です。その後に、このDom\CDATASectionノード自体に別のノードを子として追加しようと試みています。この試みはtry-catchブロックによって捕捉され、HierarchyRequestErrorがスローされることが確認できます。これにより、Dom\CDATASectionノードが子ノードを持てないという特性が明確に示されています。この挙動を理解することは、XMLドキュメントを正確に操作する上で重要です。