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

Copy
1<?php
2
3// PHPのDOM操作ライブラリは、PHP 8で刷新され、Dom\Documentなどの新しいクラスが導入されました。
4// それ以前のバージョンで使用されていた DOMDocument クラスなどのオブジェクトは「レガシーノード」と呼ばれます。
5// このサンプルコードは、古い DOMDocument から作成されたノードを、新しい Dom\Document にインポートする方法を示します。
6
7// 1. 古いDOM拡張 (PHP 7.x以前の形式) の DOMDocument を作成し、ノードを追加します。
8$oldDomDocument = new DOMDocument('1.0', 'UTF-8');
9$oldElement = $oldDomDocument->createElement('legacyRoot');
10$oldDomDocument->appendChild($oldElement);
11
12// インポート元となる子ノードを作成し、古い要素に追加
13$oldChildElement = $oldDomDocument->createElement('legacyChild', 'Hello from old DOM!');
14$oldElement->appendChild($oldChildElement);
15
16echo "--- 元の古いDOMDocumentの内容 ---\n";
17echo $oldDomDocument->saveXML() . "\n\n";
18
19// 2. 新しい Dom 拡張 (PHP 8.x以降の形式) の Dom\Document を作成します。
20$newDomDocument = new Dom\Document('1.0', 'UTF-8');
21$newDomDocument->formatOutput = true; // 出力を見やすくするため
22
23// 3. 古いDOMDocumentから取得したノード（ここでは $oldElement）を、新しいDom\Documentにインポートします。
24// importLegacyNode メソッドは、古い DOMNode オブジェクトを受け取り、
25// 新しい Dom\Node オブジェクトとして返します。
26// 第2引数 'true' は、元のノードの子ノードも再帰的にインポートすることを意味します。
27$importedNode = $newDomDocument->importLegacyNode($oldElement, true);
28
29// 4. インポートしたノードを新しいDom\Documentのルートに追加します。
30// これにより、$importedNode (legacyRoot とその子 legacyChild) が新しいドキュメントの一部となります。
31$newDomDocument->appendChild($importedNode);
32
33// 5. 新しいDom\Documentの内容を出力して確認します。
34echo "--- importLegacyNode でインポートした後の新しいDom\\Documentの内容 ---\n";
35echo $newDomDocument->saveXML();
36
37?>

PHP 8では、DOM操作に関するライブラリが刷新され、Dom\Documentなどの新しいクラスが導入されました。これに伴い、PHP 7.x以前のバージョンで使用されていたDOMDocumentクラスで扱われるノードは「レガシーノード」と呼ばれます。Dom\Document::importLegacyNodeメソッドは、このレガシーノードを新しいDom\Documentにインポート（取り込み）するために使用されます。

サンプルコードでは、まず古いDOMDocumentオブジェクトを作成し、「legacyRoot」とその子ノード「legacyChild」を追加して、インポート元のデータを用意しています。次に、新しいDom\Documentオブジェクトを作成します。

importLegacyNodeメソッドの呼び出しでは、インポートしたいレガシーノード（ここでは$oldElement）を第一引数$nodeとして渡します。第二引数$deepにはtrueを指定しており、これは元のノードだけでなく、その子ノードもすべて再帰的にインポートすることを意味します。このメソッドは、インポートされた新しいDom\Nodeオブジェクトを戻り値として返します。

インポートされた$importedNodeは、新しいDom\DocumentにappendChildメソッドで追加され、最終的に新しいドキュメントの内容として出力されます。これにより、古い形式で作成されたXML構造を、新しいDom\Document環境でシームレスに扱えるようになります。このメソッドは、既存の古いDOMコードベースから新しいDOM拡張への移行や、異なるDOM環境間でのデータ連携が必要な場合に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Document::importLegacyNode の使用例を示します。
5 * このメソッドは、PHPの古い DOM 拡張 (DOMDocument, DOMNode など) で作成されたノードを、
6 * PHP 8.0 以降で導入された新しい Dom 拡張 (Dom\Document, Dom\Node など) のドキュメントに
7 * インポートするために使用されます。
8 *
9 * システムエンジニアを目指す初心者の方へ:
10 * PHPにおいて「implements」は、クラスがインターフェースを実装する際に使うキーワードです。
11 * インターフェースは、クラスが持つべきメソッドやプロパティの「契約」を定義します。
12 *
13 * この importLegacyNode メソッドやサンプルコードは直接「implements」キーワードを使用しませんが、
14 * 「異なるシステム（ここでは古いDOM拡張と新しいDom拡張）が、それぞれ異なる方法で
15 * ドキュメントやノードの操作機能を提供している（=異なる実装を持っている）」状況において、
16 * その間の互換性を提供し、ノードを移行させる役割を果たします。
17 * これは、異なるAPIの「実装」間でデータを連携させる一例と捉えることができます。
18 */
19class LegacyNodeImporter
20{
21    /**
22     * 古い DOM 拡張のノードを新しい Dom 拡張のドキュメントにインポートするサンプル。
23     *
24     * @return void
25     */
26    public function importAndDisplayNode(): void
27    {
28        echo "--- Dom\\Document::importLegacyNode の実演 ---\n\n";
29
30        // 1. 古い PHP の DOM 拡張を使ってXMLドキュメントとノードを作成します。
31        //    これはPHP 8.0 より前の環境で広く使われていたDOM操作方法です。
32        $legacyDom = new DOMDocument('1.0', 'UTF-8');
33        $legacyRoot = $legacyDom->createElement('legacyRoot');
34        $legacyDom->appendChild($legacyRoot);
35
36        $legacyElement = $legacyDom->createElement('oldItem', 'これは古いDOMから来た要素です。');
37        $legacyRoot->appendChild($legacyElement);
38
39        echo "元のレガシーDOMドキュメント:\n";
40        echo $legacyDom->saveXML() . "\n\n";
41
42        // 2. 新しい Dom 拡張のドキュメントを作成します。
43        //    これはPHP 8.0 以降で利用可能な、よりモダンなDOM拡張です。
44        $newDom = new Dom\Document('1.0', 'UTF-8');
45        $newRoot = $newDom->createElement('newRoot');
46        $newDom->appendChild($newRoot);
47
48        // 3. importLegacyNode を使用して、古いDOM拡張のノードを新しいDomドキュメントにインポートします。
49        //    - 第1引数: インポートしたい古い DOMNode オブジェクト ($legacyElement)。
50        //    - 第2引数: $deep (bool)。true の場合、子ノードも再帰的にインポートします。
51        //              ここではテキストノードもインポートするため true を指定します。
52        $importedNode = $newDom->importLegacyNode($legacyElement, true);
53
54        // 4. インポートされたノードを新しいDomドキュメントに追加します。
55        //    importLegacyNode の戻り値は Dom\Node なので、新しいDomドキュメントに直接追加できます。
56        $newRoot->appendChild($importedNode);
57
58        echo "importLegacyNode でインポートされた後の新しいDomドキュメント:\n";
59        echo $newDom->saveXML() . "\n\n";
60
61        echo "--- 補足 ---\n";
62        echo "この例では、異なるDOM API (レガシーな DOM 拡張と新しい Dom 拡張) の間で\n";
63        echo "ノードを互換性のある形で移行できることを示しました。\n";
64    }
65}
66
67// サンプルコードを実行します。
68$importer = new LegacyNodeImporter();
69$importer->importAndDisplayNode();

PHP 8.0で導入されたDom\Document::importLegacyNodeは、古いPHPのDOM拡張（DOMDocument、DOMNodeなど）で作成されたノードを、新しいDom拡張（Dom\Document、Dom\Nodeなど）のドキュメントにインポートするためのメソッドです。これにより、PHP 8.0以降の環境で、以前のバージョンのDOM操作で生成された要素を新しい形式で扱うことが可能になります。

このメソッドは、第一引数にインポートしたいDOMNodeオブジェクトを指定します。第二引数$deepは真偽値で、trueを設定すると、指定されたノードだけでなく、その子ノードもすべて再帰的に新しいドキュメントにインポートされます。メソッドの戻り値は、新しくインポートされたDom\Nodeオブジェクトとなり、これを新しいDom\Documentに追加して利用できます。

PHPにおけるimplementsは、クラスが特定のインターフェースを実装する際に用いるキーワードです。importLegacyNode自体はimplementsを直接使用しませんが、これは古いDOM拡張と新しいDom拡張という「異なる実装」を持つシステム間で、ノードというデータを連携・移行させるための互換性機能を提供します。これは、異なるAPIの実装間でデータを扱う際の一つの解決策と言えるでしょう。