【PHP8.x】Dom\import_simplexml関数の使い方

Copy
1<?php
2
3/**
4 * SimpleXMLElementをDOMElementに変換し、その使い方を示す関数です。
5 *
6 * PHPの `dom_import_simplexml` 関数は、`SimpleXMLElement` オブジェクトから
7 * 対応する `DOMElement` ノードを取得するために使用されます。
8 * これにより、SimpleXMLとDOMの異なるAPIを組み合わせてXMLを操作できます。
9 */
10function demonstrateDomImportSimplexml(): void
11{
12    // 1. サンプルとなるXML文字列からSimpleXMLElementオブジェクトを作成します。
13    $xmlString = '<data><item id="A1">最初の要素</item><item id="B2">二番目の要素</item></data>';
14    $simpleXml = simplexml_load_string($xmlString);
15
16    if ($simpleXml === false) {
17        echo "エラー: SimpleXMLのパースに失敗しました。\n";
18        return;
19    }
20
21    echo "--- 元のSimpleXMLElementの構造 ---\n";
22    echo $simpleXml->asXML();
23    echo "---------------------------------\n\n";
24
25    // 2. SimpleXMLElementの特定の子要素（ここでは最初の<item>）をターゲットにします。
26    $targetSimpleXmlElement = $simpleXml->item[0];
27
28    echo "--- 変換対象のSimpleXMLElement要素 ---\n";
29    echo "ノード名: " . $targetSimpleXmlElement->getName() . "\n";
30    echo "値: " . (string)$targetSimpleXmlElement . "\n";
31    echo "属性 'id': " . (string)$targetSimpleXmlElement['id'] . "\n";
32    echo "-------------------------------------\n\n";
33
34    // 3. `dom_import_simplexml` 関数を使用して、SimpleXMLElementをDOMElementに変換します。
35    // この関数は、対応するDOMElementオブジェクトを返します。
36    // 失敗した場合は `false` または `null` を返します。
37    $domElement = dom_import_simplexml($targetSimpleXmlElement);
38
39    if ($domElement === false || $domElement === null) {
40        echo "エラー: SimpleXMLElementからDOMElementへの変換に失敗しました。\n";
41        return;
42    }
43
44    echo "--- dom_import_simplexmlで取得されたDOMElement ---\n";
45    echo "DOMElementのノード名: " . $domElement->nodeName . "\n";
46    echo "DOMElementのノード値: " . $domElement->nodeValue . "\n";
47    echo "DOMElementの属性 'id': " . $domElement->getAttribute('id') . "\n";
48    echo "--------------------------------------------------\n\n";
49
50    // 4. 取得したDOMElementを新しいDOMDocumentに追加する例です。
51    // `dom_import_simplexml` が返すDOMElementは、元のSimpleXMLオブジェクトが
52    // 内部的に使用しているDOMDocumentの一部を指しています。
53    // 別のDOMDocumentに移動させる場合は `DOMDocument::importNode()` を使用します。
54    $newDomDocument = new DOMDocument('1.0', 'UTF-8');
55    $newDomDocument->formatOutput = true; // 出力を見やすく整形します
56
57    // `importNode` の第二引数 `true` は、子ノードも再帰的にインポートすることを意味します。
58    $importedNode = $newDomDocument->importNode($domElement, true);
59
60    // インポートしたノードを新しいDOMDocumentのルート要素として追加します。
61    $newDomDocument->appendChild($importedNode);
62
63    echo "--- 新しいDOMDocumentにインポート・追加された後のXML ---\n";
64    echo $newDomDocument->saveXML();
65    echo "-------------------------------------------------------\n";
66}
67
68// 関数を実行して動作を確認します。
69demonstrateDomImportSimplexml();
70

PHPのdom_import_simplexml関数は、XMLデータを扱う二つの異なるAPIであるSimpleXMLとDOM（Document Object Model）を相互に連携させるために利用されます。この関数は、引数として指定されたSimpleXMLElement $nodeオブジェクトから、それに対応するDOMElementオブジェクトを取得する役割を担います。

この関数が成功した場合、対応するDOMElementオブジェクトを返します。このDOMElementは、元のSimpleXMLオブジェクトが内部的に利用しているDOMDocument内のノードを指しています。変換に失敗した場合はfalseまたはnullが返されるため、戻り値のチェックが必要です。

サンプルコードでは、まずXML文字列からSimpleXMLElementを作成し、その中から特定のXML要素をターゲットとして選びます。次に、dom_import_simplexml関数を使用して、このターゲットのSimpleXMLElementをDOMElementに変換しています。これにより、DOMElementとして取得したノードを、DOMDocumentの豊富なAPIで操作したり、必要に応じて新しいDOMDocumentにimportNodeメソッドで追加したりすることが可能になります。この関数を使うことで、それぞれのXML APIの利点を組み合わせて、柔軟かつ効率的なXML処理を実現できます。