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

Copy
1<?php
2
3/**
4 * DOMCharacterData::cloneNode の使用例を示す関数。
5 * システムエンジニアを目指す初心者向けに、DOMノードのクローン処理を簡潔に説明します。
6 *
7 * キーワード「php clone とは」に対し、DOMツリーにおけるノードの複製方法を示します。
8 * DOMCharacterData はテキストやコメントなどのノードの基底クラスです。
9 */
10function demonstrateDomCharacterDataClone(): void
11{
12    // 1. DOMDocument オブジェクトを作成します。これはXMLドキュメントのルートとして機能します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 出力を見やすくするため
15
16    // 2. DOMText オブジェクト（DOMCharacterData のサブクラス）を作成します。
17    //    これはクローン元となるテキストノードです。
18    $originalTextNode = $dom->createTextNode('元のテキストデータ');
19
20    // 3. 元のテキストノードをドキュメントに追加します。
21    //    DOMTextノードは通常、要素ノードの子として追加されます。
22    $rootElement = $dom->createElement('example');
23    $rootElement->appendChild($originalTextNode);
24    $dom->appendChild($rootElement);
25
26    echo "--- 元のノードの状態 ---" . PHP_EOL;
27    echo "ノード名: " . $originalTextNode->nodeName . PHP_EOL;
28    echo "ノード値: '" . $originalTextNode->nodeValue . "'" . PHP_EOL;
29    echo "ドキュメントツリー全体:\n" . $dom->saveXML() . PHP_EOL;
30
31    // 4. cloneNode() メソッドを使ってノードをクローンします。
32    //    引数 $deep は false で、元のノードとその子ノード（もしあれば）を複製するかどうかを制御します。
33    //    DOMCharacterData (テキストノード、コメントノードなど) は子ノードを持たないため、
34    //    $deep の値 (true/false) はこの場合は結果に影響しません。
35    $clonedTextNodeShallow = $originalTextNode->cloneNode(false);
36
37    echo "--- クローンされたノード (deep = false) の状態 ---" . PHP_EOL;
38    echo "ノード名: " . $clonedTextNodeShallow->nodeName . PHP_EOL;
39    echo "ノード値: '" . $clonedTextNodeShallow->nodeValue . "'" . PHP_EOL;
40    // クローンされたノードは元のノードとは異なる新しいオブジェクトです。
41    echo "元のノードとは異なるオブジェクトか: " . ($originalTextNode === $clonedTextNodeShallow ? 'いいえ (同じオブジェクト)' : 'はい (異なるオブジェクト)') . PHP_EOL;
42    echo PHP_EOL;
43
44    // 5. クローンされたノードの内容を変更しても、元のノードには影響しないことを示します。
45    $clonedTextNodeShallow->nodeValue = '変更されたクローンデータ';
46
47    echo "--- クローンされたノード変更後の状態 ---" . PHP_EOL;
48    echo "元のノード値: '" . $originalTextNode->nodeValue . "'" . PHP_EOL;
49    echo "変更されたクローンノード値: '" . $clonedTextNodeShallow->nodeValue . "'" . PHP_EOL;
50    echo PHP_EOL;
51
52    // 参考: $deep = true の場合も試しますが、DOMCharacterData では動作に違いはありません。
53    $clonedTextNodeDeep = $originalTextNode->cloneNode(true);
54    echo "--- クローンされたノード (deep = true) の状態 ---" . PHP_EOL;
55    echo "ノード名: " . $clonedTextNodeDeep->nodeName . PHP_EOL;
56    echo "ノード値: '" . $clonedTextNodeDeep->nodeValue . "'" . PHP_EOL;
57    echo "deep=false の場合とノード値は同じか: " . ($clonedTextNodeShallow->nodeValue === $clonedTextNodeDeep->nodeValue ? 'はい' : 'いいえ') . PHP_EOL;
58    echo PHP_EOL;
59}
60
61// 関数を実行してサンプルコードの動作を確認します。
62demonstrateDomCharacterDataClone();

「php clone とは」という疑問に対し、PHPのDOM操作におけるノードの複製方法をDOMCharacterData::cloneNodeメソッドを使って説明します。このメソッドは、XMLやHTMLなどのDOMツリーを扱う際に、既存のノードの全く新しいコピーを作成するために使用されます。DOMCharacterDataはテキストノードやコメントノードといった、文字データを保持するノードの基底クラスです。

cloneNodeメソッドの引数bool $deepは、そのノードが子ノードを持つ場合に、子ノードも一緒に複製するかどうかを指定します。しかし、DOMCharacterData型のノードは子ノードを持たないため、この引数の値は複製結果に影響しません。戻り値としてDOMNode型の新しいノードオブジェクトが返されます。この新しいノードは元のノードとは完全に独立しており、内容を変更しても元のノードに影響を与えることはありません。

サンプルコードでは、まず「元のテキストデータ」を持つDOMTextノードを作成し、それをcloneNodeメソッドで複製しています。複製されたノードは新しいオブジェクトとして生成され、元のノードのテキスト値がコピーされます。その後、複製されたノードの値を「変更されたクローンデータ」に更新しても、元のノードの値は変化しないことが確認できます。このように、cloneNodeはDOMツリーのノードを独立した形で再利用したい場合に非常に役立つ機能です。

Copy
1<?php
2
3// DOMDocument オブジェクトを作成し、XMLドキュメントの基盤を準備します。
4// '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6// 出力を整形するため、formatOutput を true に設定します。
7// これにより、saveXML() の結果が見やすくなります。
8$dom->formatOutput = true; 
9
10// ルート要素となる <data> 要素を作成し、ドキュメントに追加します。
11$root = $dom->createElement('data');
12$dom->appendChild($root);
13
14// DOMCharacterData の子クラスである DOMText ノードを作成します。
15// これは 'Hello PHP!' というテキストコンテンツを持つノードです。
16$originalTextNode = $dom->createTextNode('Hello PHP!');
17// 作成したテキストノードをルート要素の子として追加します。
18$root->appendChild($originalTextNode);
19
20echo "--- 元のノードの情報 ---" . PHP_EOL;
21echo "元のノードの値: " . $originalTextNode->nodeValue . PHP_EOL;
22// spl_object_id はPHP 7.2以降で利用可能で、オブジェクトの一意なIDを返します。
23// これにより、オブジェクトが同じか異なるかを識別できます。
24echo "元のノードのオブジェクトID: " . spl_object_id($originalTextNode) . PHP_EOL;
25// ノードがドキュメントツリーのどこに属しているか（親ノードの名前）を表示します。
26echo "元のノードの親: " . ($originalTextNode->parentNode ? $originalTextNode->parentNode->nodeName : 'なし') . PHP_EOL;
27echo PHP_EOL;
28
29// DOMCharacterData::cloneNode メソッドを使ってノードを複製します。
30// このメソッドは、元のノードと全く同じ内容を持つ新しいノードオブジェクトを作成します。
31// 引数 $deep は false がデフォルトです。
32// DOMText ノードは子ノードを持たないため、$deep を true にしても結果は変わりません。
33$clonedTextNode = $originalTextNode->cloneNode();
34
35echo "--- 複製されたノードの情報 ---" . PHP_EOL;
36echo "複製されたノードの値: " . $clonedTextNode->nodeValue . PHP_EOL;
37echo "複製されたノードのオブジェクトID: " . spl_object_id($clonedTextNode) . PHP_EOL;
38// 複製直後のノードは、ドキュメントツリーに属していないため、親ノードがありません。
39echo "複製されたノードの親: " . ($clonedTextNode->parentNode ? $clonedTextNode->parentNode->nodeName : 'なし') . PHP_EOL;
40echo PHP_EOL;
41
42// 複製されたノードは新しいオブジェクトであり、元のノードとは異なるオブジェクト参照を持っています。
43if ($originalTextNode === $clonedTextNode) {
44    echo "元のノードと複製されたノードは同じオブジェクトです。(これは通常起こりません)" . PHP_EOL;
45} else {
46    echo "元のノードと複製されたノードは異なるオブジェクトです。" . PHP_EOL;
47}
48echo PHP_EOL;
49
50// 複製されたノードをドキュメントの別の場所に挿入できます。
51// 新しい要素 <cloned_data> を作成し、ドキュメントに追加します。
52$anotherRoot = $dom->createElement('cloned_data');
53$dom->appendChild($anotherRoot);
54// 複製されたテキストノードを <cloned_data> 要素の子として追加します。
55$anotherRoot->appendChild($clonedTextNode); 
56
57echo "--- 複製されたノードをドキュメントに追加後 ---" . PHP_EOL;
58// ノードがドキュメントに追加されたので、親ノードが設定されています。
59echo "複製されたノードの新しい親: " . ($clonedTextNode->parentNode ? $clonedTextNode->parentNode->nodeName : 'なし') . PHP_EOL;
60echo PHP_EOL;
61
62// ドキュメント全体をXML形式で出力し、複製されたノードが追加されていることを確認します。
63echo "--- 最終的なXMLドキュメント ---" . PHP_EOL;
64echo $dom->saveXML();
65
66?>

PHPのDOMCharacterData::cloneNodeメソッドは、既存のDOMノードを複製するための機能です。このメソッドは、元のノードと全く同じ内容を持つ新しいノードオブジェクトを作成し、それを返します。DOMCharacterDataクラスは、テキストノード（DOMText）のように文字データを含むノードの基底クラスにあたります。

引数$deepはbool型でデフォルトはfalseです。これは、複製するノードの子ノードも一緒に複製するかどうかを指定します。今回のサンプルにあるDOMTextノードのように子ノードを持たないタイプの場合、$deep の値は結果に影響しません。もし要素ノード（DOMElement）のように子ノードを持つノードを複製する場合、$deep を true に設定すると子ノードもすべて複製されます。戻り値は複製された新しいDOMNodeオブジェクトです。

サンプルコードでは、まず 'Hello PHP!' というテキストを持つ元のDOMTextノードを作成し、ドキュメントに追加しています。cloneNodeメソッドを使って複製されたノードは、元のノードとは異なる「新しい」オブジェクトであることが、出力されるオブジェクトIDから確認できます。複製直後のノードは、まだドキュメントのどの部分にも追加されていないため、親ノードを持ちません。しかし、その後で appendChild メソッドを使って新しい親要素に追加することで、ドキュメントツリーの一部として機能させることが可能になります。このように、cloneNodeは既存のノードをテンプレートとして利用し、独立した新しいノードを生成して、ドキュメントの別の場所に配置する際に非常に役立つ機能です。