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

Copy
1<?php
2
3/**
4 * DOMComment::cloneNode() メソッドの使用例。
5 * コメントノードを複製し、元のノードと複製されたノードが異なるオブジェクトであることを示します。
6 */
7function demonstrateDomCommentCloneNode(): void
8{
9    // DOMDocument のインスタンスを作成
10    $dom = new DOMDocument('1.0', 'UTF-8');
11    $dom->formatOutput = true; // 出力整形を有効にする
12
13    // ルート要素を作成し、ドキュメントに追加
14    $root = $dom->createElement('root');
15    $dom->appendChild($root);
16
17    // 元のコメントノードを作成し、ルート要素に追加
18    $originalCommentText = 'これは元のコメントです';
19    $originalComment = $dom->createComment($originalCommentText);
20    $root->appendChild($originalComment);
21
22    echo "--- 元のコメントノード ---" . PHP_EOL;
23    echo "値: " . $originalComment->nodeValue . PHP_EOL;
24    echo "オブジェクトハッシュ: " . spl_object_hash($originalComment) . PHP_EOL;
25    echo PHP_EOL;
26
27    // cloneNode メソッドを使ってコメントノードを複製
28    // DOMCommentには子ノードがないため、$deep引数は実質的な違いはありません。
29    $clonedComment = $originalComment->cloneNode(true); 
30
31    // 複製されたノードがDOMCommentインスタンスであることを確認
32    if ($clonedComment instanceof DOMComment) {
33        echo "--- 複製されたコメントノード ---" . PHP_EOL;
34        echo "値: " . $clonedComment->nodeValue . PHP_EOL;
35        echo "オブジェクトハッシュ: " . spl_object_hash($clonedComment) . PHP_EOL;
36        echo PHP_EOL;
37    } else {
38        echo "エラー: cloneNode() が期待されるオブジェクトを返しませんでした。" . PHP_EOL;
39    }
40
41    echo "--- 比較 ---" . PHP_EOL;
42    echo "元のコメントノードと複製されたコメントノードは同じ内容を持ちますが、異なるオブジェクトです。" . PHP_EOL;
43    echo "内容の一致 (\$originalComment->nodeValue === \$clonedComment->nodeValue): " . ($originalComment->nodeValue === $clonedComment->nodeValue ? 'true' : 'false') . PHP_EOL;
44    echo "オブジェクトの同一性 (\$originalComment === \$clonedComment): " . ($originalComment === $clonedComment ? 'true' : 'false') . PHP_EOL;
45}
46
47// 関数の実行
48demonstrateDomCommentCloneNode();

DOMComment::cloneNode() は、PHPのDOM拡張機能で提供されるメソッドで、既存のコメントノードを複製する際に使用されます。このメソッドを呼び出すと、元のコメントノードのテキスト内容を完全に引き継いだ、新しい独立したコメントノードが生成されます。

引数 $deep は論理値で、通常、true を指定すると対象ノードとその子ノードすべてを再帰的に複製し、false の場合は対象ノードのみを複製します。しかし、DOMCommentクラスのインスタンスであるコメントノードは子ノードを持たないため、この $deep 引数は実質的な挙動に影響を与えません。メソッドは戻り値として、複製された新しい DOMNode オブジェクトを返します。この戻り値は元のノードと同じ情報を持ちますが、メモリ上では全く別のオブジェクトとして存在します。

サンプルコードでは、まず DOMDocument 内にテキスト「これは元のコメントです」を持つコメントノードを作成します。次に、この元のコメントノードに対して cloneNode() メソッドを適用し、新しいコメントノードを生成しています。出力結果を見ると、元のノードと複製されたノードは、ノードの値（テキスト内容）が完全に一致しているものの、それぞれのオブジェクトハッシュ値が異なることが確認できます。これは、複製されたノードが元のノードとは独立した存在であり、新しいノードの内容を変更しても元のノードには影響しないことを示しています。この機能は、DOMツリー内の特定のノードをテンプレートとして利用し、それを元に複数の類似ノードを作成したい場合などに役立ちます。

Copy
1<?php
2
3/**
4 * DOMComment::cloneNode() メソッドの使用例。
5 *
6 * このスクリプトは、DOMComment ノードを作成し、
7 * そのノードを cloneNode() メソッドで複製する方法を示します。
8 * DOMComment ノードは子ノードを持たないため、$deep 引数の値は
9 * 結果に影響を与えませんが、メソッドの基本的な使用法を理解できます。
10 */
11
12// 1. 新しい DOMDocument を作成します。
13$dom = new DOMDocument('1.0', 'UTF-8');
14$dom->formatOutput = true; // 出力を整形するために設定（オプション）
15
16// 2. 元になるコメントノードを作成します。
17$originalCommentText = "これはオリジナルのコメントです。";
18$originalComment = $dom->createComment($originalCommentText);
19
20// 3. 作成したコメントノードを DOMDocument に追加します。(オプション)
21// これにより、コメントがドキュメントツリーの一部になります。
22$dom->appendChild($originalComment);
23
24echo "--- オリジナルコメントの情報 ---\n";
25echo "テキスト: " . $originalComment->nodeValue . "\n";
26echo "DOMDocumentへの所属: " . spl_object_hash($originalComment->ownerDocument) . "\n";
27echo "親ノードの有無: " . ($originalComment->parentNode ? "あり" : "なし") . "\n";
28echo "オブジェクトID: " . spl_object_hash($originalComment) . "\n\n";
29
30// 4. cloneNode() メソッドを使用してコメントノードを複製します。
31// cloneNode(false) は子ノードを複製しませんが、DOMComment に子ノードはないため、
32// cloneNode(true) と結果は同じになります。
33$clonedComment = $originalComment->cloneNode(false);
34
35echo "--- クローンされたコメントの情報 ---\n";
36echo "テキスト: " . $clonedComment->nodeValue . "\n";
37echo "DOMDocumentへの所属: " . spl_object_hash($clonedComment->ownerDocument) . "\n";
38echo "親ノードの有無: " . ($clonedComment->parentNode ? "あり" : "なし") . " (クローンされたノードはまだDOMツリーに追加されていません)\n";
39echo "オブジェクトID: " . spl_object_hash($clonedComment) . "\n\n";
40
41// 5. オリジナルとクローンされたコメントが異なるオブジェクトであることを確認します。
42if (spl_object_hash($originalComment) !== spl_object_hash($clonedComment)) {
43    echo "✔ 確認: オリジナルとクローンされたコメントは別々のオブジェクトです。\n";
44} else {
45    echo "❌ エラー: オリジナルとクローンされたコメントが同じオブジェクトです。\n";
46}
47
48// 備考: クローンされたコメントは、作成時点ではDOMDocumentのツリーには追加されていません。
49// 必要に応じて、$dom->appendChild($clonedComment); のようにして、DOMツリーに追加できます。
50?>

PHPのDOMComment::cloneNode()メソッドは、既存のDOMコメントノードを複製し、新しい独立したコメントノードを作成するために使用されます。このメソッドは、$deepというブール型の引数を一つ取りますが、DOMCommentノードは子ノードを持たないため、trueを指定してもfalseを指定しても結果に違いはありません。どちらの場合も、コメントのテキスト内容が複製され、新しいDOMCommentオブジェクトが生成されます。

メソッドの戻り値は複製された新しいDOMNodeオブジェクト（この場合はDOMCommentオブジェクト）です。この新しいノードは元のノードとは完全に別のオブジェクトであり、元のノードの変更が複製されたノードに影響を与えることはありません。

提供されたサンプルコードでは、まず「これはオリジナルのコメントです。」というテキストを持つDOMCommentノードを作成し、それをcloneNode(false)を使って複製しています。コードの出力では、オリジナルとクローンされたコメントがテキスト内容を共有しつつも、異なるオブジェクトIDを持つ別々のインスタンスであることが確認できます。複製されたコメントノードは、生成された時点ではどのDOMDocumentツリーにも所属していないため、必要に応じて明示的にappendChild()などのメソッドを使ってDOMツリーに追加する必要があります。