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

Copy
1<?php
2
3// DOMDocument オブジェクトを作成し、サンプルHTMLを読み込みます。
4// cloneNode メソッドは、DOMツリー内の特定のノードをコピーするために使用されます。
5$dom = new DOMDocument('1.0', 'UTF-8');
6// シンプルなHTML文字列をロードします。要素間に空白や改行を入れないことで、
7// 子ノードが明確に2つ（<p>と<span>）になるようにしています。
8$dom->loadHTML('<div id="parent"><p>Hello</p><span class="child">World</span></div>');
9
10// コピーする元のノードを選択します。
11// getElementById メソッドは、指定されたIDを持つ要素を簡単に見つけられるため便利です。
12$originalNode = $dom->getElementById('parent');
13
14// ノードが見つからなかった場合の基本的なエラーハンドリング
15if ($originalNode === null) {
16    echo "エラー: 'parent' IDを持つ要素が見つかりませんでした。\n";
17    exit(1);
18}
19
20echo "--- 元のノードの情報 ---\n";
21echo "ノード名: " . $originalNode->nodeName . "\n"; // 例: div
22echo "テキスト内容 (すべての子ノードを含む): " . $originalNode->textContent . "\n"; // 例: Hello World
23echo "子ノードの数: " . $originalNode->childNodes->length . " (この例では <p> と <span> の2つ)\n";
24foreach ($originalNode->childNodes as $child) {
25    echo "  - 子ノード名: " . $child->nodeName . "\n"; // 例: p, span
26}
27echo "\n";
28
29
30// --- cloneNode(false) の例: シャローコピー ---
31echo "--- cloneNode(false) の例: シャローコピー (子ノードをコピーしない) ---\n";
32// cloneNode(false) は、元のノード自体はコピーしますが、その子ノードはコピーしません。
33// つまり、この例では <div id="parent"></div> の部分だけがコピーされ、内部の <p> や <span> は含まれません。
34$shallowClonedNode = $originalNode->cloneNode(false);
35
36echo "シャローコピーされたノードのノード名: " . $shallowClonedNode->nodeName . "\n"; // 例: div
37echo "シャローコピーされたノードのテキスト内容: " . $shallowClonedNode->textContent . " (子ノードがないため空)\n";
38echo "シャローコピーされたノードの子ノード数: " . $shallowClonedNode->childNodes->length . "\n"; // 0 になるはず
39echo "\n";
40
41
42// --- cloneNode(true) の例: ディープコピー ---
43echo "--- cloneNode(true) の例: ディープコピー (子ノードもすべてコピーする) ---\n";
44// cloneNode(true) は、元のノード自体とそのすべての子ノードを再帰的にコピーします。
45// この例では、<div id="parent"><p>Hello</p><span class="child">World</span></div> 全体がコピーされます。
46$deepClonedNode = $originalNode->cloneNode(true);
47
48echo "ディープコピーされたノードのノード名: " . $deepClonedNode->nodeName . "\n"; // 例: div
49echo "ディープコピーされたノードのテキスト内容: " . $deepClonedNode->textContent . "\n"; // 例: Hello World
50echo "ディープコピーされたノードの子ノード数: " . $deepClonedNode->childNodes->length . "\n"; // 元のノードと同じ数 (2)
51foreach ($deepClonedNode->childNodes as $child) {
52    echo "  - 子ノード名: " . $child->nodeName . "\n"; // 例: p, span
53}
54echo "\n";
55
56
57// --- 元のノードとクローンされたノードは別オブジェクトであることの確認 ---
58echo "--- オブジェクトの同一性確認 ---\n";
59// cloneNode メソッドは、元のノードとは完全に独立した新しいノードオブジェクトを作成します。
60// === 演算子で、これらがメモリ上で異なるオブジェクトであることを確認できます。
61echo "元のノードとシャローコピーされたノードは同じオブジェクトですか？ " . ($originalNode === $shallowClonedNode ? "はい" : "いいえ") . "\n";
62echo "元のノードとディープコピーされたノードは同じオブジェクトですか？ " . ($originalNode === $deepClonedNode ? "はい" : "いいえ") . "\n";
63echo "これらはすべてメモリ上で異なるオブジェクトとして存在します。\n";
64
65?>

PHPのDOMNode::cloneNodeメソッドは、HTMLやXML文書の構造を表すDOMツリー内の特定のノードをコピーするために使用されます。このメソッドは、元のノードとは独立した新しいノードオブジェクトを作成します。

引数$deepはブール型で、子ノードも一緒にコピーするかどうかを決定し、デフォルト値はfalseです。$deepにfalseを指定すると「シャローコピー」が行われ、対象のノード自体はコピーされますが、その子ノードは含まれません。サンプルコードでは、<div id="parent">タグはコピーされますが、内部の<p>や<span>要素はコピーされないため、コピーされたノードのテキスト内容は空となり、子ノードの数も0となります。

一方、$deepにtrueを指定すると「ディープコピー」が行われ、対象のノード自体とそのすべての子ノードが再帰的にコピーされます。サンプルコードでは、<div id="parent">からその内部の<p>Hello</p>や<span class="child">World</span>まで、元のノードの構造全体が完全に複製されます。

このメソッドの戻り値は、コピーされた新しいDOMNodeオブジェクトです。この新しいノードは、元のノードとはメモリ上で完全に別個のオブジェクトとして存在するため、どちらかのノードを変更してももう一方には影響しません。サンプルコードでは、===演算子で元のノードとコピーされたノードが異なるオブジェクトであることが確認できます。これにより、元のDOMツリーを壊すことなく、要素の複製や再利用が可能になります。

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成し、整形出力を有効にします。
4// これにより、出力されるXMLが見やすくなります。
5$dom = new DOMDocument();
6$dom->formatOutput = true;
7
8// ルート要素 'document' を作成し、DOMドキュメントに追加します。
9$documentRoot = $dom->createElement('document');
10$dom->appendChild($documentRoot);
11
12// 複製元の要素として 'original_item' を作成し、子要素 'title' と 'description' を追加します。
13$originalItem = $dom->createElement('original_item');
14$originalItem->setAttribute('id', 'item-1');
15$originalItem->appendChild($dom->createElement('title', 'オリジナルのタイトル'));
16$originalItem->appendChild($dom->createElement('description', 'これはオリジナルの説明文です。'));
17
18// 作成したオリジナル要素をドキュメントに追加します。
19$documentRoot->appendChild($originalItem);
20
21// --- DOMNode::cloneNode() の使用例 ---
22
23// 1. ディープコピー ($deep = true)
24// cloneNode(true) は、ノード自身と全ての子ノードを再帰的に複製します。
25// 例: originalItemとその子要素（title, description）が全て複製されます。
26$clonedItemDeep = $originalItem->cloneNode(true);
27$clonedItemDeep->setAttribute('id', 'item-2-deep'); // 複製されたノードのIDを変更
28
29// ディープコピーされた子ノードの内容を変更することも可能です。
30if ($titleNode = $clonedItemDeep->getElementsByTagName('title')->item(0)) {
31    $titleNode->nodeValue = 'ディープコピーされたタイトル';
32}
33if ($descNode = $clonedItemDeep->getElementsByTagName('description')->item(0)) {
34    $descNode->nodeValue = 'これはディープコピーされた説明文です。';
35}
36
37// 複製されたノードをドキュメントに追加します。
38$documentRoot->appendChild($clonedItemDeep);
39
40
41// 2. シャローコピー ($deep = false)
42// cloneNode(false) は、ノード自身のみを複製し、子ノードは複製しません。
43// 例: originalItem要素（属性含む）は複製されますが、子要素（title, description）は含まれません。
44$clonedItemShallow = $originalItem->cloneNode(false);
45$clonedItemShallow->setAttribute('id', 'item-3-shallow'); // 複製されたノードのIDを変更
46
47// シャローコピーされたノードには子ノードがないため、必要に応じて手動で追加します。
48$clonedItemShallow->appendChild($dom->createElement('title', 'シャローコピーされたタイトル'));
49$clonedItemShallow->appendChild($dom->createElement('note', 'これはシャローコピーに後から追加されたノートです。'));
50
51// 複製されたノードをドキュメントに追加します。
52$documentRoot->appendChild($clonedItemShallow);
53
54
55// 最終的なDOMドキュメントの内容をXML形式で出力し、結果を確認します。
56echo $dom->saveXML();
57
58?>

DOMNode::cloneNodeメソッドは、XMLやHTMLのDOMツリー内で既存のノードを複製する際に使用されます。このメソッドは、引数$deepによって複製の方法が変わります。$deepにtrueを指定すると、ノード自身だけでなく、その全ての子ノードも再帰的に複製する「ディープコピー」が行われます。一方、falseを指定すると、ノード自身とその属性のみが複製され、子ノードは複製されない「シャローコピー」が行われます。メソッドの戻り値は、複製された新しいDOMNodeオブジェクトです。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、original_itemという親ノードとその子ノードを含むXML構造を準備しています。このoriginal_itemが複製元のノードとなります。

次に、originalItem->cloneNode(true)を呼び出してディープコピーを実行しています。これにより、original_itemとその子要素であるtitleやdescriptionが全て複製されます。複製されたノードのIDや子要素の内容は、元のノードとは独立して変更できることが示されています。

続いて、originalItem->cloneNode(false)を呼び出してシャローコピーを行っています。シャローコピーでは、original_item要素とその属性は複製されますが、子要素は複製されません。そのため、サンプルコードでは複製されたノードに対して、titleやnoteといった新しい子要素を手動で追加しています。

最後に、DOMDocument::saveXML()メソッドを使用して、作成および複製された全てのXML要素が正しく含まれているかを出力で確認しています。これにより、cloneNodeメソッドのディープコピーとシャローコピーの違いと、それぞれの結果を視覚的に理解することができます。