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

cloneNodeメソッドは、PHPのDOMDocumentクラスに属し、現在のDOMDocumentオブジェクトを複製するメソッドです。DOMDocumentオブジェクトはXMLやHTMLドキュメント全体を表現するためのものであり、このメソッドを使うことで、元のドキュメントの内容を保持したまま、完全に独立した新しいドキュメントオブジェクトを作成できます。これにより、元のドキュメントに影響を与えることなく、複製したドキュメントに対して様々な操作を自由に行うことが可能になります。

このメソッドには、複製方法を制御するためのオプションのブール型引数$deepがあります。$deepをtrueに設定した場合、現在のDOMDocumentオブジェクトだけでなく、その配下にあるすべての要素、テキストノード、属性といった子ノードやその子孫ノードもすべて再帰的にコピーされ、元のドキュメントと全く同じ構造を持つドキュメントが生成されます。これは「深いコピー」と呼ばれます。

一方、$deepをfalseに設定した場合、DOMDocumentオブジェクト自体は複製されますが、その内部に含まれる子ノードはコピーされません。結果として、空のドキュメント構造を持つ新しいDOMDocumentオブジェクトが作成されます。これは「浅いコピー」と呼ばれ、新しいドキュメント構造を一から構築する基盤として利用できます。

cloneNodeメソッドは、複製された新しいDOMDocumentオブジェクトを戻り値として返します。返されるオブジェクトは元のオブジェクトとは異なるメモリ領域に存在するため、互いに独立して操作できます。例えば、既存のXMLファイルをテンプレートとして読み込み、その構造を複数回再利用して、異なるデータを持つ複数のXMLドキュメントを効率的に生成するシナリオなどで非常に有用です。

Copy
1<?php
2
3$dom = new DOMDocument();
4$originalElement = $dom->createElement('item');
5$originalElement->appendChild($dom->createTextNode('Data'));
6$dom->appendChild($originalElement);
7
8// originalElement ノードとその子孫を深くクローンする構文
9$clonedElement = $originalElement->cloneNode(true);
10
11?>

bool $deep = false

• bool $deep = false: trueを指定すると、ノードだけでなく、その子ノードすべてが再帰的にコピーされます。falseの場合は、ノードのみがコピーされ、子ノードはコピーされません。

DOMNode

このメソッドは、呼び出したDOMNodeオブジェクトのコピーを新しく生成し、そのコピーを返します。