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

Copy
1<?php
2
3// Dom\Document クラスのインスタンスを作成します。
4// これはXMLドキュメント全体を表すオブジェクトで、XML宣言を含めています。
5$document = new Dom\Document('1.0', 'utf-8');
6
7// createElementNS メソッドを使用して、ネームスペースを持つ要素を作成します。
8// 第1引数: ネームスペースURI (Uniform Resource Identifier)。この要素が属するXMLネームスペースを指定します。
9// 第2引数: プレフィックス付きの要素名 (Qualified Name)。 "プレフィックス:ローカル名" の形式で指定します。
10//          ここで指定されたプレフィックスは、ネームスペースURIと自動的に関連付けられます。
11// 第3引数: 要素のテキストコンテンツ。この要素内に表示される文字列です。
12$element = $document->createElementNS(
13    'http://www.example.com/my-namespace', // この要素が属するネームスペースURI
14    'ns:dataItem',                         // プレフィックス付きの要素名 (例: ns:dataItem)
15    'これはネームスペース付きのデータです。' // 要素のテキストコンテンツ
16);
17
18// 作成した要素をドキュメントに追加します。
19// ドキュメントは通常、一つのルート要素を持つため、ここではルート要素として追加しています。
20$document->appendChild($element);
21
22// 生成されたXMLドキュメントを文字列として取得し、標準出力に出力します。
23// これにより、ネームスペースが定義された要素が正しく生成されていることを確認できます。
24echo $document->saveXML();
25
26?>

Dom\Document::createElementNSメソッドは、PHPでXMLドキュメントをプログラム的に構築する際に、XMLネームスペースを持つ新しい要素を作成するために利用されます。このメソッドは、XMLの標準的なネームスペースのルールに則って要素を生成できる点が特徴です。

第1引数 $namespace には、作成する要素が属するXMLネームスペースのURI（Uniform Resource Identifier）を指定します。これは、XMLドキュメント内で要素名が重複した際に区別するための識別子です。第2引数 $qualifiedName には、プレフィックス:ローカル名の形式で要素名を指定します。ここで指定されたプレフィックスは、第1引数で与えられたネームスペースURIと自動的に関連付けられます。第3引数 $value はオプションで、この要素内に表示されるテキストコンテンツを設定します。

このメソッドは、新しく作成されたDom\Elementオブジェクトを戻り値として返します。これは、作成された要素自体を表すオブジェクトであり、まだXMLドキュメントには追加されていません。サンプルコードでは、返された$elementを$document->appendChild()メソッドを使ってドキュメントのルート要素として追加し、最終的に$document->saveXML()でXML全体を出力しています。このように、createElementNSを使用することで、複雑なXML構造でもネームスペースを適切に管理しながら要素を生成することが可能になります。

Copy
1<?php
2
3/**
4 * Dom\Document::createElementNS メソッドの使用例を示します。
5 *
6 * XMLの名前空間を持つ要素を生成し、DOMドキュメントに追加する方法を簡潔に示します。
7 * システムエンジニアを目指す初心者にも分かりやすいよう、各ステップにコメントを付与しています。
8 *
9 * @return string 生成されたXML文字列
10 */
11function createNamespacedXmlElement(): string
12{
13    // 1. 新しいDOMドキュメントを作成します。
14    // '1.0'はXMLバージョン、'UTF-8'はエンコーディングです。
15    $document = new Dom\Document('1.0', 'UTF-8');
16    // 生成されるXMLが見やすくなるように整形オプションを有効にします。
17    $document->formatOutput = true;
18
19    // 2. XMLの名前空間URIを定義します。
20    // このURIは、XML要素がどの「名前空間」（特定の語彙のグループ）に属するかを識別するために使われます。
21    $mainNamespaceUri = 'http://example.com/mynamespace';
22
23    // 3. 名前空間を持つルート要素を作成します。
24    // createElementNS(名前空間URI, 修飾名, 要素のテキスト値)
25    // - $mainNamespaceUri: この要素が属する名前空間のURI。
26    // - 'my:root': 要素の修飾名。'my'はプレフィックス（接頭辞）、'root'はローカル名です。
27    //             プレフィックスはXML内で名前空間を簡潔に参照するために使われます。
28    // - 'これはルート要素です。': 要素のテキストコンテンツ。
29    $rootElement = $document->createElementNS($mainNamespaceUri, 'my:root', 'これはルート要素です。');
30    // 作成したルート要素をドキュメントの最上位に追加します。
31    $document->appendChild($rootElement);
32
33    // 4. 同じ名前空間（$mainNamespaceUri）内に子要素を作成し、ルート要素に追加します。
34    $childElement = $document->createElementNS($mainNamespaceUri, 'my:item', '最初のアイテム');
35    $rootElement->appendChild($childElement);
36
37    // 5. 別の名前空間を持つ子要素を作成し、ルート要素に追加します。
38    // この要素は、$mainNamespaceUri とは異なる名前空間に属します。
39    $anotherNamespaceUri = 'http://example.com/another/ns';
40    $anotherChildElement = $document->createElementNS($anotherNamespaceUri, 'other:data', '別の名前空間のデータ');
41    $rootElement->appendChild($anotherChildElement);
42
43    // 6. 生成されたDOMドキュメントをXML文字列として取得し、返します。
44    return $document->saveXML();
45}
46
47// 関数を実行し、生成されたXMLを標準出力します。
48echo createNamespacedXmlElement();
49

PHPのDom\Document::createElementNSメソッドは、XMLドキュメント内で名前空間を持つ新しい要素を作成するために使用されます。XMLの名前空間は、異なるXML語彙の要素を区別し、衝突を避けるために利用される重要な機能です。

このメソッドの最初の引数$namespaceには、要素が属する名前空間のURI（Uniform Resource Identifier）を指定します。このURIによって、要素がどの特定の名前空間に属するかが一意に識別されます。二番目の引数$qualifiedNameは、prefix:localnameという形式の修飾名です。prefixは名前空間を短く参照するための接頭辞で、localnameが要素の実際の名前です。三番目の引数$valueはオプションで、作成する要素のテキストコンテンツを指定できます。

メソッドは、指定された名前空間と修飾名を持つ新しいDom\Elementオブジェクトを返します。このオブジェクトは、まだドキュメントツリーには追加されていないため、通常はDom\Node::appendChildメソッドなどを使ってドキュメント内の適切な位置に追加する必要があります。

サンプルコードでは、まず新しいDom\Documentを作成し、http://example.com/mynamespaceというURIの名前空間を持つルート要素my:rootをcreateElementNSで生成しています。次に、同じ名前空間内の子要素my:itemと、http://example.com/another/nsという別の名前空間に属する子要素other:dataも同様に作成し、それぞれドキュメントに追加しています。このように、createElementNSを使うことで、複数の名前空間が混在する複雑なXML構造をPHPで正確に構築することが可能になります。