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

Copy
1<?php
2
3/**
4 * Dom\Attr::appendChild メソッドの使用例を示します。
5 *
6 * この関数は、DOMDocument を使用して HTML 要素と属性を作成し、
7 * 特定の属性ノード (Dom\Attr) にテキストノードを子として追加する方法を示します。
8 * 属性ノードは、その値としてテキストノードのみを子に持つことができます。
9 * そのため、appendChild メソッドは主に属性の値を設定する目的で使用されます。
10 */
11function demonstrateDomAttrAppendChild(): void
12{
13    // 1. 新しい DOMDocument オブジェクトを作成します。
14    // HTML5 のドキュメントとして初期化し、整形出力が有効になるように設定します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 生成されるHTMLを見やすく整形します
17
18    // 2. ルート要素 'html' を作成し、ドキュメントに追加します。
19    $htmlElement = $dom->createElement('html');
20    $dom->appendChild($htmlElement);
21
22    // 3. 'body' 要素を作成し、'html' 要素の子として追加します。
23    $bodyElement = $dom->createElement('body');
24    $htmlElement->appendChild($bodyElement);
25
26    // 4. 'div' 要素を作成し、'body' 要素の子として追加します。
27    $divElement = $dom->createElement('div', 'この要素にはカスタムデータ属性があります。');
28    $bodyElement->appendChild($divElement);
29
30    // 5. 'data-example' という名前の属性ノード (Dom\Attr) を作成します。
31    $attr = $dom->createAttribute('data-example');
32
33    // 6. 属性の値となるテキストノード (Dom\Text) を作成します。
34    $textNode = $dom->createTextNode('sample-value-123');
35
36    // 7. Dom\Attr::appendChild() メソッドを使用して、作成したテキストノードを属性の子として追加します。
37    // この操作により、属性ノードの値が設定されます。
38    // 戻り値は追加されたノード自体です。
39    $appendedNode = $attr->appendChild($textNode);
40
41    // 補足: 属性はテキストノード以外の子を持つことができません。
42    // 通常、属性の値は DOMElement::setAttribute() メソッドで文字列として直接設定する方が一般的です。
43    // 例: $divElement->setAttribute('data-example', 'sample-value-123');
44
45    echo "属性に追加されたテキストノードの値: " . $appendedNode->nodeValue . PHP_EOL;
46
47    // 8. 作成した属性ノードを 'div' 要素に追加します。
48    $divElement->setAttributeNode($attr);
49
50    // 9. 最終的に生成された HTML を出力します。
51    echo "\n--- 生成されたHTML ---\n";
52    echo $dom->saveHTML();
53}
54
55// 関数を実行して、Dom\Attr::appendChild の動作を確認します。
56demonstrateDomAttrAppendChild();

PHP 8のDom\Attr::appendChildメソッドは、DOM（Document Object Model）操作において、属性ノード（Dom\Attr）に子ノードを追加するために利用されます。このメソッドは、引数としてDom\Node $nodeを受け取り、属性に追加したいノードオブジェクトを指定します。属性ノードは、その値としてテキストノード（Dom\Text）のみを子として持つことができるという特性があり、主に属性の値をテキストノードとして設定する際に使用されます。メソッドの戻り値は、実際に追加された子ノード自身（Dom\Nodeオブジェクト）です。

提供されたサンプルコードでは、まずDOMDocumentを用いてHTML要素を構築し、次にcreateAttributeでdata-exampleという名前の属性ノードを作成しています。その後、createTextNodeで属性の値となる「sample-value-123」というテキストノードを生成し、$attr->appendChild($textNode)を呼び出すことで、このテキストノードを属性の子として追加しています。これにより、属性ノードの値がプログラム的に設定されます。最終的に、setAttributeNodeメソッドでこの属性をdiv要素に付与し、生成されたHTMLを出力して動作を確認しています。属性の値を設定する一般的な方法は要素のsetAttribute()メソッドですが、appendChildはDom\Attrオブジェクトを直接操作し、テキストノードとして値を管理する際に用いることができます。

Copy
1<?php
2
3/**
4 * Dom\Attr::appendChild メソッドの使用例。
5 *
6 * この関数は、DOMDocument を使用してXML構造を作成し、
7 * Dom\Attr::appendChild メソッドを使って属性ノードにテキストノードを追加する方法を示します。
8 * XMLの属性値は内部的にテキストノードで構成されており、このメソッドはそのテキストノードを操作する際に利用されます。
9 *
10 * @return string 生成されたXMLドキュメント
11 */
12function demonstrateDomAttrAppendChild(): string
13{
14    // 1. 新しいDOMDocumentオブジェクトを作成
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力XMLを見やすく整形するための設定
17    $dom->formatOutput = true;
18
19    // 2. ルート要素 'root' を作成し、ドキュメントに追加
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // 3. 'version' という名前の属性ノードを作成
24    // Dom\Attr::appendChild はこの属性ノードの子を追加します。
25    $attr = $dom->createAttribute('version');
26    
27    // 4. 属性に設定するテキスト内容をDom\Textノードとして作成
28    $textNodeMajor = $dom->createTextNode('1.');
29    $textNodeMinor = $dom->createTextNode('0');
30
31    // 5. Dom\Attr::appendChild メソッドを使って、作成したテキストノードを属性に追加
32    // 属性の子として最初のテキストノードを追加します。
33    $attr->appendChild($textNodeMajor);
34    
35    // 属性の子として二番目のテキストノードを追加します。
36    // これらは結合され、最終的な属性値 ('1.0') を形成します。
37    $attr->appendChild($textNodeMinor);
38
39    // 6. 作成し、テキストノードを追加した属性をルート要素に追加
40    $root->setAttributeNode($attr);
41
42    // 7. 生成されたXMLドキュメントを文字列として返却
43    return $dom->saveXML();
44}
45
46// 関数を実行し、結果（XML文字列）を出力
47echo demonstrateDomAttrAppendChild();
48

このサンプルコードは、PHPでXMLドキュメントをプログラム的に作成する際に、特に属性の値を細かく設定する方法を示しています。Dom\Attr::appendChild メソッドは、XMLの属性ノード（Dom\Attr クラスのインスタンス）に子ノードを追加するために使用されます。XMLの属性値は内部的にテキストノードで構成されており、このメソッドは、属性値を複数のテキストノードとして構築する際に役立ちます。

このメソッドの引数には、属性の子として追加したい Dom\Node オブジェクトを指定します。通常、これは Dom\Text ノード（テキスト内容）ですが、他のタイプのノードも理論的には可能です。戻り値は、追加されたその Dom\Node オブジェクト自体です。

コードでは、まず新しい DOMDocument を作成し、ルート要素を追加します。次に、createAttribute メソッドで「version」という名前の属性ノードを作成します。そして、createTextNode メソッドで「1.」と「0」の二つのテキストノードを作成し、これらを Dom\Attr::appendChild を使って「version」属性に順次追加しています。これにより、「version」属性の値は「1.0」と結合されます。最終的に、作成した属性をルート要素に設定し、生成されたXMLドキュメントを文字列として出力しています。この一連の操作により、属性値を動的に、かつ構造的に構築できることを理解できます。