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

Copy
1<?php
2
3// DOMDocument を利用してXMLドキュメントを操作するためのインスタンスを作成します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dom->formatOutput = true; // 出力されるXMLを見やすく整形します。
6
7// ドキュメントのルート要素 'root' を作成し、ドキュメントに追加します。
8$rootElement = $dom->createElement('root');
9$dom->appendChild($rootElement);
10
11// 元となる Dom\CDATASection ノードを作成します。
12// CDATASection は、XML/HTMLタグとして解釈されたくないテキストデータ（例: JavaScriptコード）を
13// そのまま保持するために使用されます。
14$originalCdata = $dom->createCDATASection('この中に <script>console.log("Hello");</script> のような特殊文字を含むテキストを記述できます。');
15
16// 作成した CDATASection ノードをルート要素の子として追加します。
17$rootElement->appendChild($originalCdata);
18
19echo "--- 元の Dom\\CDATASection ノードの情報 ---\n";
20echo "値 (nodeValue): " . $originalCdata->nodeValue . "\n";
21echo "オブジェクトID (一意の識別子): " . spl_object_id($originalCdata) . "\n\n";
22
23// Dom\CDATASection::cloneNode() メソッドを使ってノードのクローン（複製）を作成します。
24// 引数 $deep は、子ノードもクローンするかどうかを指定しますが、CDATASection は子ノードを持たないため、
25// true でも false でも結果は同じです。ここでは一般的な利用例として true を指定します。
26$clonedCdata = $originalCdata->cloneNode(true);
27
28// クローンされたノードをドキュメントのルート要素に再度追加します。
29// これにより、クローンされたノードがXMLツリーの一部として存在することを示します。
30$rootElement->appendChild($clonedCdata);
31
32echo "--- クローンされた Dom\\CDATASection ノードの情報 ---\n";
33echo "値 (nodeValue): " . $clonedCdata->nodeValue . "\n";
34echo "オブジェクトID (一意の識別子): " . spl_object_id($clonedCdata) . "\n";
35// 元のノードとクローンされたノードは別々の独立したオブジェクトであることを確認します。
36echo "元のノードとクローンされたノードは同じオブジェクトですか？: " . ($originalCdata === $clonedCdata ? 'いいえ' : 'はい') . "\n\n";
37
38echo "--- 最終的なXMLドキュメントの出力 ---\n";
39// ドキュメント全体をXML形式で出力し、クローンされたノードが追加されていることを確認します。
40echo $dom->saveXML();
41

PHP 8のDom\CDATASection::cloneNode()メソッドは、XMLドキュメント内のCDATASectionノードを複製するために利用されます。CDATASectionは、<script>タグや<p>タグのような特殊文字を含むテキストデータを、XMLパーサにタグとして解釈されずにそのまま保持させる目的で使用されるノードです。

このメソッドの引数$deepには真偽値を指定し、通常は子ノードも再帰的に複製するかどうかを制御します。しかし、Dom\CDATASectionノード自体は子ノードを持たないため、$deepにtrueまたはfalseのどちらを指定しても、複製結果に違いはありません。メソッドの戻り値は、元のノードと内容が全く同じ新しいDom\Node型のオブジェクトです。この複製されたノードは、元のノードとは完全に独立した別のオブジェクトとして扱われます。

サンプルコードでは、DOMDocumentインスタンスを作成し、その中に元のDom\CDATASectionノードを追加しています。その後、cloneNode(true)を呼び出すことで、元のノードの正確なコピーを作成しています。spl_object_id()関数で確認できる通り、元のノードと複製されたノードは異なるオブジェクトIDを持ち、それぞれが独立した存在であることが確認できます。最後に$dom->saveXML()でドキュメント全体を出力することで、複製されたCDATASectionがXMLツリー内に適切に追加されていることを確認できます。これにより、同じ内容のCDATASectionをXMLドキュメント内の複数箇所で効率的に利用できるようになります。

Copy
1<?php
2
3function demonstrateCdataSectionClone(): void
4{
5    // 1. DOMDocumentを作成し、XML構造の土台を準備します。
6    // XMLを整形して出力するため、formatOutputをtrueに設定します。
7    $dom = new Dom\Document('1.0', 'UTF-8');
8    $dom->formatOutput = true;
9
10    // 2. ルート要素を作成し、ドキュメントに追加します。
11    $root = $dom->createElement('root');
12    $dom->appendChild($root);
13
14    // 3. 元となるCDATASectionノードを作成します。
15    // CDATASectionはXMLパーサーによって解釈されない特殊なデータブロックです。
16    $originalContent = 'これは<xmlタグ>と解釈されない生のデータです。</xmlタグ>';
17    $originalCdata = $dom->createCDATASection($originalContent);
18
19    // 4. 元のCDATASectionノードをルート要素に追加します。
20    $root->appendChild($originalCdata);
21
22    echo "--- 元のXMLドキュメント ---\n";
23    echo $dom->saveXML();
24    echo "\n";
25
26    // 5. Dom\CDATASection::cloneNode() メソッドを使用して、CDATASectionノードをクローンします。
27    // 引数 $deep = false は、子ノードも再帰的にクローンするかを指定しますが、
28    // CDATASectionは子ノードを持たないため、falseを指定しても問題ありません。
29    // 戻り値は Dom\Node ですが、実際には Dom\CDATASection のインスタンスになります。
30    /** @var Dom\CDATASection $clonedCdata */
31    $clonedCdata = $originalCdata->cloneNode(false);
32
33    // 6. クローンされたCDATASectionノードの内容を変更します。
34    // これにより、クローンが元のノードとは独立したオブジェクトであることが示されます。
35    $clonedCdata->data = 'これはクローンされたCDATAセクションの新しいデータです。';
36
37    // 7. クローンされたCDATASectionノードを、ドキュメント内の別の場所に追加します。
38    // 今回は新しい要素を作成し、その中に入れます。
39    $clonedWrapper = $dom->createElement('clonedDataWrapper');
40    $clonedWrapper->appendChild($clonedCdata);
41    $root->appendChild($clonedWrapper);
42
43    echo "--- クローン後に変更・追加されたXMLドキュメント ---\n";
44    echo $dom->saveXML();
45    echo "\n";
46
47    // 8. 元とクローンされたCDATASectionノードが異なるオブジェクトであることを確認します。
48    echo "元のCDATASectionの内容: " . $originalCdata->data . "\n";
49    echo "クローンされたCDATASectionの内容: " . $clonedCdata->data . "\n";
50    // spl_object_id() はオブジェクトの一意のIDを返します。
51    // 異なるIDであれば、それは別のオブジェクトであることを意味します。
52    echo "両者が同じオブジェクトか？ " . (spl_object_id($originalCdata) === spl_object_id($clonedCdata) ? 'はい' : 'いいえ') . "\n";
53}
54
55// 関数を実行して、Dom\CDATASectionのクローン処理を実演します。
56demonstrateCdataSectionClone();
57

Dom\CDATASection::cloneNode() メソッドは、XMLドキュメント内で使用されるCDATAセクションノードを複製するために利用されます。CDATAセクションは、XMLパーサーによって内容が解釈されないように、生のテキストや特殊文字をそのまま保持する特殊なノードです。このサンプルコードは、既存のCDATAセクションノードを複製し、元のノードとは独立して内容を変更・操作できることを実演します。

コードではまず、Dom\Documentオブジェクトを作成し、元のCDATAセクションノードを生成してXMLドキュメントに追加します。次に、Dom\CDATASection::cloneNode() メソッドを呼び出して、このノードをクローンしています。引数 $deep は、子ノードも再帰的に複製するかどうかを指示しますが、CDATAセクションは子ノードを持たないため、false を指定しても動作に違いはありません。このメソッドの戻り値は Dom\Node 型ですが、実際に返されるのは Dom\CDATASection のインスタンスとなります。

クローンされたCDATAセクションノードは、元のノードとは完全に別の独立したオブジェクトです。サンプルコードでは、クローン後のノードの内容を変更し、それをドキュメントの別の場所に追加しています。この変更が元のCDATAセクションには一切影響を与えないことを、最終的なXML出力と、spl_object_id() 関数によるオブジェクトIDの比較で明確に確認できます。このメソッドは、既存のノードをテンプレートとして新しいノードを作成し、XMLドキュメントを柔軟に操作する際に非常に役立ちます。