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

Copy
1<?php
2
3/**
4 * PHPのDOMDocumentとDom\Node::cloneNodeメソッドの使用例を示します。
5 * この関数は、DOMノードの複製方法と、
6 * 子ノードを含めるかどうかを制御する `$deep` 引数の重要性を説明します。
7 * Dom\Notation クラスも Dom\Node を継承しており、同様の cloneNode メソッドを持ちます。
8 * Dom\Notation ノードは通常子ノードを持たないため、Dom\Element を使用して
9 * `$deep` 引数の効果をより明確に示します。
10 */
11function demonstrateDomNodeClone(): void
12{
13    // 1. DOMDocumentを初期化し、サンプルXML構造を作成します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    $root = $dom->createElement('root');
16    $dom->appendChild($root);
17
18    $parent = $dom->createElement('parent');
19    $parent->setAttribute('id', 'original-parent');
20    $root->appendChild($parent);
21
22    $child1 = $dom->createElement('child1', 'コンテンツA');
23    $parent->appendChild($child1);
24
25    $child2 = $dom->createElement('child2', 'コンテンツB');
26    $parent->appendChild($child2);
27
28    echo "--- 元のDOMツリー ---\n";
29    echo $dom->saveXML();
30    echo "\n";
31
32    // 2. cloneNode(false) の例: 浅い複製 (deep = false)
33    // ノード自身は複製されますが、その子ノードや子孫ノードは複製されません。
34    echo "--- 浅い複製 (deep = false) ---\n";
35    $clonedParentShallow = $parent->cloneNode(false); // 子ノードを含まない
36    $clonedParentShallow->setAttribute('id', 'cloned-shallow'); // 複製されたノードにIDを追加
37
38    echo "複製されたノード名: " . $clonedParentShallow->nodeName . "\n";
39    echo "複製されたノードのID: " . $clonedParentShallow->getAttribute('id') . "\n";
40    echo "複製されたノードの子ノード数: " . $clonedParentShallow->childNodes->length . "\n"; // 結果は 0
41
42    // 複製されたノードはまだDOMツリーには追加されていません。
43    // 動作確認のため、一時的に新しいDOMDocumentにインポートしてXMLを表示します。
44    $tempDomShallow = new DOMDocument();
45    // importNode() の第2引数を true にすると、インポート元のノードの子ノードもコピーされますが、
46    // ここで cloneNode(false) した結果が正しく表示されるよう、true に設定します。
47    $tempDomShallow->appendChild($tempDomShallow->importNode($clonedParentShallow, true));
48    echo "複製された浅いノードのXML:\n" . $tempDomShallow->saveXML();
49    echo "\n";
50
51    // 3. cloneNode(true) の例: 深い複製 (deep = true)
52    // ノード自身と、そのすべての子ノード、子孫ノードも複製されます。
53    echo "--- 深い複製 (deep = true) ---\n";
54    $clonedParentDeep = $parent->cloneNode(true); // 子ノードを含む
55    $clonedParentDeep->setAttribute('id', 'cloned-deep'); // 複製されたノードにIDを追加
56
57    echo "複製されたノード名: " . $clonedParentDeep->nodeName . "\n";
58    echo "複製されたノードのID: " . $clonedParentDeep->getAttribute('id') . "\n";
59    echo "複製されたノードの子ノード数: " . $clonedParentDeep->childNodes->length . "\n"; // 結果は 2
60
61    // 同様に、動作確認のため新しいDOMDocumentに一時的にインポートしてXMLを表示します。
62    $tempDomDeep = new DOMDocument();
63    $tempDomDeep->appendChild($tempDomDeep->importNode($clonedParentDeep, true));
64    echo "複製された深いノードのXML:\n" . $tempDomDeep->saveXML();
65    echo "\n";
66
67    // 4. 複製されたノードは元のノードとは別物であること
68    echo "--- 元のノードと複製ノードの比較 ---\n";
69    echo "元の 'parent' ノードのオブジェクトID: " . spl_object_id($parent) . "\n";
70    echo "浅く複製されたノードのオブジェクトID: " . spl_object_id($clonedParentShallow) . "\n";
71    echo "深く複製されたノードのオブジェクトID: " . spl_object_id($clonedParentDeep) . "\n";
72    echo "これらのIDが異なることから、複製されたノードは元のノードとは独立した新しいオブジェクトであることがわかります。\n";
73
74    // 5. 複製されたノードを既存のDOMツリーに追加する例
75    // 複製されたノードは独立したオブジェクトなので、DOMツリー内のどこにでも追加できます。
76    $root->appendChild($clonedParentDeep);
77    echo "\n--- 深く複製されたノードをDOMツリーに追加後 ---\n";
78    echo $dom->saveXML();
79}
80
81// 関数を実行して、cloneNodeの動作を確認します。
82demonstrateDomNodeClone();

PHP 8のDom\Notation::cloneNodeメソッドは、XMLやHTMLなどのDOMツリーに存在するノードを複製するために使用されます。このメソッドは、呼び出されたノード自身のコピーを作成し、新しいDom\Nodeオブジェクトとして返します。

引数$deepはブール値で、複製の深さを制御します。デフォルト値はfalseで、この場合、ノード自身は複製されますが、その中に含まれる子ノードや子孫ノードは複製されません。これを「浅い複製」と呼びます。一方、$deepにtrueを指定すると、ノード自身に加え、そのすべての子ノードや子孫ノードもまとめて複製されます。これを「深い複製」と呼びます。

複製されたノードは元のノードとは完全に独立した新しいオブジェクトであり、元のDOMツリーには自動的に追加されません。そのため、複製後にDOMツリーの特定の位置に挿入したい場合は、別途appendChildなどのメソッドを使って手動で追加する必要があります。

Dom\Notationクラスのノードは通常子ノードを持たないため、このサンプルコードではDom\Elementノードを使って$deep引数の効果を具体的に示しています。しかし、Dom\NotationもDom\Nodeを継承しており、同様にcloneNodeメソッドを利用してノードの複製を行うことができます。これはPHPでDOMを操作する際に、既存の構造を再利用したり、動的に要素を生成したりするための基本的な機能の一つです。

Copy
1<?php
2
3// DOM\Notation represents a notation declared in the DTD.
4// To demonstrate cloning a Dom\Notation node, we first need to create a Dom\Document
5// that includes a Document Type Definition (DTD) with declared notations.
6
7// 1. Create a new Dom\Document object.
8$dom = new Dom\Document();
9
10// 2. Load XML with an internal DTD containing notations.
11//    Notations define the format of unparsed entities (e.g., "gif" for image/gif).
12$xmlString = <<<XML
13<!DOCTYPE document [
14  <!NOTATION gif SYSTEM "image/gif">
15  <!NOTATION jpeg SYSTEM "image/jpeg">
16  <!ELEMENT document EMPTY>
17]>
18<document/>
19XML;
20
21// Disable error reporting for DTD validation to keep the example simple,
22// although in real applications, you'd handle errors.
23libxml_use_internal_errors(true);
24$dom->loadXML($xmlString);
25libxml_clear_errors(); // Clear any potential errors after loading
26
27// 3. Access the DocumentType and its notations.
28/** @var Dom\DocumentType|null $doctype */
29$doctype = $dom->doctype;
30
31if ($doctype && $doctype->notations) {
32    echo "--- Original Notations ---\n";
33
34    // Iterate through all notations found in the DTD.
35    // Each element in $doctype->notations is a Dom\Notation object.
36    foreach ($doctype->notations as $notationName => $originalNotation) {
37        // Output details of the original Dom\Notation node.
38        echo "Original Notation '{$notationName}':\n";
39        echo "  - Node Name: {$originalNotation->nodeName}\n";
40        echo "  - System ID: {$originalNotation->systemId}\n";
41
42        // 4. Clone the Dom\Notation node using cloneNode().
43        //    For Dom\Notation, the $deep argument (true/false) typically doesn't
44        //    make a practical difference as Notation nodes do not have child nodes.
45        //    However, it's good practice to demonstrate its usage.
46        $clonedNotation = $originalNotation->cloneNode(true); // 'true' for deep copy (though no children here)
47
48        echo "--- Cloned Notation ---\n";
49        echo "Cloned Notation of '{$notationName}':\n";
50        echo "  - Node Name: {$clonedNotation->nodeName}\n";
51        echo "  - System ID: {$clonedNotation->systemId}\n";
52
53        // 5. Verify the clone.
54        //    The original and cloned objects should be different instances
55        //    but have the same properties.
56        if ($originalNotation !== $clonedNotation &&
57            $originalNotation->nodeName === $clonedNotation->nodeName &&
58            $originalNotation->systemId === $clonedNotation->systemId) {
59            echo "  (Successfully cloned: different object, same properties)\n\n";
60        } else {
61            echo "  (Cloning issue: objects might be identical or properties mismatch)\n\n";
62        }
63    }
64} else {
65    echo "No DTD or notations found in the document. Cannot demonstrate Dom\\Notation::cloneNode.\n";
66}
67
68?>

PHPのDom\Notation::cloneNodeメソッドは、XML文書のDTD（Document Type Definition：文書型定義）内で宣言された「NOTATION（表記法）」ノードを複製するために使用されます。NOTATIONは、XML内で扱われる外部のデータ形式（例えば画像ファイルの「gif」など）を定義する特別なルールです。このメソッドは、既存のDom\Notationオブジェクトの内容（名前やシステムIDなど）をそのまま引き継いだ、全く新しいDom\Nodeオブジェクト（実際にはDom\Notationオブジェクト）を作成して返します。

引数$deepは、通常、子ノードも一緒に複製するかどうかを指定しますが、Dom\Notationノード自体は子ノードを持たないため、trueを設定してもfalseを設定しても動作上の違いはありません。戻り値は、複製されたDom\Notationオブジェクトです。

サンプルコードでは、まずNOTATIONが定義されたXMLドキュメントを作成し、そこからDom\Notationオブジェクトを取得しています。その後、cloneNode(true)を使って複製を行い、元のオブジェクトとは異なるインスタンスでありながら、その内容が正確にコピーされていることを確認しています。この機能は、元のNOTATION情報を変更せずに再利用したい場合に便利です。