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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createDocumentFragment メソッドの使用例を示します。
5 * このメソッドは、複数のDOMノードを一時的に保持するための
6 * Dom\DocumentFragment オブジェクトを作成します。
7 * フラグメント自身はドキュメントツリーの一部ではありませんが、
8 * その子ノードを効率的にドキュメントツリーに挿入できます。
9 *
10 * この関数は、XMLドキュメントを作成し、フラグメントを使って
11 * 複数の要素を一度にそのドキュメントに追加する方法を実演します。
12 */
13function createDocumentFragmentExample(): void
14{
15    // 新しい Dom\XMLDocument オブジェクトを作成します。
16    // '1.0' はXMLのバージョン、'utf-8' はエンコーディングです。
17    $dom = new Dom\XMLDocument('1.0', 'utf-8');
18
19    // ドキュメントにルート要素 'data' を追加します。
20    // XMLドキュメントには常に単一のルート要素が必要です。
21    $rootElement = $dom->createElement('data');
22    $dom->appendChild($rootElement);
23
24    // Dom\DocumentFragment を作成します。
25    // これは、DOMツリーに直接追加する前に複数のノードをグループ化するための
26    // 軽量なコンテナとして機能します。
27    $fragment = $dom->createDocumentFragment();
28
29    // フラグメントに子要素を追加します。
30    // ここでは、2つの 'item' 要素を作成し、それぞれにテキストコンテンツを設定して
31    // フラグメントの子とします。
32    $item1 = $dom->createElement('item', '最初のアイテム');
33    $item2 = $dom->createElement('item', '二番目のアイテム');
34
35    $fragment->appendChild($item1);
36    $fragment->appendChild($item2);
37
38    // 作成した Dom\DocumentFragment の内容を、ルート要素 'data' の子として追加します。
39    // この操作により、$item1 と $item2 は $rootElement の直接の子となります。
40    // フラグメント自体はドキュメントには追加されず、その内容のみが挿入されます。
41    $rootElement->appendChild($fragment);
42
43    // 完成したXMLドキュメントを出力します。
44    // 期待される出力は、<data><item>最初のアイテム</item><item>二番目のアイテム</item></data> のような形式です。
45    echo $dom->saveXML();
46}
47
48// サンプル関数を実行します。
49createDocumentFragmentExample();
50

Dom\XMLDocument::createDocumentFragmentメソッドは、複数のDOMノードを一時的にまとめて保持するためのDom\DocumentFragmentオブジェクトを作成します。このメソッドは引数を取らず、新しく生成されたDom\DocumentFragmentのインスタンスを返します。Dom\DocumentFragment自体はXMLドキュメントツリーに直接追加されることはありませんが、その子ノード群を効率的にドキュメントツリーの特定の位置へ挿入するための軽量なコンテナとして機能します。

サンプルコードでは、まず新しいDom\XMLDocumentを作成し、XMLのルート要素となるdata要素をドキュメントに追加しています。その後、createDocumentFragmentメソッドを呼び出してDom\DocumentFragmentを生成します。このフラグメントには、「最初のアイテム」と「二番目のアイテム」というテキストを含む二つのitem要素が子として追加されます。最後に、この準備されたDom\DocumentFragmentをルート要素dataの子として追加することで、フラグメント内にあった二つのitem要素が一度にドキュメントに挿入されます。このように、多数の要素をまとめてドキュメントに追加する際にDom\DocumentFragmentを使用すると、DOM操作の回数を減らし、処理の効率を高めることができます。最終的な出力は、<data><item>最初のアイテム</item><item>二番目のアイテム</item></data>のようなXML形式となります。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createDocumentFragment() メソッドの使用例を示します。
5 * DocumentFragment は、DOM ツリーへの挿入前に複数のノードをグループ化するための
6 * 軽量なコンテナです。これにより、DOM 操作のパフォーマンスを向上させることができます。
7 */
8function demonstrateCreateDocumentFragment(): void
9{
10    // 1. 新しい XML ドキュメントインスタンスを作成します。
11    $xmlDoc = new Dom\XMLDocument();
12    $xmlDoc->formatOutput = true; // 出力時にXMLを整形します
13
14    // ルート要素を作成し、ドキュメントに追加します。
15    $rootElement = $xmlDoc->createElement('data');
16    $xmlDoc->appendChild($rootElement);
17
18    // 2. createDocumentFragment() メソッドを使用して DocumentFragment を作成します。
19    //    これは一時的なノードのコンテナとして機能します。
20    $fragment = $xmlDoc->createDocumentFragment();
21
22    // 3. DocumentFragment に要素とテキストノードを追加します。
23    //    これらの操作は、まだメインの XML ドキュメントには反映されません。
24    $item1 = $xmlDoc->createElement('item');
25    $item1->setAttribute('id', 'A');
26    $item1->appendChild($xmlDoc->createTextNode('First item content'));
27    $fragment->appendChild($item1);
28
29    $item2 = $xmlDoc->createElement('item');
30    $item2->setAttribute('id', 'B');
31    $item2->appendChild($xmlDoc->createTextNode('Second item content'));
32    $fragment->appendChild($item2);
33
34    // 4. 作成した DocumentFragment 全体をメインの XML ドキュメント内の要素に一度に追加します。
35    //    これにより、フラグメント内の全てのノードが効率的に移動されます。
36    $rootElement->appendChild($fragment);
37
38    // 5. 結果として生成された XML を出力します。
39    echo "Generated XML:\n";
40    echo $xmlDoc->saveXML();
41}
42
43// 関数を実行してデモンストレーションを開始します。
44demonstrateCreateDocumentFragment();
45
46?>

Dom\XMLDocument::createDocumentFragment()メソッドは、PHP 8でXMLドキュメントの効率的な操作を可能にする機能です。このメソッドは引数を取らず、Dom\DocumentFragmentという特殊なオブジェクトを返します。Dom\DocumentFragmentは、DOMツリーに直接追加する前に複数のDOMノードを一時的に保持するための軽量なコンテナとして機能します。これにより、DOMツリーへの頻繁な変更を避けてパフォーマンスの向上を図ることができます。

サンプルコードでは、まず新しいDom\XMLDocumentを作成し、ルート要素を設定しています。次に、createDocumentFragment()を呼び出して空のフラグメントを作成します。このフラグメントに対して、新しく作成した<item>要素やテキストノードを追加していきます。これらの操作は、まだメインのXMLドキュメントには反映されません。全ての必要なノードをフラグメント内に構築した後、そのDocumentFragment全体をメインドキュメントのルート要素に一度だけappendChild()メソッドで追加します。このように、複数のノードを一度に挿入することで、DOM操作の回数を最小限に抑え、処理速度の向上に貢献します。最終的に、完成したXMLドキュメントの内容が整形されて出力されます。