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

Copy
1<?php
2
3/**
4 * Dom\CharacterData::appendChild の動作例を示します。
5 *
6 * このメソッドは、テキストノードやコメントノードのような CharacterData ノードに
7 * 子ノードを追加しようと試みますが、仕様上それは許可されていません。
8 * そのため、このメソッドを呼び出すと必ず DOMException がスローされます。
9 * このサンプルコードは、その挙動を確認するものです。
10 */
11function demonstrateCharacterDataAppendChild(): void
12{
13    // DOMDocumentオブジェクトを作成
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // ルート要素を作成
17    $root = $dom->createElement('root');
18    $dom->appendChild($root);
19
20    // テキストノードを作成 (Dom\CharacterData の一種)
21    $textNode = $dom->createTextNode('some text');
22    $root->appendChild($textNode);
23
24    // テキストノードに追加しようとする新しい要素を作成
25    $newElement = $dom->createElement('child');
26
27    try {
28        // Dom\CharacterData (この場合はDOMText) に子ノードを追加しようと試みる
29        // これは常に DOMException (HierarchyRequestError) をスローする
30        $textNode->appendChild($newElement);
31    } catch (DOMException $e) {
32        // 期待される例外を捕捉し、メッセージを出力
33        echo "例外がキャッチされました: " . $e->getMessage() . PHP_EOL;
34        echo "Dom\\CharacterData ノードに子を追加することはできません。" . PHP_EOL;
35    }
36
37    // 最終的なXMLを出力（$newElementは追加されていないことを確認）
38    echo "--- 生成されたXML ---" . PHP_EOL;
39    echo $dom->saveXML();
40}
41
42demonstrateCharacterDataAppendChild();

PHPのDom\CharacterData::appendChildメソッドは、XMLやHTMLのDOMツリーにおいて、テキストノードやコメントノードのような文字データを扱うノードに、他の子ノードを追加しようとする際に用います。このメソッドには引数がなく、通常は追加された子ノードを表すDom\Nodeオブジェクトを返します。

しかし、Dom\CharacterData型のノードは、その設計上、文字データのみを保持し、自身の中にさらに子ノードを持つことはできません。このため、Dom\CharacterData::appendChildを呼び出すと、必ずDOMExceptionがスローされます。

サンプルコードでは、まずDOMDocumentを作成し、ルート要素とその子としてテキストノードを追加しています。その後、新しい要素ノードを作成し、このテキストノードの子として追加を試みています。この操作は期待通りDOMExceptionを発生させ、例外処理ブロックでそのメッセージが出力されます。これは、Dom\CharacterDataノードへ子ノードを追加しようとするとエラーとなることを示すものです。

Copy
1<?php
2
3/**
4 * Dom\Document と Dom\Element の appendChild メソッドを使用して、
5 * XML ドキュメントを構築するサンプルコード。
6 *
7 * この関数は、新しいXMLドキュメントを作成し、ルート要素とその子要素、
8 * およびテキストノードを階層的に追加する方法を示します。
9 * Dom\Text は Dom\CharacterData のサブクラスであり、
10 * Dom\Element や Dom\Document に appendChild を使用して追加されます。
11 *
12 * @return string 生成されたXMLを文字列で返します。
13 */
14function createXmlDocumentWithAppendedNodes(): string
15{
16    // 1. 新しい Dom\Document オブジェクトを作成します。
17    //    XMLのバージョンとエンコーディングを指定します。
18    $document = new Dom\Document('1.0', 'UTF-8');
19    // 出力XMLを見やすく整形するための設定。
20    $document->formatOutput = true;
21
22    // 2. XMLのルート要素（例: <root>）を作成します。
23    $rootElement = $document->createElement('root');
24
25    // 3. ルート要素をドキュメントに追加します。
26    //    Dom\Document の appendChild メソッドは、ドキュメントに最上位の要素を追加します。
27    $document->appendChild($rootElement);
28
29    // 4. ルート要素の子要素（例: <item>）を作成します。
30    $itemElement = $document->createElement('item');
31
32    // 5. テキストノード（例: "Hello World!"）を作成します。
33    //    Dom\Text クラスは Dom\CharacterData のサブクラスです。
34    $textNode = $document->createTextNode('Hello World!');
35
36    // 6. テキストノードを 'item' 要素に追加します。
37    //    Dom\Element の appendChild メソッドは、指定されたノードを子として追加します。
38    $itemElement->appendChild($textNode);
39
40    // 7. 'item' 要素を 'root' 要素に追加します。
41    //    ここでも Dom\Element の appendChild メソッドを使用します。
42    $rootElement->appendChild($itemElement);
43
44    // 8. 構築されたXMLドキュメントを文字列として返します。
45    return $document->saveXML();
46}
47
48// 関数を実行し、生成されたXMLを表示します。
49echo createXmlDocumentWithAppendedNodes();

PHPのDOM拡張機能におけるappendChildメソッドは、XMLやHTMLドキュメントをプログラムで構築する際に非常に重要な役割を果たすメソッドです。このメソッドは主にDom\DocumentやDom\Elementといった、ノードの階層構造を管理するクラスで使用され、既存のノードに新しい子ノードを追加する目的で利用されます。

具体的には、Dom\DocumentクラスのappendChildメソッドを使用すると、XMLドキュメントの最上位要素、つまりルート要素をドキュメントに追加できます。一方、Dom\ElementクラスのappendChildメソッドは、特定の要素内部に、さらに子要素やテキストノードなどを追加するために使われます。サンプルコードでは、まずDom\Documentに<root>要素を追加し、次にその<root>要素に<item>要素を追加しています。さらに、<item>要素には、テキスト内容を表すDom\Textノードを追加しており、このDom\TextクラスはDom\CharacterDataのサブクラスにあたります。

このメソッドは引数として、追加したいDom\Nodeオブジェクトを一つ受け取ります。例えば、上記のように作成したDom\ElementやDom\Textのインスタンスを渡します。そして、正常に子ノードが追加された場合、戻り値として追加されたDom\Nodeオブジェクト自身が返されます。このようにして、appendChildメソッドを繰り返し使用することで、複雑なXMLドキュメントの構造を段階的に構築していくことが可能です。