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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createElementNS メソッドを使用して、
5 * 名前空間を持つXML要素を作成し、XMLドキュメントに追加するサンプルコードです。
6 *
7 * システムエンジニアを目指す初心者の方向けに、
8 * XMLの名前空間付き要素の作成方法を簡潔に示します。
9 */
10function createXmlElementWithNamespace(): string
11{
12    // 新しいXMLドキュメントインスタンスを作成します。
13    // PHP 8ではDom\XMLDocumentクラスが利用可能です。
14    $dom = new Dom\XMLDocument();
15
16    // XML出力時に整形（インデントなど）するための設定です。
17    // これにより、生成されるXMLが見やすくなります。
18    $dom->formatOutput = true;
19    $dom->preserveWhiteSpace = false; // 空白ノードを保持しない設定
20
21    // ルート要素を作成し、ドキュメントに追加します。
22    // この要素は名前空間を持たないシンプルな「Root」要素です。
23    $rootElement = $dom->createElement('Root');
24    $dom->appendChild($rootElement);
25
26    // Dom\XMLDocument::createElementNS メソッドを使用して、
27    // 名前空間を持つXML要素を作成します。
28    // 第一引数: 名前空間のURI (Uniform Resource Identifier) を指定します。
29    // 第二引数: 修飾名 (qualified name) を指定します。これは「プレフィックス:ローカル名」の形式です。
30    $namespaceUri = 'http://www.example.com/my-app/data-ns';
31    $qualifiedName = 'app:DataItem';
32    $dataElement = $dom->createElementNS($namespaceUri, $qualifiedName);
33
34    // 作成した名前空間付き要素にテキストコンテンツを追加します。
35    $dataElement->appendChild($dom->createTextNode('この要素は名前空間を持っています。'));
36
37    // 名前空間付き要素を、先に作成したルート要素の子として追加します。
38    $rootElement->appendChild($dataElement);
39
40    // 同じ名前空間URIで、別の名前空間付き要素も追加してみます。
41    $anotherQualifiedName = 'app:Status';
42    $statusElement = $dom->createElementNS($namespaceUri, $anotherQualifiedName);
43    $statusElement->appendChild($dom->createTextNode('OK'));
44    $rootElement->appendChild($statusElement);
45
46    // 構築したXMLドキュメント全体をXML文字列として保存し、その文字列を返します。
47    return $dom->saveXML();
48}
49
50// 関数を実行し、生成されたXML文字列を出力します。
51echo createXmlElementWithNamespace();

PHP 8のDom\XMLDocument::createElementNSメソッドは、XMLドキュメント内で名前空間を持つ新しい要素を作成するために使用されます。システムエンジニアを目指す初心者の方にとって、XMLの名前空間は、複数のXML語彙を組み合わせる際に要素名の衝突を防ぎ、データを適切に識別するための重要な概念です。

このメソッドはDom\XMLDocumentクラスに属し、二つの引数を取ります。第一引数$namespaceには、作成する要素の名前空間を識別するURI（Uniform Resource Identifier）を文字列で指定します。第二引数$qualifiedNameには、'プレフィックス:ローカル名'という形式で、要素の修飾名を文字列で指定します。このプレフィックスは、指定された名前空間URIと関連付けられます。メソッドは、作成された新しいDom\Elementオブジェクトを返します。この戻り値のDom\Elementは、他の要素の追加や属性の設定などに利用できます。

サンプルコードでは、まず新しいDom\XMLDocumentインスタンスを作成し、formatOutputプロパティを設定してXMLの出力を見やすくしています。その後、createElementでシンプルなルート要素を作成し、ドキュメントに追加しています。続けてcreateElementNSメソッドを使用し、'http://www.example.com/my-app/data-ns'というURIと'app:DataItem'という修飾名で名前空間付き要素を作成しています。この要素は、appendChildメソッドでルート要素の子として追加されます。これにより、XMLドキュメントに名前空間が適用された要素が適切に組み込まれ、最終的にsaveXML()メソッドで構築されたXML文字列として出力されます。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createElementNS メソッドを使用して、
5 * 名前空間を持つXML要素を作成するサンプルコード。
6 *
7 * システムエンジニアを目指す初心者向けに、XMLドキュメントの作成と
8 * 名前空間付き要素の追加方法を簡潔に示します。
9 */
10function createSvgDocumentWithNamespace(): string
11{
12    // 新しい Dom\XMLDocument オブジェクトをインスタンス化します。
13    // PHP 8以降では Dom\XMLDocument クラスが導入されました。
14    $document = new Dom\XMLDocument();
15
16    // XML宣言のバージョンとエンコーディングを設定します。
17    $document->xmlVersion = '1.0';
18    $document->encoding = 'UTF-8';
19
20    // SVG (Scalable Vector Graphics) の名前空間URIを定義します。
21    $svgNamespaceUri = 'http://www.w3.org/2000/svg';
22
23    // createElementNS メソッドを使用して、名前空間付きのルート要素 <svg:svg> を作成します。
24    // 第1引数に名前空間URI、第2引数にプレフィックス付きの要素名（修飾名）を指定します。
25    $svgElement = $document->createElementNS($svgNamespaceUri, 'svg:svg');
26
27    // 作成した <svg:svg> 要素をドキュメントのルートとして追加します。
28    $document->appendChild($svgElement);
29
30    // <svg:svg> 要素に属性を追加します。
31    $svgElement->setAttribute('width', '200');
32    $svgElement->setAttribute('height', '150');
33    $svgElement->setAttribute('viewBox', '0 0 200 150');
34
35    // 名前空間付きの子要素 <svg:rect> を作成します。
36    // この要素も同じSVG名前空間に属します。
37    $rectElement = $document->createElementNS($svgNamespaceUri, 'svg:rect');
38
39    // <svg:rect> 要素に属性を追加します。
40    $rectElement->setAttribute('x', '50');
41    $rectElement->setAttribute('y', '25');
42    $rectElement->setAttribute('width', '100');
43    $rectElement->setAttribute('height', '100');
44    $rectElement->setAttribute('fill', 'red');
45    $rectElement->setAttribute('stroke', 'black');
46    $rectElement->setAttribute('stroke-width', '2');
47
48    // <svg:rect> 要素を <svg:svg> 要素の子要素として追加します。
49    $svgElement->appendChild($rectElement);
50
51    // 生成されるXMLを整形して出力するために、formatOutput プロパティを true に設定します。
52    $document->formatOutput = true;
53
54    // ドキュメント全体をXML文字列として保存し、返却します。
55    return $document->saveXML();
56}
57
58// 関数を実行し、生成されたXML文字列を表示します。
59echo createSvgDocumentWithNamespace();
60

このサンプルコードは、PHP 8で導入されたDom\XMLDocumentクラスと、そのcreateElementNSメソッドを用いて、名前空間を持つXML要素を作成する方法を示しています。まず、Dom\XMLDocumentのインスタンスを生成し、XML宣言のバージョンとエンコーディングを設定します。

createElementNSメソッドは、名前空間が指定されたXML要素を生成するために使用されます。XMLにおける名前空間は、異なるXML語彙（例えばSVGやXHTMLなど）の要素が同じドキュメント内で混在する際に、要素がどの定義に属するかを明確にする重要な仕組みです。

このメソッドの第1引数には、要素が所属する名前空間のURI（Uniform Resource Identifier）を文字列で指定します。サンプルではSVGの名前空間URIを使用しています。第2引数には、要素の修飾名（qualified name）を文字列で指定します。これは通常、「プレフィックス:ローカル名」の形式です（例: svg:svgやsvg:rect）。メソッドは、これらの情報を持つ新しいDom\Elementオブジェクトを戻り値として返します。

取得したDom\Elementオブジェクトには、setAttributeメソッドで属性を追加したり、appendChildメソッドで他の要素の子として追加したりできます。サンプルでは、ルート要素である<svg:svg>と、その子要素である<svg:rect>をcreateElementNSで作成し、それぞれに属性を設定してSVG画像を表すXMLドキュメントを構築しています。最後に、saveXML()メソッドで構築したドキュメント全体をXML文字列として取得し、出力しています。この一連の流れで、名前空間を含むXML構造をプログラム的に生成する方法を理解できます。