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

Copy
1<?php
2
3/**
4 * DOM要素に子要素を追加するサンプル関数
5 *
6 * この関数は、DOMDocumentを使用してXML構造を構築し、
7 * DOMElement::appendChild() メソッドを使って要素を追加する方法を示します。
8 *
9 * @return void
10 */
11function createAndShowXmlElement(): void
12{
13    // 1. DOMDocumentオブジェクトを作成します。これがXMLドキュメント全体を表現します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 出力されるXMLを人間が読みやすいように整形します。
17    $dom->formatOutput = true;
18
19    // 2. ルート要素 <book> を作成します。
20    $rootElement = $dom->createElement('book');
21
22    // 3. ルート要素をドキュメントに追加します。
23    // この時点での構造: <book/>
24    $dom->appendChild($rootElement);
25
26    // 4. 子要素 <title> を作成します。
27    $childElementTitle = $dom->createElement('title');
28
29    // 5. <title> 要素にテキストノードを追加します。
30    $titleText = $dom->createTextNode('PHPプログラミング入門');
31    $childElementTitle->appendChild($titleText);
32
33    // 6. 親要素(<book>)に子要素(<title>)をappendChildで追加します。
34    // この時点での構造: <book><title>...</title></book>
35    $rootElement->appendChild($childElementTitle);
36
37    // 7. 別の要素 <author> を作成し、同様にテキストを追加して、ルート要素に追加します。
38    $childElementAuthor = $dom->createElement('author', '山田太郎');
39    $rootElement->appendChild($childElementAuthor);
40
41    // 8. 作成されたXMLドキュメント全体を文字列として出力します。
42    echo $dom->saveXML();
43}
44
45// 関数を実行します。
46createAndShowXmlElement();
47
48?>

appendChildメソッドは、DOM（Document Object Model）ツリーにおいて、あるノードの直下に別のノードを子として追加する際に使用されます。このメソッドは親ノードとなるオブジェクトに対して呼び出され、追加したい子ノードを引数に指定することで、子ノードを親ノードの既存の子ノード群の末尾に配置します。

提供されたリファレンス情報ではDOMCharacterDataクラスに属すると記載されていますが、これはDOMCharacterDataがDOMNodeクラスを継承しており、DOMNodeに定義されているこのメソッドを利用できるためです。ただし、DOMCharacterDataはテキストデータなどを扱う特殊なノードであり、その性質上、子ノードを持つことは通常ありません。そのため、このメソッドは主にDOMDocumentやDOMElementのような、子ノードを持つことを前提としたクラスで頻繁に利用されます。

また、提供されたリファレンス情報では「引数なし」と記載されていますが、PHPのDOMNode::appendChildメソッドは実際には追加する子ノード（DOMNode型）を引数として受け取ります。そして、戻り値として追加された子ノード自体をDOMNode型で返します。

サンプルコードでは、DOMDocumentオブジェクトとDOMElementオブジェクトがappendChildメソッドをどのように使用しているかを示しています。まず、新しいXMLドキュメントを表すDOMDocumentを作成し、その中に<book>というルート要素を作成して追加します。次に、この<book>要素に対して<title>や<author>といった子要素を作成し、それぞれにテキスト内容を追加した後、appendChildを使って<book>の子として追加しています。これにより、階層的なXML構造が構築され、最終的にXML形式で出力されます。

Copy
1<?php
2
3// 新しい要素を既存の要素の子として追加する例
4$dom = new DOMDocument('1.0', 'UTF-8');
5
6// ルート要素を作成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 追加する要素を作成
11$newElement = $dom->createElement('child');
12$newElement->textContent = '追加された子要素';
13
14// ルート要素に子要素を追加
15$root->appendChild($newElement);
16
17// 結果を表示 (ブラウザで確認する場合は Content-Type を text/xml に設定してください)
18echo $dom->saveXML();
19
20?>

このサンプルコードは、PHPのDOM拡張モジュールを使用して、XMLドキュメントに新しい子要素を追加する方法を示しています。DOMDocumentクラスはXMLドキュメント全体を表し、createElementメソッドは新しい要素を作成します。appendChildメソッドは、DOMCharacterDataクラスのメソッドではなく、DOMNodeクラスのメソッドです。ここでは、DOMNodeクラスを継承したDOMElementクラスのインスタンスである $root に対して、appendChildメソッドを呼び出しています。

まず、DOMDocumentクラスのインスタンスを作成し、XMLのバージョンとエンコーディングを指定します。次に、createElementメソッドでルート要素 (root) を作成し、appendChildメソッドでドキュメントに追加します。

追加する子要素 (child) も同様にcreateElementメソッドで作成し、textContentプロパティでテキストノードを設定します。そして、appendChildメソッドを使用して、この新しい子要素をルート要素に追加します。

appendChildメソッドは、指定された要素（ここでは $newElement）を、呼び出し元のノード（ここでは $root）の最後の子ノードとして追加します。引数は不要で、追加されたノード（$newElement）自身をDOMNode型で返します。

最後に、saveXMLメソッドを使用して、XMLドキュメントを文字列として出力します。ブラウザで表示する場合は、Content-Typeヘッダーをtext/xmlに設定することで、XMLとして正しく解釈されます。この例では、XMLドキュメントの構造をプログラム的に操作し、新しい要素を既存の要素に追加する方法を理解できます。