【PHP8.x】importNodeメソッドの使い方

Copy
1<?php
2
3// ターゲットとなる新しいDOMドキュメントを作成します。
4$targetDocument = new Dom\Document();
5// 出力時にXMLが整形されるように設定し、見やすくします。
6$targetDocument->formatOutput = true;
7
8// ターゲットドキュメントのルート要素を作成し、ドキュメントに追加します。
9$targetRoot = $targetDocument->createElement('targetDocumentRoot');
10$targetDocument->appendChild($targetRoot);
11
12// インポート元となるDOMドキュメントを作成し、XML文字列を読み込みます。
13$sourceDocument = new Dom\Document();
14$sourceDocument->loadXML('<sourceData><item id="uniqueId">データ内容</item></sourceData>');
15
16// インポート元のドキュメントから、インポートしたいDom\Node（ここでは<item>要素）を取得します。
17$nodeToImport = $sourceDocument->getElementsByTagName('item')->item(0);
18
19// Dom\Document::importNode メソッドを使用して、ノードをターゲットドキュメントにインポートします。
20// 第二引数 $deep を true に設定すると、ノードの子孫（この場合は「データ内容」というテキスト）も一緒にインポートされます。
21$importedNode = $targetDocument->importNode($nodeToImport, true);
22
23// インポートしたノードを、ターゲットドキュメント内の適切な場所（ここではターゲットのルート要素の子）に追加します。
24$targetRoot->appendChild($importedNode);
25
26// 最終的なターゲットドキュメントのXML内容を出力して、インポートが成功したことを確認します。
27echo "--- 最終的なターゲットドキュメントの内容 ---\n";
28echo $targetDocument->saveXML();
29
30?>

PHP 8のDom\Document::importNodeメソッドは、異なるXMLドキュメント（Dom\Documentオブジェクト）間でノードをコピーする際に使用します。これにより、あるドキュメントに存在する要素やテキストなどを、別のドキュメントに持ち込むことができます。

このメソッドは2つの引数を取ります。最初の$node引数には、インポートしたい元のドキュメントに存在するDom\Nodeオブジェクトを指定します。例えば、別のXMLファイルから読み込んだドキュメント内の特定要素などが該当します。二番目の$deep引数はブール値で、trueを設定すると指定したノードの子孫（子要素や含まれるテキストデータなど）も一緒にインポートされます。falseの場合は、ノード自体のみがインポートされ、その中身は含まれません。

importNodeメソッドは、インポート先のドキュメントに属する新しいDom\Nodeオブジェクトを返します。この戻り値のノードはまだドキュメントのツリー構造に追加されていないため、実際に追加するにはappendChildなどのメソッドを別途使用する必要があります。

サンプルコードでは、sourceDocumentから<item>要素を取得し、targetDocumentへインポートしています。$deepをtrueにすることで、<item>要素とその中の「データ内容」というテキストもコピーされ、最終的にtargetDocumentのルート要素の子として追加されています。これにより、二つのドキュメントの内容が統合されたXMLが生成されます。