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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\Implementation::createDocument と DOMDocument::createDocumentFragment の使用例
7 *
8 * 新しいXMLドキュメントを作成し、DOMDocumentFragmentを使って効率的に要素を追加する方法を示します。
9 * システムエンジニアを目指す初心者向けに、XMLドキュメントの基本的な構築手順を簡潔に示します。
10 */
11function createAndManipulateDocument(): void
12{
13    // 1. Dom\Implementation のインスタンスを作成
14    // このクラスは、DOMDocument や DocumentType オブジェクトを作成するためのメソッドを提供します。
15    $domImplementation = new Dom\Implementation();
16
17    // 2. createDocument メソッドを使って新しいDOMDocumentオブジェクトを作成
18    // 第一引数: 名前空間URI (今回はXMLなのでnull)
19    // 第二引数: ドキュメントのルート要素の修飾名 (例: "data")
20    // 第三引数: DocumentType オブジェクト (今回はnull)
21    // ここで、XML文書の基本的な構造（ルート要素）を定義します。
22    $document = $domImplementation->createDocument(null, 'data');
23
24    // DOMDocumentの作成に失敗した場合の基本的なチェック
25    if (!$document instanceof DOMDocument) {
26        echo "エラー: DOMDocumentの作成に失敗しました。\n";
27        return;
28    }
29
30    // 3. DOMDocument::createDocumentFragment() メソッドを使って新しいDOMDocumentFragmentを作成
31    // DocumentFragment は、文書ツリーの軽量な部分を表します。
32    // 複数のノードをメモリ上で一度に作成し、後でDOMDocumentにまとめて追加するのに役立ちます。
33    // これにより、DOMツリーへの追加操作が何度も発生するのを防ぎ、パフォーマンスを向上させることができます。
34    $fragment = $document->createDocumentFragment();
35
36    // 4. DOMDocumentFragmentに要素を追加
37    // 例として、<item>要素を2つ作成し、それぞれにテキストノードを追加してフラグメントに追加します。
38    $item1 = $document->createElement('item');
39    $item1->textContent = 'Apple';
40    $fragment->appendChild($item1);
41
42    $item2 = $document->createElement('item');
43    $item2->textContent = 'Banana';
44    $fragment->appendChild($item2);
45
46    // 5. DOMDocumentFragmentをDOMDocumentに挿入
47    // ここでは、作成したフラグメントの内容を文書のルート要素に子として追加します。
48    // フラグメント自体は挿入されず、その全ての子ノードがそのまま挿入されます。
49    // `documentElement`はルート要素を表します。
50    $document->documentElement?->appendChild($fragment);
51
52    // 6. 生成されたドキュメントをXML形式で出力
53    // `formatOutput`を`true`に設定することで、出力XMLが読みやすいように整形されます。
54    $document->formatOutput = true;
55    echo "生成されたXMLドキュメント:\n";
56    echo $document->saveXML();
57}
58
59// 関数を実行し、サンプルコードの動作を確認します。
60createAndManipulateDocument();
61

このサンプルコードは、PHPでXMLドキュメントを効率的に作成・操作する方法を、システムエンジニアを目指す初心者向けに示しています。

まず、Dom\Implementationクラスのインスタンスを作成します。このクラスは、XMLドキュメントなどのDOMオブジェクトを生成するための標準的な方法を提供します。次に、$domImplementation->createDocument()メソッドを使用して新しいDOMDocumentオブジェクトを作成します。このメソッドは、第一引数に名前空間URI、第二引数にドキュメントのルート要素の修飾名、第三引数にDocumentTypeオブジェクト（不要な場合はnull）を取り、新しいXMLドキュメントを表すDOMDocumentオブジェクトを返します。ここでは、ルート要素としてdataを指定し、XMLの骨格を定義しています。

次に、$document->createDocumentFragment()メソッドを呼び出し、DOMDocumentFragmentを作成します。これは、複数のXMLノードを一時的に保持するための軽量なコンテナで、実際のドキュメントツリーとは独立しています。このフラグメントに複数の要素（例：<item>）を追加し、最後に$document->documentElement?->appendChild($fragment)として、フラグメントに格納した全てのノードを一度にドキュメントのルート要素に追加します。このようにDOMDocumentFragmentを利用することで、個々のノードを何度もドキュメントツリーに挿入する手間を省き、パフォーマンスを向上させることができます。最終的に、生成されたXMLドキュメントは整形されて出力されます。