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

Copy
1<?php
2
3/**
4 * DOMEntityReference::removeChild の使用例を示します。
5 *
6 * この関数は、XMLドキュメント内のエンティティ参照から子ノードを削除しようと試みます。
7 * 注意: DOMの仕様上、エンティティ参照ノードとその子孫は通常読み取り専用です。
8 * そのため、removeChild() を呼び出すと DOMException がスローされるのが一般的です。
9 * このサンプルでは、その挙動を確認するために try-catch ブロックを使用しています。
10 */
11function demonstrateDomEntityReferenceRemoveChild(): void
12{
13    // DTDでエンティティ 'example_entity' を定義したXML文字列を用意します。
14    // このエンティティは '<span>child text</span>' という内容を持ちます。
15    $xmlString = <<<XML
16    <?xml version="1.0" encoding="UTF-8"?>
17    <!DOCTYPE document [
18      <!ENTITY example_entity "<span>child text</span>">
19    ]>
20    <document>&example_entity;</document>
21    XML;
22
23    // DOMDocument オブジェクトを生成します。
24    $dom = new DOMDocument();
25
26    // substituteEntities プロパティを false に設定します。
27    // これにより、'&example_entity;' がエンティティ参照ノードとして解析されます。
28    // (true の場合、エンティティの内容に置き換えられてしまいます)
29    $dom->substituteEntities = false;
30
31    // XML文字列を読み込みます。
32    $dom->loadXML($xmlString);
33
34    // <document> 要素内の最初のノードであるエンティティ参照ノードを取得します。
35    $entityRef = $dom->getElementsByTagName('document')->item(0)->firstChild;
36
37    // 取得したノードが DOMEntityReference のインスタンスであることを確認します。
38    if ($entityRef instanceof DOMEntityReference) {
39        echo "--- 削除処理の実行前 ---" . PHP_EOL;
40        echo "エンティティ参照ノードの子ノード数: " . $entityRef->childNodes->length . PHP_EOL;
41        // saveXML() でノードの内容を出力します。
42        echo "XML抜粋: " . $dom->saveXML($entityRef) . PHP_EOL;
43        echo PHP_EOL;
44
45        // エンティティ参照が子ノードを持っているか確認します。
46        if ($entityRef->hasChildNodes()) {
47            // 削除対象の子ノード (この例では <span> ノード) を取得します。
48            $childNodeToRemove = $entityRef->firstChild;
49
50            echo "--- 削除処理の試行 ---" . PHP_EOL;
51            echo "削除対象ノード: " . $childNodeToRemove->nodeName . PHP_EOL;
52
53            try {
54                // removeChild() メソッドで子ノードを削除します。
55                $removedNode = $entityRef->removeChild($childNodeToRemove);
56                
57                // 削除に成功した場合 (通常はここまで到達しません)
58                if ($removedNode) {
59                    echo "ノード '" . $removedNode->nodeName . "' の削除に成功しました。" . PHP_EOL;
60                }
61            } catch (DOMException $e) {
62                // DOM仕様により、読み取り専用ノードの変更は許可されていないため、
63                // 通常はここで DOMException がスローされます。
64                echo "エラー: ノードの削除に失敗しました。" . PHP_EOL;
65                echo "理由: " . $e->getMessage() . PHP_EOL;
66            }
67        }
68
69        echo PHP_EOL . "--- 削除処理の実行後 ---" . PHP_EOL;
70        // 変更が加えられていないことを確認します。
71        echo "エンティティ参照ノードの子ノード数: " . $entityRef->childNodes->length . PHP_EOL;
72        $dom->formatOutput = true;
73        echo "最終的なXML:" . PHP_EOL;
74        echo $dom->saveXML();
75    }
76}
77
78// 関数を実行して結果を確認します。
79demonstrateDomEntityReferenceRemoveChild();

DOMEntityReference::removeChild()メソッドは、XMLドキュメント内のエンティティ参照ノードから、指定した子ノードを削除するための関数です。引数には、削除したい子ノードのDOMNodeオブジェクトを渡します。処理が成功した場合は削除されたノードを返しますが、失敗した場合はfalseを返します。

ただし、DOMの仕様上、エンティティ参照ノードとその内容は基本的に読み取り専用です。そのため、このメソッドで子ノードを削除しようとすると、ノードの変更が許可されていないため「DOMException」というエラーが発生するのが一般的です。

サンプルコードは、この仕様上の挙動を確認する例です。まず、&example_entity;というエンティティ参照を持つXMLを準備します。次に、そのエンティティ参照ノードの中から子ノードである<span>要素をremoveChild()で削除しようと試みます。しかし、前述の通りエンティティ参照は読み取り専用であるため、削除は実行されず、try-catch構文によってエラーが捕捉される様子を示しています。このコードは、メソッドが意図通りにエラーを引き起こすことを通して、DOMのルールを学ぶためのものです。