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

Copy
1<?php
2
3/**
4 * DOMNotation::appendChild の動作を確認する関数
5 *
6 * DOMNotation ノードは子ノードを持つことができません。
7 * そのため、このメソッドを呼び出すと常に DOMException がスローされます。
8 * このサンプルコードは、その挙動を意図的に発生させ、確認するものです。
9 */
10function demonstrateDomNotationAppendChild(): void
11{
12    // DTD (文書型定義) を含むXML文字列を準備します。
13    // ここで 'jpeg' という名前のNOTATIONを定義しています。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="utf-8" ?>
16<!DOCTYPE doc [
17  <!NOTATION jpeg PUBLIC "image/jpeg">
18]>
19<doc />
20XML;
21
22    try {
23        // DOMDocumentオブジェクトを生成します。
24        $dom = new DOMDocument();
25        // XML文字列を読み込みます。
26        $dom->loadXML($xmlString);
27
28        // DocumentTypeノード (DTDの情報を持つ) を取得します。
29        $doctype = $dom->doctype;
30
31        // notationsプロパティから 'jpeg' という名前のDOMNotationノードを取得します。
32        // @var DOMNotation|null $notation
33        $notation = $doctype?->notations?->getNamedItem('jpeg');
34
35        if ($notation) {
36            echo 'DOMNotationノード ("' . $notation->nodeName . '") を取得しました。' . PHP_EOL;
37            echo 'appendChild() を試みます...' . PHP_EOL;
38
39            // DOMNotationノードに子ノードを追加しようとします。
40            // この操作は許可されていないため、DOMExceptionがスローされます。
41            $newNode = $dom->createElement('some_child');
42            $notation->appendChild($newNode);
43        } else {
44            echo '指定されたNotationが見つかりませんでした。' . PHP_EOL;
45        }
46    } catch (DOMException $e) {
47        // 期待される例外を捕捉し、メッセージを表示します。
48        echo '---------------------------------------------------' . PHP_EOL;
49        echo '期待どおりの例外が発生しました。' . PHP_EOL;
50        echo 'エラーメッセージ: ' . $e->getMessage() . PHP_EOL;
51        echo 'これは、DOMNotationノードが子を持つことを許されていないためです。' . PHP_EOL;
52    }
53}
54
55// 関数を実行します。
56demonstrateDomNotationAppendChild();

このPHPサンプルコードは、DOMNotationクラスのappendChild()メソッドの動作を解説するものです。DOMNotationノードは、XML文書内で使用される表記法（例えば、特定の画像フォーマットなど）を表現しますが、その仕様上、子ノードを持つことはできません。

このコードでは、まず文書型定義（DTD）内でjpegという名前のNOTATIONを定義したXML文字列を用意します。次に、DOMDocumentオブジェクトでこのXMLを解析し、getNamedItem()メソッドを使ってjpegに対応するDOMNotationノードを取得します。

続いて、取得したDOMNotationノードに対してappendChild()メソッドを実行し、新しい要素ノードを子として追加しようと試みます。引数には追加したいDOMNodeを指定します。しかし、前述の通りDOMNotationノードは子を持てないため、この操作は必ず失敗し、DOMExceptionという例外がスローされます。

このサンプルはtry...catchブロックを用いて、この例外が意図通りに発生することを捕捉し、エラーメッセージを表示します。これにより、DOMNotation::appendChild()は常に例外を発生させるという仕様を実践的に確認できます。戻り値はDOMNodeと定義されていますが、例外が発生するため、実際に値が返されることはありません。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * SimpleXMLオブジェクトにDOMを介して子要素を追加します。
7 *
8 * SimpleXMLには直接appendChildメソッドがありませんが、
9 * DOM拡張機能に変換することで、appendChildメソッドを利用してノードを追加できます。
10 * この関数は、書籍リストのXMLに新しい書籍要素を追加する例です。
11 *
12 * @return void
13 */
14function demonstrateSimpleXmlAppendChild(): void
15{
16    // 操作の元となるXML文字列を定義
17    $xmlString = <<<XML
18    <?xml version="1.0" encoding="UTF-8"?>
19    <books>
20        <book isbn="978-4-10-100101-9">
21            <title>人間失格</title>
22            <author>太宰治</author>
23        </book>
24    </books>
25    XML;
26
27    // 1. XML文字列をSimpleXMLElementオブジェクトに読み込む
28    $sxe = simplexml_load_string($xmlString);
29
30    // 2. SimpleXMLElementをDOMElementに変換する
31    // これにより、DOMのメソッド（appendChildなど）が使えるようになります。
32    $domElement = dom_import_simplexml($sxe);
33
34    // 3. 新しい要素（DOMNode）を作成する
35    // 必ず元のドキュメント（ownerDocument）から要素を作成する必要があります。
36    $newBook = $domElement->ownerDocument->createElement('book');
37    $newBook->setAttribute('isbn', '978-4-00-322081-9');
38
39    $title = $domElement->ownerDocument->createElement('title', 'こころ');
40    $author = $domElement->ownerDocument->createElement('author', '夏目漱石');
41
42    // 作成した要素に、さらに子要素を追加
43    $newBook->appendChild($title);
44    $newBook->appendChild($author);
45
46    // 4. DOMElementに新しい要素を子として追加する
47    $domElement->appendChild($newBook);
48
49    // 5. 変更結果をXML文字列として出力する
50    // DOMDocumentのsaveXMLメソッドを使用します。
51    echo $domElement->ownerDocument->saveXML();
52}
53
54// 関数を実行
55demonstrateSimpleXmlAppendChild();

appendChildメソッドは、あるDOM要素（親ノード）が持つ子ノードリストの末尾に、新しいノードを追加するためのものです。引数には、追加したいDOMNodeオブジェクトを指定します。処理が成功すると、追加されたノードそのものが戻り値として返されます。

このサンプルコードは、PHPのSimpleXML拡張機能で読み込んだXMLデータに対し、DOM拡張機能を利用して新しい子要素を追加する手順を示しています。SimpleXMLには直接ノードを追加するメソッドがないため、まずdom_import_simplexml関数を使ってSimpleXMLオブジェクトをDOMオブジェクトに変換します。これにより、appendChildのような高機能なDOMメソッドが利用可能になります。

コードでは、createElementメソッドで新しい書籍情報を格納する<book>要素や、その中の<title>、<author>要素を作成します。その後、appendChildを使い、まず<book>要素に<title>と<author>を子要素として追加し、最後にルート要素である<books>に、完成した<book>要素全体を追加しています。このようにDOMの機能を経由することで、SimpleXMLで扱うデータ構造を動的に変更できます。