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

Copy
1<?php
2
3// 新しいDOMDocumentオブジェクトを作成
4$dom = new DOMDocument();
5
6// インポートするノードを作成 (ここでは例として新しい要素を作成)
7$nodeToImport = $dom->createElement('myElement');
8$nodeToImport->setAttribute('myAttribute', 'myValue');
9$nodeToImport->appendChild($dom->createTextNode('My element content'));
10
11// 新しいDOMDocumentオブジェクトを作成 (インポート先)
12$newDom = new DOMDocument();
13
14// ノードをインポート
15$importedNode = $newDom->importNode($nodeToImport, true); // 第2引数: deep = true (子ノードもインポート)
16
17// インポートしたノードを新しいドキュメントに追加
18$newDom->appendChild($importedNode);
19
20// 新しいドキュメントの内容を表示 (例)
21echo $newDom->saveXML();

DOMDocument::importNodeメソッドは、あるドキュメントから別のドキュメントへノードをコピーするために使用します。このメソッドは、PHP 8のDOM拡張に含まれています。

第一引数 $node には、インポートしたいノードを指定します。このノードは、別のDOMDocumentオブジェクトに属している必要があります。

第二引数 $deep はオプションで、デフォルトはfalseです。trueを指定すると、指定されたノードの子ノードも再帰的にインポートされます。falseの場合は、ノード自体のみがインポートされ、子ノードはインポートされません。

戻り値は、インポートされたノードを表すDOMNodeオブジェクトです。インポートに失敗した場合は、nullを返します。

サンプルコードでは、まずDOMDocumentオブジェクト $dom を作成し、インポートするノード $nodeToImport を作成しています。次に、インポート先のDOMDocumentオブジェクト $newDom を作成します。$newDom->importNode($nodeToImport, true) で $nodeToImport を $newDom にインポートし、その結果を $importedNode に格納しています。true を指定しているため、$nodeToImport の子ノードも一緒にインポートされます。最後に、インポートされたノードを新しいドキュメントに追加し、saveXML() メソッドでドキュメントの内容をXML形式で表示しています。これにより、ノードが正常にインポートされたことを確認できます。

Copy
1<?php
2
3// DOMDocument を作成
4$dom = new DOMDocument();
5
6// インポートするノードを作成
7$newNode = $dom->createElement('newElement', '新しい要素');
8
9// インポート元となる別の DOMDocument を作成
10$importDom = new DOMDocument();
11$importDom->loadXML('<root><element>インポートする要素</element></root>');
12
13// インポートするノードを取得
14$nodeToImport = $importDom->getElementsByTagName('element')->item(0);
15
16// ノードをインポート (deep = true の場合、子ノードもコピー)
17$importedNode = $dom->importNode($nodeToImport, true);
18
19// インポートしたノードを新しいノードに追加
20$newNode->appendChild($importedNode);
21
22// ドキュメントのルート要素に追加
23$dom->appendChild($newNode);
24
25// 結果を出力
26echo $dom->saveXML();

このPHPのサンプルコードは、DOMDocumentクラスのimportNodeメソッドの使い方を示しています。importNodeメソッドは、別のドキュメントからノードを現在のドキュメントにコピーするために使用されます。システムエンジニアを目指す初心者の方にも理解しやすいように、各ステップを解説します。

まず、DOMDocumentクラスのインスタンス $dom を作成し、新しい要素 $newNode を作成しています。次に、インポート元となる別の DOMDocument インスタンス $importDom を作成し、XML文字列をロードしています。

$importDom からインポートしたいノード $nodeToImport を取得し、$dom->importNode($nodeToImport, true) を実行しています。importNodeメソッドの第一引数にはインポートするノードを指定し、第二引数 $deep はオプションで、true を指定すると、ノードの子ノードも再帰的にコピーします。false を指定した場合、ノード自身のみがコピーされます。このサンプルでは $deep = true を指定しているため、<element> 要素とその子ノードがコピーされます。

importNodeメソッドは、インポートされたノードを返します。もしノードのインポートに失敗した場合は、null を返します。

最後に、インポートされたノードを $newNode に追加し、$newNode を $dom のルート要素に追加しています。そして、saveXMLメソッドを使って、DOMDocument の内容をXML形式で出力しています。このコードを実行することで、別のドキュメントからノードをコピーし、現在のドキュメントに追加する方法を学ぶことができます。