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

Copy
1<?php
2
3use Dom\DOMDocument;
4use Dom\DOMText; // Dom\CharacterData を継承するクラスの例
5use Dom\DOMElement;
6use Dom\DOMException;
7
8/**
9 * Dom\CharacterData::removeChild の振る舞いを示すサンプルコード。
10 *
11 * Dom\CharacterData クラス（Dom\DOMText や Dom\DOMComment など）は、
12 * Dom\Node クラスを継承しているため removeChild メソッドを持ちます。
13 * しかし、Dom\CharacterData のインスタンス自体は子ノードを持つことができません。
14 * そのため、このメソッドを Dom\CharacterData のインスタンスに対して呼び出すと、
15 * 通常は DOMException が発生します。
16 * removeChild は、Dom\DOMElement のように子ノードを持つことができる親ノードに対して
17 * 呼び出されるのが一般的です。
18 */
19function demonstrateCharacterDataRemoveChildBehavior(): void
20{
21    $dom = new DOMDocument('1.0', 'UTF-8');
22
23    // Dom\CharacterData の一種である Dom\DOMText ノードを作成します。
24    $textNode = $dom->createTextNode('これはサンプルテキストです。');
25
26    // 削除対象として使用するダミーの要素ノードを作成します。
27    // textNodeは子ノードを持てないため、このダミーノードはtextNodeの子にはなり得ません。
28    $dummyChild = $dom->createElement('dummy');
29
30    echo "Dom\\CharacterData (テキストノード) に対して removeChild メソッドを呼び出します。\n";
31    echo "テキストノードは子ノードを持てないため、DOMException が発生することが期待されます。\n";
32
33    try {
34        // removeChild を呼び出すと、指定された $dummyChild が $textNode の子ではないため、
35        // DOMException がスローされます。
36        $textNode->removeChild($dummyChild);
37        // この行は、通常は実行されません。
38        echo "予期せぬ成功: removeChild が成功しました。\n";
39    } catch (DOMException $e) {
40        // 期待される DOMException を捕捉し、その内容を表示します。
41        echo "期待されるDOMExceptionが発生しました: " . $e->getMessage() . "\n";
42        echo "理由: removeChild メソッドは、指定されたノードが呼び出し元のノードの子でない場合に\n";
43        echo "      DOMException をスローします。Dom\\CharacterData ノードは子ノードを持つことができません。\n";
44    }
45}
46
47demonstrateCharacterDataRemoveChildBehavior();

PHPのDOM拡張機能において、Dom\CharacterData::removeChildメソッドは、DOMツリーから子ノードを削除する際に利用される機能です。このメソッドは、呼び出し元の親ノードから、引数として渡されたDom\Node $childノードを削除し、削除された子ノード自体を戻り値として返します。

しかし、Dom\CharacterDataクラスはテキストノードやコメントノードといった文字データを扱うための基底クラスであり、そのインスタンス自体は子ノードを持つことができません。そのため、Dom\CharacterDataのインスタンスに対してremoveChildメソッドを呼び出すと、引数で指定されたノードが呼び出し元のノードの子ではないため、常にDOMExceptionが発生します。

サンプルコードでは、Dom\DOMText（Dom\CharacterDataを継承）のインスタンスに対してremoveChildを呼び出すことで、この挙動を示しています。期待通り、テキストノードが子ノードを持てないため、「指定されたノードがこのノードの子ではありません」という内容のDOMExceptionが捕捉され、表示されています。このメソッドは通常、Dom\DOMElementのような子ノードを持てるノードに対して使用されます。