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

cloneNodeメソッドは、Dom\XMLDocumentクラスに属するメソッドで、現在のノードの複製を作成します。このメソッドは、既存のXMLドキュメント内のある部分（要素、属性、テキストなど）をコピーし、新しいノードとして利用したい場合に非常に役立ちます。

このメソッドは、通常ブール型の引数を受け取ります。この引数をtrueに設定すると、「深いコピー」が行われます。深いコピーでは、対象となるノードだけでなく、そのノードが持つすべての子孫ノード（子要素やその中のテキストなど）も再帰的にコピーされます。これは、元のXMLツリーの特定のセクションを、内容を含めて完全に複製したい場合に適しています。

一方、引数をfalseに設定すると、「浅いコピー」が行われます。浅いコピーでは、対象となるノード自身のみが複製され、子孫ノードはコピーされません。これは、ノードの型や属性などの情報だけをコピーし、その中身は新しいものとして定義したい場合や、全く新しい子ノードを追加したい場合に利用されます。

複製されたノードは、元のドキュメントとは独立した新しいオブジェクトとして返されますが、まだどのXMLドキュメントツリーにも組み込まれていません。そのため、複製したノードを実際にドキュメントに追加して利用するには、appendChildやinsertBeforeなどのメソッドを別途呼び出す必要があります。これにより、既存のXML構造を変更することなく、新しい要素や属性を柔軟に作成し、追加することが可能になります。

Copy
1<?php
2
3// Dom\XMLDocument オブジェクトのインスタンスを作成します。
4$document = new Dom\XMLDocument();
5$document->loadXML('<root><element/></root>');
6
7// クローンしたい元のノードを取得します（例: ドキュメントのルート要素）。
8$originalNode = $document->documentElement;
9
10// cloneNode メソッドを呼び出してノードをクローンします。
11//
12// 引数 $deep (bool, オプション):
13//   true を指定すると、ノード自身とすべての子孫ノードが再帰的にクローンされます。
14//   false（または引数を省略）を指定すると、ノード自身のみがクローンされ、子孫ノードはクローンされません。
15$clonedNode = $originalNode->cloneNode(true);
16
17// $clonedNode は新しく作成された Dom\Node オブジェクトであり、元のノードのコピーです。
18
19?>

?bool $deep = false

• ?bool $deep = false: trueを指定すると、ノードとそのすべての子孫ノードが再帰的にコピーされます。false（デフォルト）を指定すると、ノードのみがコピーされ、子孫ノードはコピーされません。

Dom\Node

このメソッドは、呼び出し元のDom\XMLDocumentオブジェクトのディープコピーである新しいDom\Nodeオブジェクトを返します。