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

Copy
1<?php
2
3// Dom\Document クラスは、HTMLまたはXML文書全体を表します。
4// PHP 8 では、DOM拡張はデフォルトで有効化されています。
5$dom = new Dom\Document('1.0', 'UTF-8');
6$dom->formatOutput = true; // 出力されるXMLを見やすく整形します。
7
8// 文書にルート要素 'root' を作成し、追加します。
9$root = $dom->createElement('root');
10$dom->appendChild($root);
11
12// Dom\EntityReference ノードを作成します。
13// これは通常、DOMDocument::loadXML()などでXMLをパースした際に生成されますが、
14// サンプルコードでは直接 createEntityReference() を使用して作成します。
15// 例として、HTMLエンティティ '&amp;' を表す 'amp' という名前のエンティティ参照を作成します。
16$originalEntityRef = $dom->createEntityReference('amp');
17
18// オリジナルのエンティティ参照ノードをルート要素に追加します。
19$root->appendChild($originalEntityRef);
20
21echo "--- 元のDOMツリーの状態 ---\n";
22echo $dom->saveXML();
23echo "\n";
24
25echo "--- Dom\\EntityReference::cloneNode() メソッドの使用例 ---\n";
26
27// cloneNode() メソッドは、呼び出されたノードのクローン（複製）を返します。
28// PHPにおける「clone」はオブジェクトの複製を意味しますが、DOMノードの場合、
29// cloneNode() メソッドを使ってDOMツリー構造の一部を複製します。
30//
31// 引数 $deep が false（デフォルト値）の場合、ノード自体のみが複製され、子ノードは複製されません。
32// 引数 $deep が true の場合、ノードとそのすべての子孫ノードが再帰的に複製されます。
33// Dom\EntityReference ノードは常に子ノードを持たないため、$deep 引数の値は結果に影響しませんが、
34// メソッドシグネチャに従って引数を指定することができます。
35$clonedEntityRef = $originalEntityRef->cloneNode(false); // $deep を明示的に false に設定
36
37echo "元のDom\\EntityReferenceノードの識別情報:\n";
38echo "  ノード名: " . $originalEntityRef->nodeName . "\n";
39echo "  ノードタイプ: " . $originalEntityRef->nodeType . " (定数: XML_ENTITY_REF_NODE)\n";
40echo "  ノード値: " . $originalEntityRef->nodeValue . " (エンティティ参照ノードの場合、通常は空)\n";
41echo "  オブジェクトID (spl_object_id): " . spl_object_id($originalEntityRef) . "\n";
42echo "\n";
43
44echo "複製されたDom\\EntityReferenceノードの識別情報:\n";
45echo "  ノード名: " . $clonedEntityRef->nodeName . "\n";
46echo "  ノードタイプ: " . $clonedEntityRef->nodeType . " (定数: XML_ENTITY_REF_NODE)\n";
47echo "  ノード値: " . $clonedEntityRef->nodeValue . "\n";
48echo "  オブジェクトID (spl_object_id): " . spl_object_id($clonedEntityRef) . "\n";
49echo "\n";
50
51// cloneNode() は元のノードとは別の新しいオブジェクトを生成します。
52// そのため、オブジェクトID（PHPがオブジェクトに割り当てる一意の識別子）は異なるはずです。
53if (spl_object_id($originalEntityRef) !== spl_object_id($clonedEntityRef)) {
54    echo "結果: cloneNode() は新しいDom\\EntityReferenceオブジェクトを正常に生成しました。\n";
55} else {
56    echo "結果: エラー - cloneNode() が新しいオブジェクトを生成しませんでした。\n";
57}
58
59// 複製されたノードは、まだDOMツリーのどの部分にも追加されていません。
60// 新しいノードとしてDOMツリーに追加することができます。
61$root->appendChild($clonedEntityRef);
62
63echo "\n--- 複製ノードをDOMツリーに追加した後の状態 ---\n";
64echo $dom->saveXML();
65
66?>

PHPのDom\EntityReference::cloneNode()メソッドは、既存のDOMエンティティ参照ノードの複製を作成します。PHPでオブジェクトを複製する際にはcloneキーワードを使いますが、DOMノードの場合、このcloneNode()メソッドを使用してDOMツリー構造の一部を複製します。

このメソッドは、引数$deep（真偽値、デフォルトはfalse）を受け取ります。$deepがfalseの場合、呼び出し元のノード自体のみが複製され、子ノードは複製されません。$deepがtrueの場合、ノードとそのすべての子孫ノードが再帰的に複製されます。ただし、Dom\EntityReferenceノードは子ノードを持たないため、$deep引数の値は結果に影響を与えません。

cloneNode()は、元のノードと同じ属性を持つ新しいDom\Nodeオブジェクトを返します。この戻り値は元のノードとは独立したオブジェクトです。サンプルコードでは、spl_object_id()関数を用いて、元のノードと複製されたノードが異なるオブジェクトであることが確認されています。複製されたノードは、DOMツリーの任意の場所に追加して利用できます。

Copy
1<?php
2
3/**
4 * Dom\EntityReference::cloneNode メソッドの利用例
5 *
6 * この関数は、XMLドキュメント内のエンティティ参照ノードをクローンする方法を示します。
7 * 引数 `$deep` の値によってクローンの挙動が異なることを、具体的な出力で確認できます。
8 */
9function demonstrateEntityReferenceClone(): void
10{
11    // DOMDocument を作成し、エンティティを定義・参照するXML文字列をロードします。
12    // ここでは、内部エンティティ `&company_name;` を定義し、XMLコンテンツ内で参照しています。
13    $dom = new DOMDocument();
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<!DOCTYPE example [
17  <!ENTITY company_name "株式会社 PHPサンプル">
18]>
19<root>
20  <p>この製品は &company_name; が開発しました。</p>
21</root>
22XML;
23
24    // XMLをロードします。
25    $dom->loadXML($xmlString);
26
27    // Dom\EntityReference ノードを見つけます。
28    // 通常、エンティティ参照はテキストノードの中に埋め込まれているため、
29    // 親要素の子ノードを走査してノードタイプが XML_ENTITY_REF_NODE (Dom\EntityReference) のものを探します。
30    $entityReferenceNode = null;
31    $paragraphElement = $dom->getElementsByTagName('p')->item(0);
32
33    if ($paragraphElement === null) {
34        echo "エラー: <p>要素が見つかりませんでした。\n";
35        return;
36    }
37
38    foreach ($paragraphElement->childNodes as $node) {
39        if ($node->nodeType === XML_ENTITY_REF_NODE) {
40            $entityReferenceNode = $node;
41            break;
42        }
43    }
44
45    if ($entityReferenceNode === null) {
46        echo "エラー: Dom\\EntityReference ノード（&company_name;）が見つかりませんでした。\n";
47        return;
48    }
49
50    echo "--- 元の Dom\\EntityReference ノードの情報 ---\n";
51    echo "  ノード名 (参照名): " . $entityReferenceNode->nodeName . "\n"; // 例: "company_name"
52    echo "  ノード値: '" . $entityReferenceNode->nodeValue . "'\n"; // エンティティ参照ノード自体は通常値を持たない
53    echo "  ノードのクラス: " . get_class($entityReferenceNode) . "\n"; // Dom\EntityReference
54    echo "--------------------------------------------------\n";
55
56    // --- cloneNode(false) の例 ---
57    // `$deep = false` の場合、ノード自体を浅くクローンします。
58    // Dom\EntityReference ノードの場合、参照自体がコピーされますが、
59    // その参照先のコンテンツ（値）は展開されずにクローンされます。
60    $shallowClonedNode = $entityReferenceNode->cloneNode(false);
61
62    echo "\n--- cloneNode(false) による浅いクローン ---\n";
63    echo "  クローンされたノード名: " . $shallowClonedNode->nodeName . "\n";
64    echo "  クローンされたノード値: '" . $shallowClonedNode->nodeValue . "'\n"; // やはり空文字
65    echo "  クローンされたノードのクラス: " . get_class($shallowClonedNode) . "\n"; // Dom\EntityReference
66    echo "  元のノードとクローンされたノードは異なるオブジェクト: " . ($entityReferenceNode !== $shallowClonedNode ? "はい" : "いいえ") . "\n";
67    echo "--------------------------------------------------\n";
68
69
70    // --- cloneNode(true) の例 ---
71    // `$deep = true` の場合、ノードとそれに含まれるすべての子ノードを深くクローンします。
72    // Dom\EntityReference ノードの場合、参照先のコンテンツ（この場合はテキスト）が展開され、
73    // その展開されたノード（通常は Dom\Text ノード）がクローンされて返されます。
74    $deepClonedNode = $entityReferenceNode->cloneNode(true);
75
76    echo "\n--- cloneNode(true) による深いクローン ---\n";
77    echo "  クローンされたノード名: " . $deepClonedNode->nodeName . "\n"; // 展開されたテキストノードの場合 "#text"
78    echo "  クローンされたノード値: '" . $deepClonedNode->nodeValue . "'\n"; // 展開されたコンテンツ ("株式会社 PHPサンプル")
79    echo "  クローンされたノードのクラス: " . get_class($deepClonedNode) . "\n"; // 通常は Dom\Text になる
80    echo "  元のノードとクローンされたノードは異なるオブジェクト: " . ($entityReferenceNode !== $deepClonedNode ? "はい" : "いいえ") . "\n";
81    echo "--------------------------------------------------\n";
82}
83
84// サンプルコードを実行します。
85demonstrateEntityReferenceClone();
86

PHPのDom\EntityReference::cloneNodeメソッドは、XMLドキュメント内のエンティティ参照ノードを複製（クローン）するために使用されます。このメソッドは、引数$deepの値によってクローンの挙動が異なります。

引数$deepをfalse（デフォルト）に設定すると、エンティティ参照ノード自体が浅くクローンされます。これは、参照先の具体的なコンテンツを展開せずに、エンティティ参照の構造のみを複製する動作です。元のノードと同様にDom\EntityReference型の新しいオブジェクトが戻り値として返されます。サンプルコードでは、この場合にノード値が空のままとなることを示しています。

一方、$deepをtrueに設定すると、エンティティ参照が深くクローンされます。この場合、参照先のコンテンツ（例えばテキスト）が展開され、その展開されたコンテンツを表す新しいノードが戻り値として返されます。サンプルコードでは、&company_name;というエンティティ参照が展開され、その値「株式会社 PHPサンプル」を持つDom\Textノードが生成されることが確認できます。

いずれの場合も、cloneNodeメソッドは元のノードとは異なる新しいDom\Nodeオブジェクトを返します。サンプルコードでは、まずXML内に定義されたエンティティ参照ノードを取得し、$deepの値を変更してクローンした場合のノードの型や値の違いを具体的に示しており、PHPでXMLのエンティティ参照を操作する際のcloneNodeの挙動を理解するのに役立ちます。