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

Copy
1<?php
2
3/**
4 * DOMNotation::insertBefore の動作を説明する関数
5 *
6 * DOMNotation は、仕様上、子ノードを持つことが許可されていません。
7 * そのため、insertBefore メソッドを呼び出すと、
8 * 常に DOMException がスローされます。
9 * このサンプルコードは、その挙動を実証します。
10 */
11function demonstrateDomNotationInsertBefore(): void
12{
13    // DTD (文書型定義) に NOTATION を含む XML 文字列を用意します
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="utf-8"?>
16<!DOCTYPE root [
17    <!NOTATION my_notation SYSTEM "http://example.com/my_notation_system_id">
18]>
19<root></root>
20XML;
21
22    // DOMDocument オブジェクトをインスタンス化します
23    $dom = new DOMDocument();
24
25    // DTD を読み込むオプションを付けて XML をロードします
26    // 外部DTDが見つからない等の警告を抑制するために @ を使用しています
27    @$dom->loadXML($xmlString);
28
29    // doctype が存在し、notations が取得できることを確認します
30    if (!isset($dom->doctype->notations)) {
31        echo "DOCTYPE または Notations が XML に見つかりませんでした。\n";
32        return;
33    }
34
35    // 'my_notation' という名前の DOMNotation オブジェクトを取得します
36    $notation = $dom->doctype->notations->getNamedItem('my_notation');
37
38    if (!$notation instanceof DOMNotation) {
39        echo "指定された Notation が見つかりませんでした。\n";
40        return;
41    }
42
43    // 挿入を試みる新しい DOMElement を作成します
44    $newChild = $dom->createElement('newNode');
45
46    try {
47        // DOMNotation オブジェクトに対して insertBefore を試みます。
48        // 第2引数 $refChild が null または省略された場合、末尾に追加する動作になりますが、
49        // DOMNotation は子ノードを持てないため、いずれにせよ操作は失敗します。
50        $notation->insertBefore($newChild);
51    } catch (DOMException $e) {
52        // 意図した通り例外がスローされたことを出力します
53        echo "DOMNotation::insertBefore は期待通り DOMException をスローしました。\n\n";
54        echo "エラーコード: " . $e->code . " (HIERARCHY_REQUEST_ERR)\n";
55        echo "エラーメッセージ: " . $e->getMessage() . "\n\n";
56        echo "解説: DOMNotation 型のノードは、子ノードを持つことができないため、\n";
57        echo "子ノードを追加しようとする操作は常に失敗します。\n";
58    }
59}
60
61// 関数を実行して結果を確認します
62demonstrateDomNotationInsertBefore();

DOMNotation::insertBeforeは、既存の子ノードの前に新しい子ノードを挿入するためのメソッドです。第一引数$newChildに挿入したいノードを、第二引数$refChildに挿入位置の基準となる既存の子ノードを指定します。第二引数を省略した場合は、子ノードの末尾に追加しようとします。成功時には挿入されたDOMNodeを返しますが、DOMNotationオブジェクトに対しては常に失敗します。

DOMNotationは、XMLのDTD（文書型定義）で定義される記法宣言を表す特殊なノードです。DOMの仕様上、このDOMNotation型のノードは子ノードを持つことが許可されていません。

サンプルコードは、この仕様を実際に確認するものです。まず、DTD内に記法を含むXML文書を読み込み、DOMNotationオブジェクトを取得します。次に、このオブジェクトに対してinsertBeforeメソッドを使い、新しい要素の挿入を試みます。DOMNotationは子ノードを持てないというルールがあるため、この操作は必ず失敗し、「階層構造の要求エラー」を示すDOMExceptionという例外が発生します。このように、DOMNotation::insertBeforeは、その仕様上、子ノードを追加する目的では実質的に使用できないことを示しています。