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

Copy
1<?php
2
3/**
4 * PHPのDOMDocumentオブジェクトを利用して、ノードを複製する例。
5 * 「php clone とは」という文脈で、DOMノードの複製方法を示します。
6 * DOMNode::cloneNode() メソッドは、指定されたノードのコピーを作成します。
7 * 引数 $deep の違いにより、子ノードも一緒に複製するかどうかが変わります。
8 */
9function demonstrateNodeCloning(): void
10{
11    // 1. DOMDocumentのインスタンスを作成
12    // XMLバージョンとエンコーディングを指定します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力XMLを見やすくするためにフォーマット設定を有効にします。
15    $dom->formatOutput = true;
16
17    // 2. ルート要素を作成し、DOMドキュメントに追加
18    $root = $dom->createElement('root');
19    $dom->appendChild($root);
20
21    // 3. 複製元の親要素を作成
22    $originalParent = $dom->createElement('parent');
23    $originalParent->setAttribute('id', 'original-parent'); // IDを設定
24    $root->appendChild($originalParent);
25
26    // 4. 複製元の子要素とテキストノードを作成し、親要素に追加
27    $childElement = $dom->createElement('child');
28    $childElement->setAttribute('data-attr', 'value');
29    $originalParent->appendChild($childElement);
30
31    $textNode = $dom->createTextNode('Hello, PHP DOM Clone!');
32    $childElement->appendChild($textNode);
33
34    echo "--- 元のDOMツリー --- \n";
35    echo $dom->saveXML() . "\n";
36
37    // --- cloneNode(false) の使用例: 浅いコピー ---
38    // 引数 $deep を false に設定すると、対象ノードのみを複製し、
39    // その子ノードは複製されません。
40    echo "--- cloneNode(false): 浅いコピー --- \n";
41    $clonedShallow = $originalParent->cloneNode(false);
42    $clonedShallow->setAttribute('id', 'cloned-shallow-parent'); // 複製後のIDを変更
43    $root->appendChild($clonedShallow); // 複製したノードをDOMツリーに追加
44
45    echo $dom->saveXML() . "\n";
46    echo "注目: 'original-parent' の子ノードはコピーされず、'cloned-shallow-parent' は空です。\n\n";
47
48    // --- cloneNode(true) の使用例: 深いコピー ---
49    // 引数 $deep を true に設定すると、対象ノードとそのすべての子ノード、
50    // およびそれらの属性もすべて再帰的に複製されます。
51    echo "--- cloneNode(true): 深いコピー --- \n";
52    $clonedDeep = $originalParent->cloneNode(true);
53    $clonedDeep->setAttribute('id', 'cloned-deep-parent'); // 複製後のIDを変更
54    $root->appendChild($clonedDeep); // 複製したノードをDOMツリーに追加
55
56    echo $dom->saveXML() . "\n";
57    echo "注目: 'original-parent' の子ノードとテキストもコピーされ、'cloned-deep-parent' に含まれています。\n\n";
58}
59
60// 関数を実行してDOMノードの複製を実演
61demonstrateNodeCloning();
62
63?>

このPHPサンプルコードは、「php clone とは」という文脈で、DOM（Document Object Model）ノードを複製する方法を実演しています。PHPのDOMNode::cloneNode()メソッドは、既存のDOMノードのコピーを作成するために使用されます。このメソッドは、指定されたノード自身を複製し、新しいDOMNodeオブジェクトとして返します。

引数$deepは、ノードの複製方法を制御する重要なブール値です。$deepをfalseに設定すると、ノード自身のみが複製され、そのノードが持つ子ノードはコピーされません。これは「浅いコピー」と呼ばれ、サンプルコードではoriginalParentノードを浅くコピーした際に、その子ノードであるchild要素やテキストノードが含まれないことを示しています。

一方、$deepをtrueに設定すると、対象ノードとそのすべての子ノード、さらに子孫ノードまで再帰的に、その属性も含めて完全に複製されます。これは「深いコピー」と呼ばれ、サンプルコードではoriginalParentノードを深くコピーした際に、child要素やテキストノードもすべて複製されたclonedDeepノードが生成される様子を確認できます。

この機能は、既存のDOM構造の一部を再利用したり、テンプレートとして利用して新しい類似の要素を作成したりする際に非常に役立ちます。複製されたノードは、元のDOMツリーに属さず独立しているため、その後自由にDOMツリーの任意の場所に挿入したり、内容を変更したりすることができます。

Copy
1<?php
2
3/**
4 * DOMEntity::cloneNode メソッドの使用例を示します。
5 * DOMEntity は XML ドキュメントの DTD で定義されたエンティティを表します。
6 * cloneNode メソッドは、ノードの複製を作成するために使用されます。
7 */
8function demonstrateDomEntityClone(): void
9{
10    // DOMDocument インスタンスを作成し、XML ドキュメントをロードします。
11    // ここでは、DTD (Document Type Definition) 内で 'my_entity' というエンティティを定義しています。
12    // エンティティの内容にはテキストと要素（<b>タグ）を含め、$deep 引数の効果がわかるようにします。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $xmlString = <<<XML
15<!DOCTYPE root [
16  <!ENTITY my_entity "This is <b>my entity</b> content.">
17]>
18<root>
19    <item>&my_entity;</item>
20</root>
21XML;
22    $dom->loadXML($xmlString);
23
24    // ドキュメントの DOCTYPE ノードを取得します。
25    $domType = $dom->doctype;
26
27    if (!$domType instanceof DOMDocumentType) {
28        echo "エラー: DOCTYPE が見つかりませんでした。\n";
29        return;
30    }
31
32    // DOCTYPE からエンティティのリスト (DOMNamedNodeMap) を取得します。
33    $entities = $domType->entities;
34
35    // 定義したエンティティ 'my_entity' をリストから取得します。
36    $originalEntity = $entities->getNamedItem('my_entity');
37
38    if (!$originalEntity instanceof DOMEntity) {
39        echo "エラー: 指定されたエンティティ 'my_entity' が見つかりませんでした。\n";
40        return;
41    }
42
43    echo "--- 元の DOMEntity の情報 ---\n";
44    echo "  nodeName: " . $originalEntity->nodeName . "\n";
45    echo "  nodeValue: '" . $originalEntity->nodeValue . "'\n"; // エンティティの内容全体
46    echo "  子ノード数: " . $originalEntity->childNodes->length . "\n";
47    // 子ノードの内訳を表示 (例: テキストノード、要素ノード)
48    foreach ($originalEntity->childNodes as $child) {
49        echo "    - 子ノード: " . $child->nodeName . " (型: " . $child->nodeType . ") 値: '" . $child->nodeValue . "'\n";
50    }
51    echo "\n";
52
53    // --- 深いクローン (deep = true) の例 ---
54    // cloneNode(true) は、ノード自身とそのすべての子ノードを再帰的に複製します。
55    echo "--- 深いクローン (cloneNode(true)) の例 ---\n";
56    $clonedEntityDeep = $originalEntity->cloneNode(true);
57
58    echo "クローンされた DOMEntity (deep=true) の情報:\n";
59    echo "  nodeName: " . $clonedEntityDeep->nodeName . "\n";
60    echo "  nodeValue: '" . $clonedEntityDeep->nodeValue . "'\n";
61    echo "  子ノード数: " . $clonedEntityDeep->childNodes->length . "\n";
62    foreach ($clonedEntityDeep->childNodes as $child) {
63        echo "    - 子ノード: " . $child->nodeName . " (型: " . $child->nodeType . ") 値: '" . $child->nodeValue . "'\n";
64    }
65    echo "\n";
66
67    // 元のエンティティと深いクローンが異なるオブジェクトであることを確認します。
68    if ($originalEntity !== $clonedEntityDeep) {
69        echo "✔ 元の DOMEntity と深いクローンは異なるオブジェクトです。\n";
70    } else {
71        echo "✗ エラー: 元の DOMEntity と深いクローンが同じオブジェクトです。\n";
72    }
73
74    // プロパティと子ノードの数が元のものと同じであることを確認します。
75    if (
76        $originalEntity->nodeName === $clonedEntityDeep->nodeName &&
77        $originalEntity->nodeValue === $clonedEntityDeep->nodeValue &&
78        $originalEntity->childNodes->length === $clonedEntityDeep->childNodes->length
79    ) {
80        echo "✔ 深いクローンされた DOMEntity のプロパティと子ノード数は元のものと同じです。\n";
81    } else {
82        echo "✗ エラー: 深いクローンされた DOMEntity のプロパティまたは子ノード数が異なります。\n";
83    }
84    echo "\n";
85
86    // --- 浅いクローン (deep = false) の例 ---
87    // cloneNode(false) は、ノード自身のみを複製し、子ノードは複製しません。
88    echo "--- 浅いクローン (cloneNode(false)) の例 ---\n";
89    $clonedEntityShallow = $originalEntity->cloneNode(false);
90
91    echo "クローンされた DOMEntity (deep=false) の情報:\n";
92    echo "  nodeName: " . $clonedEntityShallow->nodeName . "\n";
93    echo "  nodeValue: '" . $clonedEntityShallow->nodeValue . "'\n";
94    echo "  子ノード数: " . $clonedEntityShallow->childNodes->length . "\n";
95    foreach ($clonedEntityShallow->childNodes as $child) {
96        echo "    - 子ノード: " . $child->nodeName . " (型: " . $child->nodeType . ") 値: '" . $child->nodeValue . "'\n";
97    }
98    echo "\n";
99
100    // 元のエンティティと浅いクローンが異なるオブジェクトであることを確認します。
101    if ($originalEntity !== $clonedEntityShallow) {
102        echo "✔ 元の DOMEntity と浅いクローンは異なるオブジェクトです。\n";
103    } else {
104        echo "✗ エラー: 元の DOMEntity と浅いクローンが同じオブジェクトです。\n";
105    }
106
107    // プロパティは同じですが、子ノードがクローンされていないことを確認します。
108    if (
109        $originalEntity->nodeName === $clonedEntityShallow->nodeName &&
110        $originalEntity->nodeValue === $clonedEntityShallow->nodeValue &&
111        $clonedEntityShallow->childNodes->length === 0 // 浅いクローンなので子ノードは0
112    ) {
113        echo "✔ 浅いクローンされた DOMEntity のプロパティは元のものと同じですが、子ノードはクローンされていません。\n";
114    } else {
115        echo "✗ エラー: 浅いクローンされた DOMEntity のプロパティまたは子ノードの状態が想定と異なります。\n";
116    }
117}
118
119// 関数を呼び出してサンプルコードを実行します。
120demonstrateDomEntityClone();
121
122?>

PHPのDOMEntity::cloneNodeメソッドは、XMLドキュメントのDTD（文書型定義）に定義されたエンティティを表すDOMEntityオブジェクトを複製するために使用します。このメソッドは、元のノードのコピーを生成し、新しいDOMNodeオブジェクトを返します。

引数$deep（真偽値）は複製方法を制御します。trueを指定すると、ノード自身とそのすべての子ノード、属性も再帰的に複製される「深いクローン」が作成され、元のノードと全く同じ構造を持つ独立したノードツリーが得られます。一方、falseを指定すると、ノード自身のみを複製する「浅いクローン」となり、子ノードは複製されません。

戻り値は、複製された新しいDOMNodeオブジェクトです。このノードは元のドキュメントから独立しており、自由に利用できます。サンプルコードでは、XMLエンティティを例に、$deep引数をtrueとfalseに設定した場合の複製結果を比較し、子ノードの有無を通じてそれぞれの挙動の違いを具体的に示しています。