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

Copy
1<?php
2
3/**
4 * DOMImplementation::createDocument を使用して新しいXMLドキュメントを作成し、
5 * その中で DOMDocument::createDocumentFragment を利用するサンプル。
6 *
7 * システムエンジニアを目指す初心者向けに、XMLドキュメントの基本的な構築方法を示します。
8 */
9function createAndManipulateDomDocument(): void
10{
11    // 1. DOMImplementation のインスタンスを作成します。
12    // このオブジェクトは、新しいドキュメントを作成するためのメソッドを提供します。
13    $domImplementation = new DOMImplementation();
14
15    // オプションで、DTD (Document Type Definition) を作成します。
16    // createDocument メソッドは、この DTD を新しいドキュメントに関連付けることができます。
17    $doctype = $domImplementation->createDocumentType('myroot', '', 'myroot.dtd');
18
19    // 2. createDocument を使用して新しい DOMDocument を作成します。
20    // 引数:
21    //   - $namespaceURI: XML 名前空間URI（例: 'http://www.example.com/ns'）
22    //   - $qualifiedName: ルート要素の修飾名（例: 'ns:myroot'）
23    //   - $doctype: 上で作成した DOMDocumentType オブジェクト（オプション）
24    // このメソッドは、指定された名前空間とルート要素を持つ新しいDOMDocumentオブジェクトを返します。
25    $document = $domImplementation->createDocument(
26        'http://www.example.com/mynamespace', // 新しいドキュメントの名前空間URI
27        'mynamespace:data',                     // ルート要素の修飾名
28        $doctype                               // オプションのDOCTYPE
29    );
30
31    // 生成されるXMLを読みやすくするために、整形を有効にします。
32    $document->formatOutput = true;
33
34    // createDocument によって自動的に作成されたルート要素を取得します。
35    $rootElement = $document->documentElement;
36
37    // 3. ドキュメントフラグメント (DocumentFragment) を作成し、複数のノードを追加します。
38    // ドキュメントフラグメントは、複数のノードを一時的に保持し、
39    // 後で効率的にドキュメントツリーに追加するための軽量なコンテナです。
40    // フラグメント自体は最終的なドキュメントツリーの一部として表示されません。
41    $fragment = $document->createDocumentFragment();
42
43    // フラグメントに最初の新しい要素（<item id="a1">データ1</item>）を追加します。
44    $item1 = $document->createElement('item');
45    $item1->setAttribute('id', 'a1');
46    $item1->textContent = 'データ1';
47    $fragment->appendChild($item1);
48
49    // フラグメントに2番目の新しい要素（<item id="a2">データ2</item>）を追加します。
50    $item2 = $document->createElement('item');
51    $item2->setAttribute('id', 'a2');
52    $item2->textContent = 'データ2';
53    $fragment->appendChild($item2);
54
55    // 作成したドキュメントフラグメントをルート要素に追加します。
56    // この操作により、フラグメントの子ノード（item1とitem2）が、
57    // フラグメントがあった位置に直接挿入されます。
58    $rootElement->appendChild($fragment);
59
60    // 4. 生成されたXMLドキュメントの内容を表示します。
61    echo "生成されたXMLドキュメント:\n";
62    echo $document->saveXML();
63}
64
65// 上記の関数を実行して、XMLドキュメントの作成と操作の例を確認します。
66createAndManipulateDomDocument();

DOMImplementation::createDocumentメソッドは、PHPで新しいXMLドキュメント（DOMDocumentオブジェクト）を一から作成するために使用されます。このメソッドは、第一引数でXML名前空間URI、第二引数でルート要素の修飾名（例: prefix:tag）、そして第三引数でオプションのDOMDocumentType（DTD）を指定できます。これらの設定が適用されたDOMDocumentオブジェクトを戻り値として返します。

サンプルコードでは、まずDOMImplementationのインスタンスを作成し、createDocumentTypeでDTDを準備しています。次に、createDocumentを使って指定した名前空間とルート要素、そしてDTDを持つ新しいDOMDocumentを生成しています。生成されたドキュメントはformatOutputをtrueに設定することで、出力時に読みやすく整形されます。

さらに、DOMDocument::createDocumentFragmentを利用してドキュメントフラグメントを作成し、その中に複数の<item>要素を追加しています。このドキュメントフラグメントは、複数のノードを効率的にドキュメントツリーに追加するための一時的なコンテナであり、フラグメント自体は最終的なXMLドキュメントには含まれず、その子ノードのみが挿入されます。これにより、複数の要素をまとめてルート要素に追加する操作が簡潔に行われています。最終的にsaveXML()メソッドで構築されたXMLコンテンツが出力され、PHPでXMLドキュメントをプログラム的に作成する基本的な流れが示されています。