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

Copy
1<?php
2
3/**
4 * PHP DOMのappendChildメソッドの使用例。
5 * この関数は、新しいDOMドキュメントを作成し、要素を階層的に追加する方法を示します。
6 * appendChildメソッドは、指定されたノードを親ノードの子ノードリストの最後に追加します。
7 *
8 * Dom\DocumentTypeクラスは子ノードを持つことができないため、
9 * appendChildメソッドは通常Dom\ElementやDom\Documentなどのクラスで利用されます。
10 */
11function appendChildToDomElementExample(): void
12{
13    // 新しいDOMドキュメントを作成し、XML宣言とUTF-8エンコーディングを指定
14    $dom = new Dom\Document('1.0', 'UTF-8');
15    // 出力されるXMLを見やすく整形するための設定
16    $dom->formatOutput = true;
17
18    // ルート要素 'root' を作成
19    $rootElement = $dom->createElement('root');
20    // ドキュメントにルート要素を追加
21    // Dom\DocumentクラスもDom\Nodeを継承しており、appendChildを使用できます。
22    $dom->appendChild($rootElement);
23
24    // 新しい子要素 'child1' を作成
25    $childElement1 = $dom->createElement('child1');
26    // 'child1' 要素にテキストコンテンツを設定
27    $childElement1->textContent = 'Hello, PHP DOM!';
28
29    // ルート要素 'root' に 'child1' を子として追加
30    // appendChildメソッドは、追加されたノード自体を返します。
31    $appendedNode1 = $rootElement->appendChild($childElement1);
32
33    echo "--- 最初の要素追加後 ---\n";
34    echo $dom->saveXML(); // 現在のDOM構造をXML文字列として出力
35    echo "\n";
36
37    // 別の新しい子要素 'child2' を作成
38    $childElement2 = $dom->createElement('child2');
39    // 'child2' 要素に属性 'id' を設定
40    $childElement2->setAttribute('id', 'unique-item');
41
42    // 'child2' 要素の子としてテキストノードを作成し、追加
43    $textNodeForChild2 = $dom->createTextNode('This is the content for child2.');
44    $childElement2->appendChild($textNodeForChild2);
45
46    // ルート要素 'root' に 'child2' を子として追加
47    $appendedNode2 = $rootElement->appendChild($childElement2);
48
49    echo "--- 2番目の要素追加後 ---\n";
50    echo $dom->saveXML(); // 更新されたDOM構造をXML文字列として出力
51    echo "\n";
52
53    // appendChildメソッドが追加したノードを正しく返しているかを確認
54    if ($appendedNode1 === $childElement1 && $appendedNode2 === $childElement2) {
55        echo "全ての要素が正しくDOMツリーに追加されました。\n";
56    }
57}
58
59// 関数を実行して、appendChildの動作を確認します
60appendChildToDomElementExample();
61

PHPのappendChildメソッドは、DOM（Document Object Model）ツリーを構築する際に、あるノードを別のノードの子として追加するために使用されます。このメソッドは、引数として追加したいDom\Nodeオブジェクトを受け取り、親ノードの子ノードリストの最後にそのノードを追加します。処理が成功すると、引数で渡されたノードそのものが戻り値として返されます。

リファレンス情報ではDom\DocumentTypeクラスに属すると記載されていますが、Dom\DocumentTypeはドキュメント型宣言を表し、通常は子ノードを持つことがありません。そのため、このappendChildメソッドは、XMLやHTMLの要素を表すDom\Elementクラスや、ドキュメント全体を表すDom\Documentクラスなどのノード型に対して主に利用されます。

サンプルコードでは、まず新しいDOMドキュメントを作成し、Dom\Documentオブジェクトに対してルート要素を追加しています。その後、作成したルート要素（Dom\Element）に対して、さらに複数の子要素を追加していくことで、階層的なXML構造を構築しています。具体的には、createElementで新しい要素を作成し、appendChildを使って親となる要素にその子要素を追加していく流れです。これにより、プログラム的にXMLやHTMLの構造を柔軟に生成・操作することができます。

Copy
1<?php
2
3/**
4 * Dom\DocumentType::appendChild の動作を示すサンプルコードです。
5 *
6 * Dom\DocumentType ノードは、XMLやHTMLの文書型宣言を表し、子ノードを持つことを許可していません。
7 * そのため、Dom\DocumentType::appendChild メソッドを呼び出すと、
8 * 常に Dom\DOMException (コード: DOM_HIERARCHY_REQUEST_ERR) が発生します。
9 *
10 * 一般的な XML 要素に子ノードを追加するには、Dom\Element::appendChild を使用します。
11 * このサンプルでは、両方のケースを示します。
12 */
13function createXmlWithDocumentTypeAndDemonstrateAppendChild(): void
14{
15    // 1. 新しい Dom\Document インスタンスを作成
16    $dom = new Dom\Document('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力を整形して読みやすくする
18
19    // 2. Dom\DocumentType ノードを作成
20    // 例として、HTML5 の DOCTYPE を作成します。
21    // XMLの場合は、例えば $dom->createDocumentType('root', '', 'my.dtd') のように指定します。
22    $docType = $dom->createDocumentType('html', '', '');
23
24    // 3. Dom\Document に DOCTYPE ノードを追加 (これは有効な操作です)
25    $dom->appendChild($docType);
26
27    // 4. ルート要素を作成し、Dom\Document に追加
28    $rootElement = $dom->createElement('root');
29    $dom->appendChild($rootElement);
30
31    // 5. 一般的な Dom\Element に子ノードを追加する例 (Dom\Element::appendChild)
32    // これは、XML構造を構築する際の標準的な方法です。
33    $childElement = $dom->createElement('child_element', 'Hello PHP!');
34    $rootElement->appendChild($childElement); // これは正しく動作し、新しい要素が追加されます。
35
36    echo "--- 初期XML構造 ---\n";
37    echo $dom->saveXML();
38    echo "\n";
39
40    echo "--- Dom\\DocumentType::appendChild の呼び出し試行 ---\n";
41
42    // 6. Dom\DocumentType::appendChild を試行し、発生するエラーを捕捉
43    try {
44        // 例としてテキストノードを作成
45        $invalidChild = $dom->createTextNode('このテキストは追加されるべきではありません。');
46        
47        // Dom\DocumentType ノードに子ノードを追加しようとすると、
48        // Dom\DOMException (DOM_HIERARCHY_REQUEST_ERR) がスローされます。
49        echo "Dom\\DocumentType に子ノードを追加しようとしています...\n";
50        $docType->appendChild($invalidChild);
51
52        // この行は例外がスローされるため、実行されません。
53        echo "エラーが発生しませんでした (これは予期せぬ動作です)。\n";
54    } catch (Dom\DOMException $e) {
55        echo "Dom\\DOMException が捕捉されました。\n";
56        echo "エラーコード: " . $e->getCode() . " (DOM_HIERARCHY_REQUEST_ERR)\n";
57        echo "エラーメッセージ: " . $e->getMessage() . "\n";
58        echo "理由: Dom\\DocumentType ノードは子ノードを持つことができません。\n";
59    }
60
61    echo "\n--- 最終XML構造 (エラー後も既存の構造は維持されます) ---\n";
62    echo $dom->saveXML();
63}
64
65// 関数を実行
66createXmlWithDocumentTypeAndDemonstrateAppendChild();
67
68?>

PHP 8のDom\DocumentType::appendChildメソッドは、XMLやHTMLの文書型宣言を表すDom\DocumentTypeノードに対して、子ノードを追加する役割を持つものです。このメソッドはDom\Node型の引数を受け取り、追加に成功した場合はそのノードをDom\Node型として返します。しかし、Dom\DocumentTypeノードは文書構造の仕様上、子ノードを持つことを許可されていません。

そのため、このDom\DocumentType::appendChildメソッドを呼び出し、子ノードを追加しようとすると、常にDom\DOMExceptionが発生します。具体的には、階層構造の違反を示すDOM_HIERARCHY_REQUEST_ERRというエラーコードを伴う例外がスローされ、引数として渡されたノードが実際に追加されることはありません。これにより、メソッドが正常に完了し、戻り値が返されることもありません。

このサンプルコードでは、まず有効なXML文書を作成し、一般的なDom\Elementに子ノードを追加する例を示しています。その上で、Dom\DocumentTypeノードに対してappendChildを試行し、予期されるDom\DOMExceptionが捕捉される様子を実演しています。一般的なXML要素に子ノードを追加する場合は、Dom\Element::appendChildメソッドをご利用ください。