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

Copy
1<?php
2
3// Dom\DocumentFragment::cloneNode() メソッドの使用例を示します。
4// このメソッドは、指定されたDOMノードのコピーを作成します。
5// 特に「php clone とは」という文脈で、DOMオブジェクトの複製方法を理解するのに役立ちます。
6function demonstrateDomFragmentClone(): void
7{
8    // 1. DOMドキュメントを初期化します。
9    // DocumentFragmentを扱う際にも、内部的にDocumentインスタンスが必要です。
10    $dom = new Dom\Document();
11
12    // 2. 新しいDom\DocumentFragmentを作成します。
13    // これは、複数のノードを一時的に保持できる軽量なコンテナです。
14    $originalFragment = $dom->createDocumentFragment();
15
16    // 3. いくつかのHTML要素を作成し、元のフラグメントに追加します。
17    // これらの要素は、フラグメントの子ノードとなります。
18    $divElement = $dom->createElement('div');
19    $divElement->textContent = '元のコンテンツ1';
20    $originalFragment->appendChild($divElement);
21
22    $spanElement = $dom->createElement('span');
23    $spanElement->textContent = '元のコンテンツ2';
24    $originalFragment->appendChild($spanElement);
25
26    echo "--- 元の DocumentFragment の初期内容 ---" . PHP_EOL;
27    foreach ($originalFragment->childNodes as $node) {
28        echo "  - " . $node->nodeName . ": " . $node->textContent . PHP_EOL;
29    }
30    echo PHP_EOL;
31
32    // 4. cloneNodeメソッドを使用して、元のフラグメントの深いコピーを作成します。
33    // 引数に 'true' を指定することで、フラグメント自体だけでなく、
34    // そのすべての子ノード（ここでは div と span 要素）も完全にコピーされます。
35    // これにより、元のフラグメントとは完全に独立した新しいフラグメントが生成されます。
36    /** @var Dom\DocumentFragment|false $clonedFragment */
37    $clonedFragment = $originalFragment->cloneNode(true);
38
39    // cloneNodeは成功した場合にDom\Nodeを返します。期待される型に合致するか確認します。
40    if (!$clonedFragment instanceof Dom\DocumentFragment) {
41        echo "エラー: Dom\DocumentFragment のクローン作成に失敗しました。" . PHP_EOL;
42        return;
43    }
44
45    echo "--- クローンされた DocumentFragment の内容 ---" . PHP_EOL;
46    foreach ($clonedFragment->childNodes as $node) {
47        echo "  - " . $node->nodeName . ": " . $node->textContent . PHP_EOL;
48    }
49    echo PHP_EOL;
50
51    // 5. 元のフラグメントに新しいノードを追加して変更を加えます。
52    // これにより、元のフラグメントの内容が変わります。
53    $pElement = $dom->createElement('p');
54    $pElement->textContent = '元のフラグメントに追加された新しいコンテンツ';
55    $originalFragment->appendChild($pElement);
56
57    echo "--- 元の DocumentFragment の更新後の内容 ---" . PHP_EOL;
58    foreach ($originalFragment->childNodes as $node) {
59        echo "  - " . $node->nodeName . ": " . $node->textContent . PHP_EOL;
60    }
61    echo PHP_EOL;
62
63    // 6. クローンされたフラグメントの内容を再度確認します。
64    // cloneNode(true) で作成されたクローンは元のフラグメントとは独立しているため、
65    // 元のフラグメントに加えられた変更は、クローンには影響しません。
66    echo "--- クローンされた DocumentFragment の内容 (変更なしを確認) ---" . PHP_EOL;
67    foreach ($clonedFragment->childNodes as $node) {
68        echo "  - " . $node->nodeName . ": " . $node->textContent . PHP_EOL;
69    }
70    echo PHP_EOL;
71
72    echo "結論: cloneNode(true) は、ノードとその全ての子ノードの独立したコピーを作成します。" . PHP_EOL;
73}
74
75// 上記の関数を実行して、Dom\DocumentFragment::cloneNode の動作を確認します。
76demonstrateDomFragmentClone();

PHPのDom\DocumentFragment::cloneNodeメソッドは、指定されたDOMノードの正確なコピーを作成します。「php clone とは」という文脈で、DOMオブジェクトを複製する基本的な方法として理解できます。Dom\DocumentFragmentは、複数のノードを一時的に保持できる、軽量なコンテナです。

このメソッドの引数$deepは、コピーの深さを決定します。trueを指定すると、ノード自体だけでなく、そのすべての子ノードも再帰的にコピーされ、元のノードとは完全に独立した新しいノードが生成されます（深いコピー）。falseまたはnullの場合、ノード自体はコピーされますが、その子ノードはコピーされません（浅いコピー）。メソッドが成功すると、クローンされたDom\Node（この場合はDom\DocumentFragment）のインスタンスが返され、失敗した場合にはfalseが返されます。

サンプルコードでは、まずdiv要素とspan要素を含む元のDom\DocumentFragmentを作成します。次に、cloneNode(true)を呼び出し、このフラグメントの深いコピーを作成します。これにより、元のフラグメントと同じ内容を持ちながら、完全に独立した新しいフラグメントが生成されます。その後、元のフラグメントに新たなp要素を追加しますが、クローンされたフラグメントの内容には一切影響がないことを確認できます。これは、cloneNode(true)が元のノードとは独立した複製を作成するためです。このように、このメソッドを使うことで、既存のDOM構造を安全に複製し、そのコピーに対して自由に操作を加えることが可能になります。

Copy
1<?php
2
3/**
4 * Dom\DocumentFragment の cloneNode メソッドの使用例を示します。
5 * この関数は、HTML/XMLの断片 (DocumentFragment) を作成し、
6 * その内容を複製する方法を初心者にも分かりやすく解説します。
7 */
8function demonstrateCloneNodeForDocumentFragment(): void
9{
10    // 1. 新しいDOMドキュメントを作成します。
11    // DocumentFragment やその子ノードを作成するためには、基盤となるDocumentが必要です。
12    $dom = new Dom\Document();
13
14    // 2. Dom\DocumentFragment のインスタンスを作成します。
15    // DocumentFragment は、他のノードを一時的に保持するための軽量なコンテナであり、
16    // それ自体はHTML構造には表示されませんが、その子ノードは追加可能です。
17    $originalFragment = $dom->createDocumentFragment();
18
19    // 3. オリジナルのフラグメントに子ノードを追加します。
20    // ここでは、<p>要素と<span>要素を作成し、テキストコンテンツを設定してフラグメントに追加しています。
21    $paragraph = $dom->createElement('p', 'これはオリジナルの段落です。');
22    $span = $dom->createElement('span', 'これはオリジナルのスパンです。');
23    $originalFragment->appendChild($paragraph);
24    $originalFragment->appendChild($span);
25
26    echo "--- オリジナル DocumentFragment の内容 ---" . PHP_EOL;
27    // DocumentFragment 自体は直接HTMLとして出力できないため、その子ノードを一つずつ表示します。
28    foreach ($originalFragment->childNodes as $node) {
29        // saveHTML メソッドは、指定されたノードをHTML文字列として出力します。
30        echo $dom->saveHTML($node) . PHP_EOL;
31    }
32
33    // 4. cloneNode メソッドを使用してフラグメントを複製します。
34    // 引数 $deep に 'true' を指定すると、フラグメントの子ノードもすべて複製されます。
35    // 'false' を指定した場合、フラグメント自体は複製されますが、子ノードは複製されません。
36    $clonedFragment = $originalFragment->cloneNode(true);
37
38    echo PHP_EOL . "--- 複製された DocumentFragment の内容 (deep=true) ---" . PHP_EOL;
39    foreach ($clonedFragment->childNodes as $node) {
40        echo $dom->saveHTML($node) . PHP_EOL;
41    }
42
43    // 5. 複製が成功し、オリジナルのフラグメントとは異なる新しいオブジェクトが作成されたことを確認します。
44    // '===' 演算子は、オブジェクトが同じインスタンスであるかどうかを比較します。
45    echo PHP_EOL . "オリジナルと複製は同じオブジェクトですか？: " . ($originalFragment === $clonedFragment ? "はい" : "いいえ") . PHP_EOL; // 出力: いいえ
46
47    // 6. 複製されたフラグメントに新しいノードを追加してみます。
48    // これにより、複製されたフラグメントのみが変更され、オリジナルのフラグメントには影響がないことを示します。
49    $newElement = $dom->createElement('div', 'これは複製に追加された要素です。');
50    $clonedFragment->appendChild($newElement);
51
52    echo PHP_EOL . "--- 変更後の複製された DocumentFragment の内容 ---" . PHP_EOL;
53    foreach ($clonedFragment->childNodes as $node) {
54        echo $dom->saveHTML($node) . PHP_EOL;
55    }
56
57    echo PHP_EOL . "--- 変更されていないオリジナル DocumentFragment の内容 ---" . PHP_EOL;
58    foreach ($originalFragment->childNodes as $node) {
59        echo $dom->saveHTML($node) . PHP_EOL;
60    }
61}
62
63// 関数を実行して、Dom\DocumentFragment::cloneNode の動作を確認します。
64demonstrateCloneNodeForDocumentFragment();

PHP 8のDom\DocumentFragment::cloneNodeメソッドは、HTMLやXMLの要素の断片であるDom\DocumentFragmentオブジェクトを複製するために利用されます。このメソッドは、引数$deepにtrueを指定することで、フラグメントに含まれる子ノードもすべて含めて深く複製します。falseを指定するか省略した場合は、フラグメント自体は複製されますが、子ノードは複製されません。戻り値としては、新しく作成されたDom\DocumentFragmentオブジェクトが返され、複製に失敗した場合はfalseが返されます。

サンプルコードでは、まずDom\Documentを基盤としてDom\DocumentFragmentを作成し、そこに段落やスパンなどの子ノードを追加しています。その後、cloneNode(true)を呼び出すことで、このオリジナルのフラグメントとその子ノードを丸ごと複製し、新しい独立したフラグメントを作成しています。複製されたフラグメントはオリジナルのフラグメントとは異なるオブジェクトであり、一方のフラグメントにノードを追加しても、もう一方のフラグメントには影響がないことを確認できます。これにより、既存のDOM構造を破壊せずに再利用可能なHTML/XMLの断片を作成・操作できるようになります。