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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createAttribute メソッドを使用してXML属性を作成し、要素に追加するサンプル。
5 *
6 * この関数は、Dom\XMLDocument オブジェクトを初期化し、ルート要素を作成します。
7 * その後、createAttribute メソッドを使って属性ノードを作成し、
8 * その値を設定してから要素に追加する方法を示します。
9 */
10function createXmlWithAttributeExample(): void
11{
12    // 新しい Dom\XMLDocument インスタンスを作成します。
13    // PHP 8では、新しいDOM拡張である Dom\XMLDocument クラスが利用可能です。
14    // XML宣言 (<?xml version="1.0" encoding="UTF-8"?>) を含めるように指定します。
15    $xml = new Dom\XMLDocument('1.0', 'UTF-8');
16
17    // 生成されるXML出力を見やすく整形するように設定します。
18    $xml->formatOutput = true;
19
20    // ルート要素 '<document>' を作成し、XMLドキュメントに追加します。
21    $rootElement = $xml->createElement('document');
22    $xml->appendChild($rootElement);
23
24    // Dom\XMLDocument::createAttribute() メソッドを使用して、
25    // 'version' という名前の属性ノードを作成します。
26    // このメソッドは Dom\Attr オブジェクトを返します。
27    $versionAttribute = $xml->createAttribute('version');
28
29    // 作成した属性ノードに値を設定します。
30    $versionAttribute->value = '1.0';
31
32    // 属性ノードをルート要素に追加します。
33    // これにより、<document version="1.0"> のようになります。
34    $rootElement->appendChild($versionAttribute);
35
36    // 次に、別の要素 '<item>' を作成し、ルート要素に追加します。
37    $itemElement = $xml->createElement('item');
38    $rootElement->appendChild($itemElement);
39
40    // 'id' という名前の属性ノードを作成します。
41    $idAttribute = $xml->createAttribute('id');
42    $idAttribute->value = 'item-001';
43    $itemElement->appendChild($idAttribute);
44
45    // 'status' という名前の属性ノードを作成します。
46    $statusAttribute = $xml->createAttribute('status');
47    $statusAttribute->value = 'active';
48    $itemElement->appendChild($statusAttribute);
49
50    // 子要素のテキストコンテンツを設定します。
51    $itemElement->textContent = 'これはサンプルアイテムです。';
52
53    // 最終的に生成されたXMLを出力します。
54    echo $xml->saveXML();
55}
56
57// 関数を実行してサンプルXMLを生成・表示します。
58createXmlWithAttributeExample();

PHP 8で利用可能な新しいDOM機能の一部であるDom\XMLDocumentクラスのcreateAttributeメソッドは、XMLドキュメント内に新しい属性ノードを作成するために使用されます。このメソッドは、引数として作成したい属性の名前を文字列で受け取ります。例えば、$xml->createAttribute('version')のように記述することで、「version」という名前の属性ノードを作成できます。呼び出し後には、作成された属性を表すDom\Attrオブジェクトが戻り値として返されます。

サンプルコードでは、まずDom\XMLDocumentインスタンスを生成し、XML宣言を含めて整形されたXMLが出力されるように設定します。次に、createElementメソッドで「document」というルート要素を作成し、appendChildでドキュメントに追加しています。

createAttributeメソッドを使って「version」という名前の属性ノードを作成すると、そのノードがDom\Attrオブジェクトとして返されます。このオブジェクトのvalueプロパティに「1.0」という値を代入することで属性の値を設定し、最終的に$rootElement->appendChild($versionAttribute)とすることで、作成した属性ノードをルート要素に追加しています。これにより、XML上で<document version="1.0">のように表現されます。同様に、「item」要素に対しても「id」や「status」といった複数の属性を作成し、値を設定してから要素に追加する手順が示されています。最終的に$xml->saveXML()を呼び出すことで、構築されたXMLドキュメントが文字列として出力されます。このメソッドを活用することで、プログラムからXML要素に属性を効率的に付与できます。