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

Copy
1<?php
2
3/**
4 * Dom\Document クラスを使用してXMLドキュメントを作成し、
5 * createAttribute メソッドで属性を追加するサンプルコードです。
6 *
7 * @return string 生成されたXMLドキュメントの文字列
8 */
9function createDomWithAttribute(): string
10{
11    // 新しいDOMドキュメントオブジェクトを作成します。
12    // 引数なしでHTML5ドキュメントをベースとしたドキュメントを作成できます。
13    $document = new Dom\Document();
14
15    // ルート要素（例: <div>）を作成し、ドキュメントに追加します。
16    // createElement メソッドは新しい要素ノードを返します。
17    $element = $document->createElement('div');
18    $document->appendChild($element);
19
20    // 'data-custom-id' という名前の新しい属性ノードを作成します。
21    // createAttribute は、まだどの要素にも関連付けられていない属性ノード（Dom\Attr）を返します。
22    $attribute = $document->createAttribute('data-custom-id');
23
24    // 作成した属性ノードに値を設定します。
25    $attribute->value = 'unique-value-123';
26
27    // 属性ノードを要素に追加します。
28    // setAttributeNode メソッドは、Dom\Attr ノードを特定の要素に割り当てます。
29    $element->setAttributeNode($attribute);
30
31    // さらに別の属性を直接要素に追加することもできます。（参考情報）
32    $element->setAttribute('class', 'example-class');
33
34    // ドキュメントの出力を整形するために formatOutput プロパティを true に設定します。
35    $document->formatOutput = true;
36
37    // 生成されたDOMドキュメントをXML文字列として返します。
38    return $document->saveXML();
39}
40
41// 関数を実行し、結果として生成されたXMLドキュメントを出力します。
42echo createDomWithAttribute();
43

このサンプルコードは、PHPのDom\Documentクラスを利用してXMLドキュメントを生成し、その中に属性を追加する手順を示しています。

まず、new Dom\Document()で新しいDOMドキュメントオブジェクトが作成されます。その後、createElement()メソッドで<div>要素が作成され、appendChild()によってドキュメントのルート要素として追加されます。

ここで重要な役割を果たすのがcreateAttributeメソッドです。このメソッドは、引数として指定された文字列（$localName）を属性名として受け取り、新しい属性ノード（Dom\Attrオブジェクト）を生成して返します。このDom\Attrオブジェクトは、まだどの要素にも関連付けられていない「独立した属性」です。サンプルコードでは、createAttribute('data-custom-id')により「data-custom-id」という名前の属性ノードが作成されます。

生成されたDom\Attrオブジェクトには、そのvalueプロパティを通じて属性値を設定することができます。その後、setAttributeNode()メソッドを使用することで、作成した属性ノードを特定の要素（この場合は<div>要素）に割り当て、実際に関連付けます。

最終的に、formatOutputプロパティをtrueに設定して出力が整形され、saveXML()メソッドによって完成したDOMドキュメントがXML文字列として出力されます。これにより、<div data-custom-id="unique-value-123" class="example-class"></div>のような構造を持つXMLドキュメントが生成されます。