【PHP8.x】DOMDocument::createElement()メソッドの使い方

Copy
1<?php
2
3// DOMDocumentを生成
4$dom = new DOMDocument('1.0', 'UTF-8');
5
6// ルート要素を生成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 名前空間URI
11$namespaceURI = 'http://example.com/namespace';
12
13// 名前空間URIを指定して要素を生成
14$element = $dom->createElementNS($namespaceURI, 'prefix:elementName', 'elementValue');
15
16// ルート要素に要素を追加
17$root->appendChild($element);
18
19// ドキュメントを文字列として出力
20echo $dom->saveXML();
21
22?>

PHPでXMLドキュメントを操作する際、DOMDocumentクラスのcreateElementNSメソッドは、名前空間URIを指定してXML要素を生成するために使用されます。このメソッドは、DOMDocumentオブジェクトを通じて呼び出され、新しいDOMElementオブジェクトを返します。

createElementNSメソッドは、以下の引数を取ります。

1. string $namespaceURI: 生成する要素の名前空間URIを指定します。名前空間はXMLドキュメント内で要素名の衝突を避けるために用いられます。

2. string $qualifiedName: 名前空間プレフィックスと要素名をコロンで区切った文字列です。例: 'prefix:elementName'。プレフィックスは、名前空間URIに対応付けられます。

3. string $value: 要素のテキストコンテンツ（値）を指定します。省略可能です。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、ルート要素を追加しています。次に、createElementNSメソッドを使用して、http://example.com/namespaceという名前空間URIを持つ要素を生成しています。生成された要素の名前は prefix:elementName、値は elementValue です。この要素は、ルート要素の子要素として追加されます。最後に、saveXMLメソッドを使用して、XMLドキュメントを文字列として出力しています。

createElementNSメソッドを使用することで、複雑なXMLドキュメントを名前空間を考慮して正確に構築できます。特に、複数のXMLスキーマや異なるソースからのデータを統合する場合に重要となります。

Copy
1<?php
2
3/**
4 * DOMDocument::createElement メソッドの基本的な使用例を示す関数です。
5 * このメソッドは、指定された名前の新しい要素 (DOMElement) を作成します。
6 *
7 * @return void
8 */
9function createAndAppendDomElements(): void
10{
11    // DOMDocument オブジェクトを初期化します。
12    // '1.0' はXMLバージョン、'UTF-8' はエンコーディングを指定します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14
15    // 出力時にXMLを整形し、読みやすくします。
16    $dom->formatOutput = true;
17
18    // 1. ルート要素を作成し、ドキュメントに追加します。
19    // createElement メソッドは、新しいDOMElementオブジェクトを返します。
20    $rootElement = $dom->createElement('data');
21    $dom->appendChild($rootElement);
22
23    // 2. テキストノードを持つ子要素を作成し、ルート要素に追加します。
24    $itemElement1 = $dom->createElement('item');
25    // テキストノードを作成し、itemElement1 に追加します。
26    $textNode1 = $dom->createTextNode('これは最初の子要素です。');
27    $itemElement1->appendChild($textNode1);
28    $rootElement->appendChild($itemElement1);
29
30    // 3. createElement の第二引数を使用して、テキストを持つ子要素を作成します。
31    // 第二引数 ($value) を指定すると、そのテキストが要素のテキストノードとして自動的に追加されます。
32    $itemElement2 = $dom->createElement('item', 'これは createElement の第二引数でテキストを設定した子要素です。');
33    $rootElement->appendChild($itemElement2);
34
35    // 4. 属性を持つ子要素を作成し、ルート要素に追加します。
36    $attributeElement = $dom->createElement('setting');
37    // setAttribute メソッドで要素に属性を追加します。
38    $attributeElement->setAttribute('name', 'example_setting');
39    $attributeElement->setAttribute('value', 'true');
40    $rootElement->appendChild($attributeElement);
41
42    // 生成されたXMLを出力します。
43    echo "--- 生成されたXMLドキュメント ---" . PHP_EOL;
44    echo $dom->saveXML();
45    echo "-----------------------------" . PHP_EOL;
46}
47
48// 関数を実行して、サンプルコードの動作を確認します。
49createAndAppendDomElements();

PHPのDOMDocument::createElementメソッドは、XMLやHTMLドキュメント内で新しい要素（タグ）を作成するために使用されます。このメソッドはDOMDocumentクラスに属しており、指定された名前のDOMElementオブジェクトを生成し、それを戻り値として返します。

第一引数$localNameには、作成したい要素の名前（例えば、'data'や'item'といったタグ名）を文字列で指定します。この引数は必須です。第二引数$valueはオプションで、要素内に含めるテキスト内容を直接指定できます。この引数を使用すると、別途テキストノードを作成する手間を省き、要素と同時にテキストを設定することが可能です。メソッドが返すDOMElementオブジェクトは、他の要素に子として追加したり、属性を設定したりするために使用されます。

サンプルコードでは、まずDOMDocumentオブジェクトを初期化し、出力XMLを整形する設定をしています。次に、createElement('data')でルート要素を作成し、appendChildメソッドでドキュメントに追加しています。子要素の作成では、createElement('item')で要素を作成後にcreateTextNodeでテキストノードを追加する方法と、createElement('item', 'テキスト内容')のように第二引数を使って要素と同時にテキストを設定する方法の二通りを示しています。さらに、createElement('setting')で要素を作成し、setAttributeメソッドで属性を追加する方法も確認できます。これらの操作を通じて、プログラム上でXMLドキュメントの構造を柔軟に構築していく基本的な手順がわかります。

Copy
1<?php
2
3/**
4 * 新しいXMLドキュメントを作成し、DOMElement::createElement メソッドを使用して要素を追加するサンプルです。
5 *
6 * @return string 生成されたXMLドキュメントの文字列
7 */
8function createSimpleXmlDocument(): string
9{
10    // 1. 新しいDOMDocumentオブジェクトを作成
11    // '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13
14    // 2. 整形された出力にする設定（可読性を高めるため）
15    // これにより、XMLが出力時にインデントされ、読みやすくなります。
16    $dom->formatOutput = true;
17
18    // 3. ルート要素を作成し、ドキュメントに追加
19    // createElement メソッドは、指定された要素名で新しいDOMElementオブジェクトを作成します。
20    // この時点では、まだドキュメントには追加されていません。
21    $rootElement = $dom->createElement('root');
22
23    // appendChild メソッドは、指定されたノードを子ノードリストの最後に追加します。
24    // ここで初めて、'root'要素がXMLドキュメントのルートとして追加されます。
25    $dom->appendChild($rootElement);
26
27    // 4. 'item'要素を作成し、値も同時に設定してルート要素に追加
28    // createElement の第二引数に要素の値を直接指定できます。
29    $itemElementWithText = $dom->createElement('item', 'Hello PHP DOM');
30    $rootElement->appendChild($itemElementWithText);
31
32    // 5. 別の'item'要素を作成し、後から値を設定してルート要素に追加
33    $anotherItemElement = $dom->createElement('item');
34    // textContent プロパティを使って要素の値を設定することも可能です。
35    $anotherItemElement->textContent = 'Learning createElement';
36    $rootElement->appendChild($anotherItemElement);
37
38    // 6. 値を持たない'emptyItem'要素を作成し、ルート要素に追加
39    // 第二引数を省略すると、値を持たない要素が作成されます。
40    $emptyItemElement = $dom->createElement('emptyItem');
41    $rootElement->appendChild($emptyItemElement);
42
43    // 7. XMLドキュメントを文字列として取得
44    // saveXML メソッドは、DOMDocumentの内容をXML文字列として返します。
45    return $dom->saveXML();
46}
47
48// 関数を実行し、生成されたXMLドキュメントを出力します。
49// echo createSimpleXmlDocument();
50?>

PHPのDOMDocument::createElementメソッドは、XMLドキュメントに新しい要素を作成するために使用されます。このメソッドは、第一引数に作成したい要素名（$localName）を文字列で指定し、第二引数にはその要素に初期値として設定したい文字列（$value）をオプションで指定できます。第二引数を省略した場合、要素は値を持たない状態で作成されます。メソッドの戻り値は、新しく作成されたDOMElementオブジェクトです。

サンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、formatOutputプロパティをtrueに設定して出力されるXMLが読みやすいように整形しています。次に、createElementメソッドを使って「root」という名前のルート要素を作成し、appendChildメソッドでこれをドキュメントの最上位に追加します。

さらに、「item」要素を作成する際には、createElementの第二引数に「Hello PHP DOM」という文字列を渡すことで、要素の値を同時に設定できることを示しています。また、別の「item」要素では、createElementで要素を作成した後に、textContentプロパティを使って「Learning createElement」という値を設定する方法も紹介しています。値を持たない要素を作成したい場合は、第二引数を省略してcreateElementを呼び出します。最後に、saveXMLメソッドを使って、構築したXMLドキュメント全体を文字列として取得し、処理は完了です。この一連の流れにより、PHPでXML構造をプログラム的に生成する方法を学ぶことができます。