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

Copy
1<?php
2
3/**
4 * 名前空間を持つXMLドキュメントを生成します。
5 *
6 * このサンプルでは、DOMDocument::createElementNS() を使用して、
7 * 名前空間URIを指定した要素を作成する方法を示します。
8 * createElement() は名前空間を扱わない要素を作成しますが、
9 * createElementNS() はXML名前空間を扱う際に不可欠です。
10 *
11 * @return void
12 */
13function createXmlElementWithNamespace(): void
14{
15    // DOMDocumentオブジェクトを新規に作成します。
16    // XMLバージョン1.0、文字コードUTF-8を指定します。
17    $dom = new DOMDocument('1.0', 'UTF-8');
18
19    // 生成されるXMLを見やすくするために、出力を整形する設定を有効にします。
20    $dom->formatOutput = true;
21
22    // 使用する名前空間のURIを定義します。
23    $namespaceURI = 'https://www.example.com/schema/book';
24
25    // ルート要素を作成します。
26    // createElementNS(名前空間URI, 'プレフィックス:要素名')
27    $rootElement = $dom->createElementNS($namespaceURI, 'b:books');
28    // ルート要素に名前空間のプレフィックスを定義します (xmlns:プレフィックス="名前空間URI")。
29    $rootElement->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:b', $namespaceURI);
30    // ドキュメントにルート要素を追加します。
31    $dom->appendChild($rootElement);
32
33    // 子要素を作成します。
34    $bookElement = $dom->createElementNS($namespaceURI, 'b:book');
35    $rootElement->appendChild($bookElement);
36
37    // 子要素に、値を持つさらに下位の要素を追加します。
38    // createElementNSの第3引数に要素の値を指定することもできます。
39    $titleElement = $dom->createElementNS($namespaceURI, 'b:title', 'PHPプロフェッショナルガイド');
40    $bookElement->appendChild($titleElement);
41
42    // 作成したXMLドキュメントを文字列として出力します。
43    echo $dom->saveXML();
44}
45
46// 関数を実行してXMLを生成・出力します。
47createXmlElementWithNamespace();
48
49?>

DOMDocument::createElement()は、XMLドキュメント内に新しい要素（HTMLでいうタグ）を作成するためのメソッドです。

第1引数 $localName には、作成したい要素の名前を文字列で指定します。例えば、'book'と指定すると<book>要素が作られます。第2引数 $value は省略可能な引数で、要素に含めるテキストを指定します。例えば、'PHPの本'と指定すると<book>PHPの本</book>のような要素が作成できます。

このメソッドを実行すると、戻り値として新しく作成された要素を表す Dom\Element オブジェクトが返ってきます。ただし、この時点ではまだ要素はドキュメントに追加されていません。返されたオブジェクトを appendChild() などのメソッドを使って、ドキュメントツリー内の適切な位置に追加する必要があります。

サンプルコードで主に使われている createElementNS() は、この createElement() の派生版で、XML名前空間を扱うために使用します。createElement() は名前空間を考慮しないシンプルな要素を作成するのに対し、createElementNS() は特定の名前空間に属する要素を作成する際に不可欠です。

Copy
1<?php
2
3// Dom\Document クラスのインスタンスを作成します。
4// XML バージョンとエンコーディングを指定します。
5$document = new Dom\Document('1.0', 'UTF-8');
6
7// 生成されるXMLを整形し、人間が読みやすくします。
8$document->formatOutput = true;
9
10// createElement メソッドを使って、ルート要素を作成します。
11// ここでは "data" という名前の要素を作成します。
12$rootElement = $document->createElement('data');
13
14// 作成したルート要素をドキュメントの最上位に追加します。
15$document->appendChild($rootElement);
16
17// 別の要素 "item" を作成します。
18$itemElement = $document->createElement('item');
19
20// 作成した "item" 要素をルート要素の子として追加します。
21$rootElement->appendChild($itemElement);
22
23// "item" 要素のテキストコンテンツとしてテキストノードを作成し追加します。
24$textNode = $document->createTextNode('これはXMLのサンプルテキストです。');
25$itemElement->appendChild($textNode);
26
27// createElement の第二引数に直接テキストコンテンツを指定して要素を作成する例。
28// "anotherItem" という要素を作成し、その内容を直接指定します。
29$anotherItemElement = $document->createElement('anotherItem', 'このテキストは要素作成時に指定されました。');
30$rootElement->appendChild($anotherItemElement);
31
32// 最終的に生成されたXMLドキュメントを文字列として出力します。
33echo $document->saveXML();
34
35?>

PHP 8のDom\Document::createElementメソッドは、XMLドキュメントをプログラムで構築する際に、新しい要素（タグ）を作成するために使用されます。このメソッドはDom\Documentクラスに属し、XMLの構造を定義する上で不可欠な機能です。

第一引数string $localNameには、作成したい要素の名前を文字列で指定します。例えば、'data'や'item'といった名前です。第二引数string $valueはオプションで、作成する要素のテキストコンテンツを直接指定できます。この引数を省略した場合、要素は空の状態で作成されます。メソッドは、作成された新しいDom\Elementオブジェクトを戻り値として返します。

サンプルコードでは、まずnew Dom\DocumentでXMLドキュメントのインスタンスを生成しています。次に$document->createElement('data')を使ってルートとなるdata要素を作成し、appendChildメソッドでドキュメントの最上位に追加しています。さらに、$document->createElement('item')でitem要素を作成し、それをdata要素の子として追加する手順を示しています。特に注目すべきは、createElementメソッドの第二引数を利用して$document->createElement('anotherItem', 'このテキスト...')のように、要素作成と同時にテキストコンテンツを割り当てられる点です。これにより、動的にXML要素とその内容を効率的に生成し、最終的にsaveXML()でXML文字列として出力しています。