【PHP8.x】DOMEntity::appendChild()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMEntity::appendChild の動作を確認します。
7 *
8 * DOMEntity ノードは読み取り専用であり、子ノードを持つことができません。
9 * そのため、このメソッドを呼び出すと常に DOMException がスローされます。
10 * このサンプルでは、その挙動を try-catch ブロックで示します。
11 */
12function demonstrateDomEntityAppendChild(): void
13{
14    // DTD（文書型定義）でエンティティを定義したXML文字列を用意します。
15    // <!ENTITY myEntity "entity content"> の部分がエンティティの定義です。
16    $xmlString = <<<XML
17<?xml version="1.0" encoding="utf-8"?>
18<!DOCTYPE document [
19  <!ENTITY myEntity "これはエンティティのテキストです。">
20]>
21<document>
22  <p>&myEntity;</p>
23</document>
24XML;
25
26    // DOMDocumentオブジェクトを生成し、XMLを読み込みます。
27    $doc = new DOMDocument();
28    $doc->loadXML($xmlString);
29
30    // DTDからエンティティのリストを取得し、'myEntity'という名前のエンティティを取得します。
31    // $entityは DOMEntity オブジェクトです。
32    $entity = $doc->doctype->entities->getNamedItem('myEntity');
33
34    // DOMEntityが正しく取得できたか確認します。
35    if (!$entity instanceof DOMEntity) {
36        echo 'エンティティ "myEntity" が見つかりませんでした。' . PHP_EOL;
37        return;
38    }
39
40    echo "取得したエンティティ名: {$entity->nodeName}" . PHP_EOL;
41    echo "ノードタイプ: {$entity->nodeType} (DOM_ENTITY_NODE)" . PHP_EOL;
42    echo '---' . PHP_EOL;
43
44    try {
45        // 新しいテキストノードを作成します。
46        $newNode = $doc->createTextNode('このノードを追加しようとします。');
47
48        // DOMEntityに子ノードを追加しようと試みます。
49        // この操作は仕様上許可されていないため、例外が発生します。
50        echo 'DOMEntity::appendChild を呼び出します...' . PHP_EOL;
51        $entity->appendChild($newNode);
52
53        // この行は実行されません。
54        echo '子ノードの追加に成功しました。' . PHP_EOL;
55    } catch (DOMException $e) {
56        // 予期される例外を捕捉し、メッセージを表示します。
57        echo 'DOMException が発生しました！' . PHP_EOL;
58        echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
59        echo '結論: DOMEntity は読み取り専用であり、子ノードを追加できません。' . PHP_EOL;
60    }
61}
62
63// 関数を実行して動作を確認します。
64demonstrateDomEntityAppendChild();
65

このPHPサンプルコードは、DOMEntityクラスのappendChildメソッドの動作を実証するものです。appendChildメソッドは、一般的にあるノードの子として新しいノードを追加する際に使用されます。引数には追加したいDOMNodeオブジェクトを指定し、成功した場合は追加されたノードが戻り値として返されます。

しかし、DOMEntityはXMLのDTD（文書型定義）で宣言されたエンティティ（実体）を表す特殊なノードであり、その仕様上、読み取り専用となっています。これは、DOMEntityノードが子ノードを持つことができないことを意味します。

このコードでは、まずエンティティを含むXML文字列からDOMDocumentオブジェクトを生成し、対象となるDOMEntityオブジェクトを取得します。次にtry-catch構文を使い、この読み取り専用のDOMEntityオブジェクトに対してappendChildメソッドで子ノードを追加しようと試みます。この操作は仕様で許可されていないため、必ずDOMExceptionという例外が発生します。サンプルでは、この例外をcatchブロックで捕捉してエラーメッセージを表示することで、DOMEntityに子ノードは追加できないという重要な特性を明確に示しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMDocumentとappendChildを使用してXMLドキュメントを構築するサンプルです。
7 *
8 * この関数は、新しいXMLドキュメントを作成し、
9 * 親要素に子要素やテキストノードを追加する基本的な方法を示します。
10 *
11 * @return string 生成されたXML文字列
12 */
13function createXmlDocumentExample(): string
14{
15    // DOMDocumentオブジェクトのインスタンスを生成します。
16    // これはXMLドキュメント全体を表します。
17    $doc = new DOMDocument('1.0', 'UTF-8');
18
19    // 生成されるXMLを人間が読みやすいようにインデントします。
20    $doc->formatOutput = true;
21
22    // 'book'という名前のルート要素を作成します。
23    $root = $doc->createElement('book');
24    // 作成したルート要素をドキュメントの最上位に追加します。
25    // この時点でXMLは <book></book> という構造になります。
26    $doc->appendChild($root);
27
28    // 'title'という名前の子要素を作成し、テキストコンテンツを設定します。
29    $title = $doc->createElement('title', 'PHPによるXML操作入門');
30    // ルート要素<book>に、子要素<title>を追加します。
31    // これにより <book><title>...</title></book> となります。
32    $root->appendChild($title);
33
34    // 'author'という名前の別の子要素を作成します。
35    $author = $doc->createElement('author');
36    // ルート要素<book>に、子要素<author>を追加します。
37    // これにより <book>...<author></author></book> となります。
38    $root->appendChild($author);
39
40    // 'author'要素の中に入れるテキストノードを作成します。
41    $authorName = $doc->createTextNode('システム太郎');
42    // <author>要素に、テキストノードを追加します。
43    // これにより <author>システム太郎</author> となります。
44    $author->appendChild($authorName);
45
46    // 構築したDOMオブジェクトをXML文字列として出力します。
47    return $doc->saveXML();
48}
49
50// 関数を実行し、生成されたXMLを出力します。
51echo createXmlDocumentExample();
52
53?>

PHPのappendChildメソッドは、指定した親ノードの子リストの末尾に、新しい子ノードを追加するための機能です。このメソッドを使うことで、XMLやHTMLドキュメントの階層構造をプログラムで動的に構築できます。

引数には、createElementやcreateTextNodeなどで作成した、追加したいノードオブジェクトを渡します。サンプルコードでは、まずDOMDocumentオブジェクトに対してappendChildを使い、ドキュメントの最も親となるルート要素<book>を追加しています。次に、その<book>要素（$root）に対してappendChildを呼び出すことで、<title>や<author>といった子要素を挿入しています。このように、どのオブジェクトに対してメソッドを呼び出すかによって、ノードが追加される階層が決まります。さらに、<author>要素にテキスト情報を加える際も、createTextNodeで作成したテキストノードをappendChildで追加しています。

メソッドの処理が成功すると、戻り値として追加されたノードオブジェクト自身が返されます。これにより、追加したノードに対して続けて別の操作を行うことも可能です。