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

Copy
1<?php
2
3/**
4 * DOMDocumentFragment の cloneNode メソッドの使用例を示す関数。
5 * deep 引数の違い（子ノードを含めるか含めないか）を実演します。
6 * システムエンジニアを目指す初心者向けに、PHPでのDOMノードのクローン（複製）方法を説明します。
7 */
8function demonstrateDomFragmentCloneNode(): void
9{
10    echo "=== DOMDocumentFragment::cloneNode の使用例 ===\n\n";
11
12    // 1. DOMDocument の作成と DOMDocumentFragment の初期化
13    // DOMDocumentFragment は、複数のDOMノードを一時的に保持するための「入れ物」として機能します。
14    // これをDOMツリーに挿入すると、フラグメント自体ではなく、その中身（子ノード）が挿入されます。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $fragment = $dom->createDocumentFragment();
17
18    // フラグメントにいくつかの要素（ノード）を追加します。
19    // ここでは、<p>要素とその中に<span>要素を持つ複雑な構造を作成します。
20    $paragraph1 = $dom->createElement('p');
21    $paragraph1->appendChild($dom->createTextNode('これは'));
22    $spanElement = $dom->createElement('span', '強調されたテキスト');
23    $paragraph1->appendChild($spanElement);
24    $paragraph1->appendChild($dom->createTextNode('です。'));
25
26    $paragraph2 = $dom->createElement('p', 'これは2番目のパラグラフです。');
27
28    // これらの要素をフラグメントの子ノードとして追加します。
29    $fragment->appendChild($paragraph1);
30    $fragment->appendChild($paragraph2);
31
32    echo "--- 元の DOMDocumentFragment の内容 (子ノードを表示) ---\n";
33    // DOMDocumentFragment自体はXMLとして直接出力できないため、その子ノードの内容を表示して確認します。
34    foreach ($fragment->childNodes as $index => $node) {
35        if ($node instanceof DOMElement) {
36            echo "  子ノード {$index}: <{$node->tagName}> (テキストコンテンツ: " . (string)$node->textContent . ")\n";
37            // 子要素が存在する場合、さらに深く表示
38            foreach ($node->childNodes as $childNode) {
39                if ($childNode instanceof DOMElement) {
40                    echo "    - 子要素: <{$childNode->tagName}> (テキストコンテンツ: " . (string)$childNode->textContent . ")\n";
41                } elseif ($childNode instanceof DOMText) {
42                    echo "    - テキストノード: \"" . (string)$childNode->wholeText . "\"\n";
43                }
44            }
45        }
46    }
47    echo "\n";
48
49
50    // 2. cloneNode(false) で浅いクローンを作成
51    // 引数 `false` は、対象のノード自身のみを複製し、その子ノードは複製しないことを意味します。
52    // DOMDocumentFragment の場合、フラグメントオブジェクト自体は複製されますが、
53    // その中に含まれていた要素（子ノード）は複製されません。結果として空のフラグメントが生成されます。
54    // cloneNodeはDOMNodeクラスで定義されており、DOMDocumentFragmentがDOMNodeを継承しているため使用できます。
55    $clonedFragmentShallow = $fragment->cloneNode(false);
56
57    echo "--- cloneNode(false) (浅いクローン) で複製された DOMDocumentFragment の内容 ---\n";
58    if ($clonedFragmentShallow->hasChildNodes()) {
59        // 通常、DOMDocumentFragmentを浅くクローンすると子ノードは存在しません。
60        echo "エラー: 浅いクローンされたフラグメントが子ノードを持っています。\n";
61    } else {
62        echo "複製されたフラグメントは子ノードを持ちません (空です)。\n";
63        echo "これは、DOMDocumentFragment を deep=false でクローンすると、フラグメント自体は複製されますが、\n";
64        echo "その中に含まれていた要素は複製されないためです。要素を複製するには deep=true を使用します。\n";
65    }
66    echo "\n";
67
68    // 3. cloneNode(true) で深いクローンを作成
69    // 引数 `true` は、対象のノード自身とそのすべての子ノード、さらにその子孫ノードもすべて複製することを意味します。
70    // これにより、元のフラグメントと全く同じ内容（構造とテキスト）を持つ新しいフラグメントが生成されます。
71    $clonedFragmentDeep = $fragment->cloneNode(true);
72
73    echo "--- cloneNode(true) (深いクローン) で複製された DOMDocumentFragment の内容 ---\n";
74    if ($clonedFragmentDeep->hasChildNodes()) {
75        foreach ($clonedFragmentDeep->childNodes as $index => $node) {
76            if ($node instanceof DOMElement) {
77                echo "  子ノード {$index}: <{$node->tagName}> (テキストコンテンツ: " . (string)$node->textContent . ")\n";
78                // 深いクローンであることを示すため、子要素も表示
79                foreach ($node->childNodes as $childNode) {
80                    if ($childNode instanceof DOMElement) {
81                        echo "    - 子要素: <{$childNode->tagName}> (テキストコンテンツ: " . (string)$childNode->textContent . ")\n";
82                    } elseif ($childNode instanceof DOMText) {
83                        echo "    - テキストノード: \"" . (string)$childNode->wholeText . "\"\n";
84                    }
85                }
86            }
87        }
88    } else {
89        echo "エラー: 深いクローンが子ノードを持っていません。\n";
90    }
91    echo "\n";
92
93    // 4. クローンされたノードは元のノードとは別物であることを確認
94    // spl_object_id() は、オブジェクトの一意な識別子（ID）を返します。
95    // IDが異なることで、これらがメモリ上の異なるオブジェクトであることがわかります。
96    echo "--- クローンされたオブジェクトの同一性確認 ---\n";
97    echo "元のフラグメントのオブジェクトID: " . spl_object_id($fragment) . "\n";
98    echo "浅いクローンされたフラグメントのオブジェクトID: " . spl_object_id($clonedFragmentShallow) . "\n";
99    echo "深いクローンされたフラグメントのオブジェクトID: " . spl_object_id($clonedFragmentDeep) . "\n";
100    echo "これにより、それぞれがメモリ上の異なるオブジェクトであることがわかります。\n";
101}
102
103// 関数を実行して、DOMDocumentFragment::cloneNode の動作を確認します。
104demonstrateDomFragmentCloneNode();
105

PHPのDOMDocumentFragment::cloneNodeメソッドは、既存のDOMノード構造を複製するために利用されます。 DOMDocumentFragmentは、複数のDOMノードを一時的に保持するための「入れ物」のような役割を持つ特殊なノードです。 cloneNodeメソッドは、引数$deepによって複製（クローン）の深さを指定します。

$deepにfalseを指定すると「浅いクローン」が作成されます。これは、DOMDocumentFragmentオブジェクト自身は複製されますが、その中に含まれる子ノードは複製されません。したがって、結果として子ノードを持たない空のDOMDocumentFragmentが生成されます。 一方、$deepにtrueを指定すると「深いクローン」が作成されます。この場合、DOMDocumentFragmentオブジェクト自身だけでなく、その中に含まれるすべての子ノード、さらにはそれらの子孫ノードまですべてが完全に複製されます。これにより、元のフラグメントと全く同じ構造と内容を持つ新しいフラグメントが生成されます。

このメソッドは、複製に成功すると新しいDOMNodeオブジェクト（DOMDocumentFragmentのインスタンス）を返します。複製に失敗した場合はfalseが返されます。 複製されたオブジェクトは、元のオブジェクトとはメモリ上で異なる、完全に独立した新しいオブジェクトとなります。

Copy
1<?php
2
3/**
4 * DOMDocumentFragment::cloneNode メソッドのサンプルを示します。
5 *
6 * この関数は、DOMDocumentFragment を作成し、ノードを追加し、
7 * そしてそのフラグメントを複製する方法を、システムエンジニアを目指す初心者にも
8 * わかりやすいように説明します。
9 */
10function demonstrateDomFragmentCloneNode(): void
11{
12    // 1. DOMDocument インスタンスを作成
13    //    DOM ノード（要素やテキストなど）を作成するには、
14    //    そのノードが所属する DOMDocument オブジェクトが必要です。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力を見やすくするため、整形されたXMLを生成する設定（今回は直接XML出力しないが、良い習慣）
17    $dom->formatOutput = true;
18
19    // 2. 新しい DOMDocumentFragment を作成
20    //    DOMDocumentFragment は、複数のノードを一時的に保持するための軽量なコンテナです。
21    //    DOMツリーに直接追加せずに、ノードグループをまとめて操作する際に便利です。
22    $fragment = $dom->createDocumentFragment();
23
24    // 3. フラグメントに子ノードを追加
25    //    例として、<p>要素と、その子である<span>要素を追加します。
26    $paragraph1 = $dom->createElement('p', 'これは最初の段落です。');
27    $fragment->appendChild($paragraph1);
28
29    $span = $dom->createElement('span', '（スパン要素）');
30    $paragraph1->appendChild($span); // spanはparagraph1の子として追加されます
31
32    $paragraph2 = $dom->createElement('p', 'これは2番目の段落です。');
33    $fragment->appendChild($paragraph2);
34
35    echo "--- オリジナル DOMDocumentFragment の内容 ---\n";
36    // DOMDocumentFragment は単独で完全なXML文書ではないため、直接 `echo $fragment->saveXML();` はできません。
37    // そのため、ここではフラグメント内の各子ノードの内容を順番に表示します。
38    foreach ($fragment->childNodes as $node) {
39        // nodeName（タグ名など）と textContent（要素内のテキスト）を表示
40        echo "  - " . $node->nodeName . ": " . $node->textContent . "\n";
41    }
42    echo "------------------------------------------\n\n";
43
44    // 4. DOMDocumentFragment を複製（クローン）
45    //    `cloneNode(true)` は「深いコピー（deep copy）」を意味します。
46    //    これは、フラグメント自体だけでなく、その内部にあるすべての子ノード（例: <p>や<span>）も
47    //    再帰的に複製されることを意味します。
48    //    `false` を指定した場合（または引数を省略した場合）は、フラグメント自体は複製されますが、
49    //    子ノードは複製されず、新しいフラグメントは空になります。
50    $clonedFragment = $fragment->cloneNode(true);
51
52    // `cloneNode` メソッドは成功した場合に DOMNode オブジェクトを、
53    // 失敗した場合は `false` を返します。
54    if ($clonedFragment instanceof DOMDocumentFragment) {
55        echo "--- 複製された DOMDocumentFragment の内容 ---\n";
56        foreach ($clonedFragment->childNodes as $node) {
57            echo "  - " . $node->nodeName . ": " . $node->textContent . "\n";
58        }
59        echo "------------------------------------------\n\n";
60
61        // 複製されたフラグメントは、オリジナルとは全く別の独立したオブジェクトです。
62        // オリジナルを変更しても、複製されたフラグメントには影響しません。
63        echo "オリジナルと複製が別々のオブジェクトであることを確認します。\n";
64        // オリジナルの最初の段落の内容を変更してみます
65        if ($fragment->childNodes->length > 0 && $fragment->childNodes[0] instanceof DOMElement) {
66            $fragment->childNodes[0]->textContent = 'オリジナルの内容が変更されました！';
67        }
68
69        echo "--- オリジナル変更後の DOMDocumentFragment ---\n";
70        foreach ($fragment->childNodes as $node) {
71            echo "  - " . $node->nodeName . ": " . $node->textContent . "\n";
72        }
73        echo "--- 複製された DOMDocumentFragment (変更なし) ---\n";
74        foreach ($clonedFragment->childNodes as $node) {
75            echo "  - " . $node->nodeName . ": " . $node->textContent . "\n";
76        }
77        echo "------------------------------------------\n\n";
78
79    } else {
80        echo "エラー: DOMDocumentFragment の複製に失敗しました。\n";
81    }
82}
83
84// サンプルコードを実行します。
85demonstrateDomFragmentCloneNode();
86

DOMDocumentFragment::cloneNodeメソッドは、PHPのDOM操作において、複数のノードを一時的にまとめる役割を持つDOMDocumentFragmentオブジェクトを複製するために使用されます。このメソッドは、指定されたフラグメントとその内容のコピーを作成します。

引数$deepには真偽値（trueまたはfalse）を指定します。$deepをtrueに設定すると、元のフラグメントだけでなく、その内部に含まれるすべての子ノードも再帰的に複製され、内容が全く同じで独立した新しいフラグメントが生成されます（ディープコピー）。一方、falseを指定した場合（または引数を省略した場合）、フラグメント自体は複製されますが、子ノードは複製されず、新しいフラグメントは空になります（シャローコピー）。

メソッドの戻り値は、複製が成功した場合は新しいDOMDocumentFragmentオブジェクト、失敗した場合はfalseとなります。

提供されたサンプルコードでは、DOMDocumentFragmentを作成し、その中に<p>要素や<span>要素を追加しています。その後、cloneNode(true)を使用してフラグメントを内容ごと完全に複製し、複製されたフラグメントがオリジナルとは独立したオブジェクトであり、一方の変更がもう一方に影響しないことを確認しています。これは、既存のDOM構造を改変せずに、その一部を再利用したい場合に非常に役立つ機能です。