【PHP8.x】cloneNodeメソッドの使い方

cloneNodeメソッドは、Dom\CDATASectionオブジェクトが自身を複製するために実行するメソッドです。このメソッドは、XMLやHTMLドキュメント内で解析されないテキストブロック（CDATAセクション）を表すノードのコピーを作成します。

このメソッドは、ブール型の引数$deepを受け取ることができます。$deepにtrueを指定すると、元のノードとそのすべての子孫ノードを再帰的に複製する「ディープコピー」が行われます。一方、$deepにfalseを指定するか、引数を省略した場合、元のノード自身のみを複製し、子孫ノードは複製しない「シャローコピー」が行われます。

Dom\CDATASectionノードは通常子ノードを持たないため、$deepの値をtrueにしてもfalseにしても、結果として複製されるノードの内容自体に実質的な違いは生じません。しかし、この挙動はDOM（Document Object Model）におけるcloneNodeメソッド全体に共通する重要な概念であるため、他の種類のノードを扱う際にも役立つ知識として理解しておくことが重要です。

複製されたCDATASectionノードは、元のノードとは完全に独立した新しいオブジェクトとして返されます。これにより、元のドキュメントツリーに影響を与えることなく、複製されたノードを自由に操作したり、別の場所に挿入したりすることが可能になります。例えば、既存のCDATASectionの内容をテンプレートとして利用し、その構造やテキストを基に複数の類似したノードを動的に生成したい場合などに、このメソッドは非常に有用です。

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成し、CDATASectionノードを作成します。
4$document = new DOMDocument();
5$cdataSection = $document->createCDATASection('これはクローンされるCDATAセクションの内容です。');
6
7// cloneNodeメソッドを呼び出して、現在のCDATASectionノードのコピーを作成します。
8// 引数にfalseを指定すると、ノード自身だけがクローンされます。
9// （CDATASectionノードは通常子ノードを持たないため、この指定が一般的です。）
10$clonedCdataSection = $cdataSection->cloneNode(false);
11
12?>

bool $deep = false

• bool $deep = false: クローンする際に、子ノードも再帰的にクローンするかどうかを指定する真偽値。true の場合は子ノードもすべてクローンします。デフォルトは false で、自身のみをクローンします。

Dom\Node

このメソッドは、現在のCDATAセクションノードのディープコピーを返します。返されるオブジェクトはDom\Node型です。