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

Copy
1<?php
2
3/**
4 * DOMAttr::cloneNode メソッドの使用例。
5 * このコードは、HTML/XML要素の属性（DOMAttrオブジェクト）を複製する方法を示します。
6 *
7 * キーワード: php clone とは (DOMノードの複製)
8 * DOMにおける 'clone' は、オブジェクトの複製を意味します。
9 * この例では、DOMAttrオブジェクトの値をコピーし、独立した新しいDOMAttrオブジェクトを作成します。
10 */
11function demonstrateDomAttrCloneNode(): void
12{
13    // 1. DOMDocument オブジェクトを新しく作成します。
14    //    これはHTMLやXML文書全体を表現するコンテナです。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力を見やすくするための設定
17    $dom->preserveWhiteSpace = false; // 空白を削除し、formatOutputを有効にする
18
19    // 2. ルート要素を作成し、文書に追加します。
20    $rootElement = $dom->createElement('data');
21    $dom->appendChild($rootElement);
22
23    // 3. 複製したい属性を持つ要素を作成します。
24    $originalItem = $dom->createElement('item');
25    $rootElement->appendChild($originalItem);
26
27    // 4. 属性を作成し、その要素に追加します。
28    //    これにより、DOMAttr オブジェクトが要素に紐付けられます。
29    $originalAttr = $dom->createAttribute('id');
30    $originalAttr->value = 'item-001';
31    $originalItem->setAttributeNode($originalAttr);
32
33    echo "--- オリジナルの属性情報 ---\n";
34    echo "オリジナル属性名: " . $originalAttr->name . "\n";
35    echo "オリジナル属性値: " . $originalAttr->value . "\n\n";
36
37    // 5. DOMAttr::cloneNode() を使用して属性を複製します。
38    //    $deep 引数は DOMAttr の場合、子ノードを持たないため実質的な影響はありません。
39    //    常に属性自身と値が複製されます。
40    $clonedAttr = $originalAttr->cloneNode(true); // true または false どちらでも結果は同じ
41                                                 // (DOMAttrは子ノードを持たないため)
42
43    echo "--- 複製された属性情報 ---\n";
44    echo "複製属性名: " . $clonedAttr->name . "\n";
45    echo "複製属性値: " . $clonedAttr->value . "\n\n";
46
47    // 6. オリジナルと複製された属性が独立していることを確認します。
48    //    オリジナルの値を変更しても、複製された属性の値は変わりません。
49    $originalAttr->value = 'item-modified';
50
51    echo "--- オリジナル属性の値を変更後 ---\n";
52    echo "オリジナル属性名: " . $originalAttr->name . "\n";
53    echo "オリジナル属性値: " . $originalAttr->value . "\n";
54    echo "複製属性名: " . $clonedAttr->name . "\n";
55    echo "複製属性値: " . $clonedAttr->value . "\n\n";
56
57    // 7. 複製された属性を別の要素に追加することも可能です。
58    //    これにより、複製された属性が独立したオブジェクトであることが視覚的に確認できます。
59    $anotherItem = $dom->createElement('item');
60    $anotherItem->setAttributeNode($clonedAttr); // 複製した属性を追加
61    $rootElement->appendChild($anotherItem);
62
63    echo "--- 最終的なDOM構造 (XML形式) ---\n";
64    // 生成されたDOM構造全体をXML形式で出力します。
65    echo $dom->saveXML();
66}
67
68// 関数を実行して、DOMAttrのcloneNodeの動作を確認します。
69demonstrateDomAttrCloneNode();
70
71?>

PHPのDOMAttr::cloneNodeメソッドは、HTMLやXML文書の要素に付与された「属性（DOMAttrオブジェクト）」を複製するために使用されます。これは、php cloneという概念がDOMにおいて「オブジェクトの複製」を意味するものであり、既存の属性から新しい独立した属性を作成する際に活用されます。

このメソッドを呼び出すと、オリジナルの属性が持つ名前や値が完全にコピーされた、新しいDOMAttrオブジェクトが生成されて戻り値として返されます。引数$deepは真偽値を取り、通常は子ノードも再帰的に複製するかどうかを制御しますが、DOMAttrオブジェクトは子ノードを持たないため、trueまたはfalseのどちらを指定しても結果に実質的な違いはありません。常に属性自身と値が複製されます。

サンプルコードでは、まずidという名前とitem-001という値を持つオリジナルの属性を作成し、それを要素に追加します。次に、cloneNode()メソッドでこの属性を複製し、新しいDOMAttrオブジェクトを取得します。オリジナルの属性の値を変更しても複製された属性の値は変わらないことから、両者が独立したオブジェクトであることが確認できます。最終的に、複製された属性を別の要素に追加することで、DOM構造内で独立して再利用できることが示されています。この機能は、既存の属性の定義を基にしながら、新しい要素に同じ、あるいは少し変更した属性を付与したい場合に非常に便利です。

Copy
1<?php
2
3/**
4 * DOMAttr::cloneNode() メソッドの使用例。
5 *
6 * この関数は、指定された DOMAttr ノードをクローンします。
7 * DOMAttr ノードには子ノードがないため、引数 $deep の値 (true/false) は結果に影響しません。
8 * クローンされたノードは、元のノードとは独立した新しいオブジェクトとなります。
9 */
10
11// 1. DOMDocument オブジェクトを作成
12// XML ドキュメントを構築するための基盤となります。
13$dom = new DOMDocument('1.0', 'UTF-8');
14$dom->formatOutput = true; // 出力を見やすくするための設定
15
16// 2. ルート要素を作成し、DOM に追加
17// 属性を追加するための親要素を用意します。
18$rootElement = $dom->createElement('data');
19$dom->appendChild($rootElement);
20
21// 3. 要素に属性を設定し、その DOMAttr オブジェクトを取得
22// これがクローン元の属性ノードになります。
23$rootElement->setAttribute('id', 'unique-item-id-123');
24$originalAttr = $rootElement->getAttributeNode('id');
25
26echo "--- オリジナル属性ノードの情報 ---\n";
27echo "ノード名: " . $originalAttr->nodeName . "\n";
28echo "属性名:   " . $originalAttr->name . "\n";
29echo "属性値:   " . $originalAttr->value . "\n\n";
30
31// 4. DOMAttr::cloneNode() メソッドを使用して属性ノードをクローン
32// $deep 引数はデフォルトで false ですが、DOMAttr は子ノードを持たないため、
33// true を指定しても動作は同じです。
34$clonedAttr = $originalAttr->cloneNode();
35
36echo "--- クローンされた属性ノードの情報 ---\n";
37echo "ノード名: " . $clonedAttr->nodeName . "\n";
38echo "属性名:   " . $clonedAttr->name . "\n";
39echo "属性値:   " . $clonedAttr->value . "\n\n";
40
41// 5. オリジナルとクローンが異なるオブジェクトであることを確認
42// cloneNode() は新しいオブジェクトを返します。
43if ($originalAttr !== $clonedAttr) {
44    echo "オリジナルとクローンは異なる DOMAttr オブジェクトです。\n";
45} else {
46    echo "オリジナルとクローンは同じ DOMAttr オブジェクトです (これは通常ありえません)。\n";
47}
48echo "\n";
49
50// 6. クローンされた属性ノードを新しい要素に割り当てる
51// クローンされたノードはDOMツリーには属していないため、明示的に追加する必要があります。
52$newElement = $dom->createElement('item');
53$dom->appendChild($newElement);
54
55// クローンされた属性ノードを新しい要素に追加
56// これにより、DOMツリーにクローンされた属性が組み込まれます。
57$newElement->setAttributeNode($clonedAttr);
58
59echo "--- クローンされた属性が追加された後の DOM ドキュメント全体 ---\n";
60echo $dom->saveXML();
61
62?>

DOMAttr::cloneNode()メソッドは、XMLやHTMLドキュメントの属性ノード（DOMAttrオブジェクト）を複製するための機能です。このメソッドを呼び出すと、元の属性ノードと同じ名前と値を持つ、全く新しいDOMAttrオブジェクトが生成され、それが戻り値として返されます。

引数$deepは真偽値を指定しますが、DOMAttrノードは子ノードを持たないため、trueを指定してもfalseを指定しても結果に違いはありません。デフォルトではfalseです。クローンされたノードは、元のノードとは完全に独立したオブジェクトであり、元のドキュメントツリーにはまだ属していません。そのため、複製した属性を既存または新しい要素に適用するには、setAttributeNode()などのメソッドを使用して明示的に追加する必要があります。

サンプルコードでは、まずidという属性を持つ元のDOMAttrオブジェクトを取得し、それをcloneNode()で複製しています。複製された$clonedAttrは元の$originalAttrとは別個のオブジェクトであることが確認できます。最終的に、このクローンされた属性ノードは新しいitem要素に追加され、ドキュメントの構造内に組み込まれる様子が示されています。このメソッドは、既存の属性情報を再利用して、別の要素に効率的に適用したい場合に役立ちます。