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

Copy
1<?php
2
3// Dom\Text::cloneNode() メソッドの動作をデモンストレーションする関数
4function demonstrateDomTextCloneNode(): void
5{
6    // 1. 新しい DOMDocument を作成します。
7    // XML バージョンとエンコーディングを指定します。
8    $dom = new DOMDocument('1.0', 'UTF-8');
9    $dom->formatOutput = true; // 出力を見やすくするための設定
10
11    // 2. ルート要素 <root> を作成し、DOM に追加します。
12    $root = $dom->createElement('root');
13    $dom->appendChild($root);
14
15    // 3. テキストノードを保持するための要素 <message> を作成し、<root> に追加します。
16    $messageElement = $dom->createElement('message');
17    $root->appendChild($messageElement);
18
19    // 4. 元になるテキストノードを作成し、<message> 要素に追加します。
20    // Dom\Text は DOMText クラスのエイリアスで、PHP 8 で推奨される型です。
21    $originalText = $dom->createTextNode('Hello, PHP DOM Text Node!');
22    $messageElement->appendChild($originalText);
23
24    echo "--- 元のDOM構造 ---\n";
25    echo $dom->saveXML();
26    echo "元のテキストノードの値: " . $originalText->nodeValue . "\n";
27    echo "元のテキストノードのオブジェクトID: " . spl_object_id($originalText) . "\n\n";
28
29    // 5. originalText ノードを複製します。
30    // cloneNode メソッドは、現在のノードの複製を作成します。
31    // 引数 $deep は、子ノードも再帰的に複製するかどうかを決めます。
32    // Dom\Text ノードは子ノードを持たないため、$deep が true でも false (デフォルト値) でも動作に違いはありません。
33    // 戻り値は Dom\Node 型ですが、今回は Dom\Text の複製なので、Dom\Text として扱えます。
34    $clonedText = $originalText->cloneNode(false);
35
36    echo "--- 複製されたテキストノードの情報 ---\n";
37    echo "複製されたテキストノードの値: " . $clonedText->nodeValue . "\n";
38    echo "複製されたテキストノードのオブジェクトID: " . spl_object_id($clonedText) . "\n";
39
40    // 元のノードと複製されたノードが異なるオブジェクトであることを確認します。
41    // `clone` とは、既存のオブジェクトと同じプロパティを持つ新しいオブジェクトを作成することです。
42    // これにより、元のオブジェクトとは独立して扱えるようになります。
43    if (spl_object_id($originalText) !== spl_object_id($clonedText)) {
44        echo "=> 異なるオブジェクトとして複製されました。\n";
45    } else {
46        echo "=> 複製に失敗したか、予期せぬ挙動が発生しました (同じオブジェクトです)。\n";
47    }
48
49    // 複製されたノードは、`cloneNode` を実行した時点ではまだ DOM ツリーには追加されていません。
50    // 新しい要素を作成し、複製されたノードをそこに追加してみましょう。
51    $copiedMessageElement = $dom->createElement('copied_message');
52    $root->appendChild($copiedMessageElement);
53    $copiedMessageElement->appendChild($clonedText); // 複製されたノードを DOM ツリーに追加
54
55    echo "\n--- 複製されたノードをDOMに追加後の構造 ---\n";
56    echo $dom->saveXML();
57
58    // 複製されたノードの値を変更して、元のノードに影響がないことを確認します。
59    // これにより、複製が元のオブジェクトとは独立したものであることが証明されます。
60    $clonedText->nodeValue = "This is a cloned and modified text node.";
61
62    echo "\n--- 複製されたノードの値を変更した後 ---\n";
63    echo "元のテキストノードの値: " . $originalText->nodeValue . "\n";
64    echo "複製されたテキストノードの値: " . $clonedText->nodeValue . "\n";
65    echo "元のノードの値は変更されていないため、複製が独立したオブジェクトであることが確認できます。\n";
66
67    echo "\n--- 複製されたノード変更後の最終DOM構造 ---\n";
68    echo $dom->saveXML();
69}
70
71// 関数を実行してデモンストレーションを開始します。
72demonstrateDomTextCloneNode();

Dom\Text::cloneNode() メソッドは、既存のテキストノードの複製（コピー）を新しく作成するための機能です。これは、元のテキストノードと同じ内容を持つ、全く新しい独立したテキストノードオブジェクトを生成することを意味します。その結果として、元のテキストノードとは異なるオブジェクトとして扱えるようになります。

メソッドの引数である $deep は、通常は子ノードも再帰的に複製するかどうかを制御しますが、Dom\Text ノードは子ノードを持たないため、この引数の値は動作に影響を与えません。戻り値は複製された新しい Dom\Node オブジェクト（具体的には Dom\Text オブジェクト）です。この新しいノードは、cloneNode が呼ばれた時点ではまだ DOM ツリーには追加されていません。そのため、必要に応じて appendChild() などのメソッドを使って明示的に DOM ツリーのどこかに追加する必要があります。

サンプルコードでは、まず「Hello, PHP DOM Text Node!」という値を持つ元のテキストノードを作成し、そのノードを cloneNode() メソッドで複製しています。spl_object_id 関数を使って、元のノードと複製されたノードがメモリー上で別々のオブジェクトであることが確認できます。さらに、複製されたノードの値を変更しても元のノードの値には全く影響しないことを示しており、両者が完全に独立した存在であることを明確にデモンストレーションしています。このように、cloneNode を利用することで、元のデータ構造を保ちつつ、そのコピーを自由に操作できるようになります。

Copy
1<?php
2
3/**
4 * DOM\Text::cloneNode() メソッドの使用例。
5 * テキストノードを複製する方法を示します。
6 * Dom\Text ノードは子ノードを持たないため、$deep 引数の値は結果に影響しません。
7 */
8function demonstrateTextNodeCloning(): void
9{
10    // 1. 新しい DOMDocument を作成します。これはHTMLやXMLドキュメントを扱うための基盤です。
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true; // 出力されるHTMLを見やすく整形します。
13
14    // 2. ルート要素として <p> タグを作成し、ドキュメントに追加します。
15    $paragraphElement = $dom->createElement('p');
16    $dom->appendChild($paragraphElement);
17
18    // 3. オリジナルの Dom\Text ノードを作成します。
19    //    これは単なるテキストコンテンツであり、子ノードを持つことはできません。
20    $originalTextNode = $dom->createTextNode('これはオリジナルのテキストです。');
21    $paragraphElement->appendChild($originalTextNode); // ドキュメントツリーにテキストノードを追加します。
22
23    echo "--- オリジナルノードの情報 ---" . PHP_EOL;
24    echo "値: " . $originalTextNode->nodeValue . PHP_EOL;
25    echo "クラス: " . get_class($originalTextNode) . PHP_EOL . PHP_EOL;
26
27    // 4. Dom\Text::cloneNode() メソッドを使用して、オリジナルのテキストノードを複製します。
28    //    Dom\Text ノードは子を持たないため、$deep (深く複製するかどうか) 引数は true でも false でも同じ結果になります。
29    //    ここでは明示的に false を指定してみます。
30    $clonedTextNode = $originalTextNode->cloneNode(false);
31
32    echo "--- 複製ノードの情報 ---" . PHP_EOL;
33    echo "値: " . $clonedTextNode->nodeValue . PHP_EOL;
34    echo "クラス: " . get_class($clonedTextNode) . PHP_EOL . PHP_EOL;
35
36    // 5. 複製されたノードはまだDOMツリーには追加されていません。
37    //    新しい要素を作成し、その中に複製ノードを追加して、動作を確認します。
38    $anotherParagraphElement = $dom->createElement('p');
39    $dom->appendChild($anotherParagraphElement);
40    $anotherParagraphElement->appendChild($clonedTextNode); // 複製ノードを新しい要素に追加します。
41
42    echo "--- DOMツリーの状態 (HTML形式) ---" . PHP_EOL;
43    // ドキュメント全体をHTML形式で出力します。
44    // 最初の段落にはオリジナルノードが、2番目の段落には複製ノードが含まれていることがわかります。
45    echo $dom->saveHTML();
46}
47
48// 関数の実行
49demonstrateTextNodeCloning();
50
51?>

Dom\Text::cloneNode()メソッドは、DOMツリーを操作する際に、既存のテキストノードを複製するために使用します。このメソッドを呼び出すと、元のテキストノードと全く同じテキスト内容を持つ新しいテキストノードを作成します。

引数$deepは真偽値を取り、通常は、ノードとその子孫ノードまで含めて複製するかどうかを決定します。しかし、Dom\Textクラスのノードはテキストコンテンツのみを持ち、子ノードを持つことができません。そのため、$deepにtrueを設定してもfalseを設定しても、複製の結果には影響しません。テキストノード自体が持つテキストコンテンツのみが複製されます。

メソッドの戻り値は、複製された新しいDom\Textオブジェクトです。この新しいオブジェクトは元のノードと同じテキスト内容を持ちますが、DOMツリー上では完全に独立したノードとして存在します。複製されたノードは、cloneNode()の呼び出し時点ではまだどのDOMツリーにも追加されていません。サンプルコードでは、複製されたテキストノードを別の段落要素に追加することで、それが独立したノードとして扱われ、既存のDOMツリーに影響を与えずに再利用できることを確認できます。この機能により、既存のDOM構造を改変することなく、同じテキストコンテンツを効率的に再利用して新たなDOM要素を構築できます。