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

Copy
1<?php
2
3/**
4 * DOMノードのクローン操作を示します。
5 *
6 * この関数はXMLドキュメントを作成し、特定のノードを「浅いクローン」と「深いクローン」で複製し、
7 * その違いをXML出力で示します。
8 *
9 * DOMの「クローン」とは、既存のノードのコピーを作成することです。
10 * cloneNode() メソッドは、DOM\Nodeインターフェース（DOMDocumentクラスなどが実装）で定義されており、
11 * 引数によって子ノードも一緒に複製するかどうかを制御できます。
12 *
13 * @return string 操作後のXMLドキュメントの文字列。
14 */
15function demonstrateNodeCloning(): string
16{
17    // 新しいXMLドキュメントを作成します。PHP 8ではDOMDocumentがDom\XMLDocumentインターフェースを実装しています。
18    $dom = new DOMDocument('1.0', 'UTF-8');
19    $dom->formatOutput = true; // 出力時にXMLを整形して見やすくします
20
21    // ルート要素 <root> を作成し、ドキュメントに追加します
22    $root = $dom->createElement('root');
23    $dom->appendChild($root);
24
25    // クローン元の <item> 要素を作成し、ルートに追加します
26    $itemOriginal = $dom->createElement('item');
27    $root->appendChild($itemOriginal);
28
29    // <item> の子要素として <name> と <price> を作成し、追加します
30    $name = $dom->createElement('name', 'Original Item Name');
31    $itemOriginal->appendChild($name);
32
33    $price = $dom->createElement('price', '100');
34    $itemOriginal->appendChild($price);
35
36    $output = "--- 元のXMLドキュメント ---\n";
37    $output .= $dom->saveXML() . "\n\n";
38
39    // --- cloneNode(false) の例：浅いクローン ---
40    // 引数に false (または省略) を指定すると、元のノード自身のみが複製されます。
41    // 子ノード (<name>, <price>) は複製されません。
42    $itemShallowClone = $itemOriginal->cloneNode(false);
43    $itemShallowClone->setAttribute('id', 'shallow-clone'); // クローン後に属性を追加
44
45    // 浅いクローンに新しい子ノードを追加して、これが元のノードから独立していることを示します
46    $shallowCloneName = $dom->createElement('name', 'Shallow Cloned Item Name Added');
47    $itemShallowClone->appendChild($shallowCloneName);
48
49    // 浅いクローンをドキュメントのルートに追加します
50    $root->appendChild($itemShallowClone);
51
52    $output .= "--- 浅いクローンを追加した後のXMLドキュメント ---\n";
53    $output .= "（cloneNode(false) は親ノードのみを複製し、子ノードは複製しません）\n";
54    $output .= $dom->saveXML() . "\n\n";
55
56    // --- cloneNode(true) の例：深いクローン ---
57    // 引数に true を指定すると、元のノード自身とそのすべての子孫ノードが再帰的に複製されます。
58    // この場合、<name> と <price> も一緒に複製されます。
59    $itemDeepClone = $itemOriginal->cloneNode(true);
60    $itemDeepClone->setAttribute('id', 'deep-clone'); // クローン後に属性を追加
61
62    // 深いクローン内の <name> 要素のテキスト内容を変更します。
63    // これは元のノードや他のクローンには影響しません。
64    $deepCloneNameElement = $itemDeepClone->getElementsByTagName('name')->item(0);
65    if ($deepCloneNameElement) {
66        $deepCloneNameElement->nodeValue = 'Deep Cloned Item Name Modified';
67    }
68
69    // 深いクローンをドキュメントのルートに追加します
70    $root->appendChild($itemDeepClone);
71
72    $output .= "--- 深いクローンを追加した後のXMLドキュメント ---\n";
73    $output .= "（cloneNode(true) は親ノードとその全ての子孫ノードを複製します）\n";
74    $output .= $dom->saveXML() . "\n";
75
76    return $output;
77}
78
79// 関数を実行し、結果を出力します
80echo demonstrateNodeCloning();

PHP 8のDom\XMLDocument::cloneNodeメソッドは、XMLドキュメント内の既存のノードを複製するための機能です。この「php clone」操作により、元のノードの内容を再利用し、新しいノードを効率的に作成できます。

このメソッドは、$deepというブール型の引数を一つ取ります。この引数をfalseとするか省略した場合、ノード自身のみが複製され、その子ノードはコピーされません。これを「浅いクローン」と呼びます。一方、$deepをtrueと指定すると、ノード自身だけでなく、そのノードの下に連なるすべての子孫ノードもまとめて再帰的に複製されます。これを「深いクローン」と呼びます。

メソッドの戻り値は、複製されて新しく作成されたDom\Nodeオブジェクトです。この新しいノードは、元のドキュメントのどこにも属していない独立した状態ですので、ドキュメントに組み込むには別途appendChildなどのメソッドを使用する必要があります。

サンプルコードでは、まず<item>という元のノードとその子ノード<name>と<price>を作成します。次に、cloneNode(false)を用いて浅いクローンを作成し、子ノードが複製されていない状態を示します。その後、cloneNode(true)を用いて深いクローンを作成し、元のノードのすべての子孫ノードも複製されていることをXML出力によって明確に示しています。これにより、$deep引数の違いが複製結果にどのように影響するかが理解できます。

Copy
1<?php
2
3// このファイルは PHP 8 以降で動作します。
4
5/**
6 * Dom\XMLDocument::cloneNode() メソッドの使用例を示します。
7 * ノードを浅く（子ノードなしで）または深く（子ノードも含む）クローンする方法を実演します。
8 */
9function demonstrateCloneNode(): void
10{
11    // XML文字列を定義します。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<bookstore>
15    <book category="cooking">
16        <title lang="en">Everyday Italian</title>
17        <author>Giada De Laurentiis</author>
18        <year>2005</year>
19        <price>30.00</price>
20    </book>
21    <book category="children">
22        <title lang="en">Harry Potter</title>
23        <author>J. K. Rowling</author>
24        <year>2005</year>
25        <price>29.99</price>
26    </book>
27</bookstore>
28XML;
29
30    // Dom\XMLDocument オブジェクトを作成し、XMLを読み込みます。
31    $document = new Dom\XMLDocument();
32    $document->loadXML($xmlString);
33
34    // クローンしたいノード（例: 最初の <book> 要素）を取得します。
35    $originalBookNode = $document->querySelector('book');
36
37    if (!$originalBookNode instanceof Dom\Element) {
38        echo "指定された 'book' ノードが見つかりませんでした。\n";
39        return;
40    }
41
42    echo "--- オリジナルノードの内容 ---\n";
43    // Dom\XMLDocument::saveXML() にノードを渡すと、そのノードのXML表現が出力されます。
44    echo $document->saveXML($originalBookNode);
45    echo "\n";
46
47    // シャロークローン（浅い複製）の例：子ノードを含めずに複製します。
48    // cloneNode(false) は、ノード自身とその属性のみを複製し、子ノードは複製しません。
49    $shallowClonedBook = $originalBookNode->cloneNode(false);
50
51    echo "--- シャロークローン（子ノードなし）の内容 ---\n";
52    echo $document->saveXML($shallowClonedBook);
53    echo "\n";
54
55    // ディープクローン（深い複製）の例：子ノードも含めて複製します。
56    // cloneNode(true) は、ノード自身とその属性、さらにすべての子ノードを再帰的に複製します。
57    $deepClonedBook = $originalBookNode->cloneNode(true);
58
59    echo "--- ディープクローン（子ノードあり）の内容 ---\n";
60    echo $document->saveXML($deepClonedBook);
61    echo "\n";
62
63    // クローンしたノードを元のドキュメントツリーに追加する例
64    // クローンされたノードは、どのドキュメントにもまだ所属していません。
65    // ドキュメントに追加する前に、属性や内容を変更して新しいノードとして区別します。
66    if ($deepClonedBook->hasAttribute('category')) {
67        $deepClonedBook->setAttribute('category', 'fantasy'); // category 属性を変更
68    }
69    $titleNode = $deepClonedBook->querySelector('title');
70    if ($titleNode instanceof Dom\Element) {
71        $titleNode->textContent = 'The Adventures of PHP'; // title 要素のテキストを変更
72    }
73
74    // ドキュメントのルート要素にクローンされたノードを追加します。
75    $document->documentElement->appendChild($deepClonedBook);
76
77    echo "--- ドキュメントにディープクローンを追加した後の全体像 ---\n";
78    echo $document->saveXML();
79    echo "\n";
80}
81
82// サンプルコードを実行します。
83demonstrateCloneNode();
84

Dom\XMLDocument::cloneNode()メソッドは、PHPでXMLドキュメント内の既存のノードを複製するために使用されます。これにより、元のノードの内容を再利用して新しいノードを作成し、別の場所で利用できます。

このサンプルコードでは、まずXML文字列からDom\XMLDocumentオブジェクトを作成し、そこから最初の<book>ノードを取得しています。

cloneNode()メソッドの引数$deepは、複製方法を制御します。 引数$deepにfalse（または引数を省略）を指定すると「浅い複製（シャロークローン）」が行われます。これは、元のノード自身とそれに設定されている属性のみを複製し、そのノードが持っている子ノードは複製しません。サンプルコードの出力では、シャロークローンされた<book>ノードには子要素である<title>や<author>などが含まれていないことが確認できます。

一方、引数$deepにtrueを指定すると「深い複製（ディープクローン）」が行われます。この場合、元のノード自身とその属性に加え、そのノードが持っているすべての子ノードも再帰的に複製されます。サンプルコードの出力では、ディープクローンされた<book>ノードが子要素も含めて完全に複製されていることが示されています。

cloneNode()メソッドは、新しく複製されたDom\Nodeオブジェクトを戻り値として返します。この複製されたノードはまだどのドキュメントツリーにも所属していないため、必要に応じて属性や内容を変更した後、appendChild()などのメソッドを使って既存のドキュメントの任意の場所に追加することができます。サンプルコードでは、ディープクローンされたノードの属性やテキスト内容を変更し、元のドキュメントのルート要素に追加する例も示しており、ドキュメント全体がどのように更新されるかを確認できます。