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

Copy
1<?php
2
3// DOMDocumentを生成
4$dom = new DOMDocument();
5
6// ルート要素を生成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 子要素を生成
11$child1 = $dom->createElement('child1');
12$child2 = $dom->createElement('child2');
13
14// ルート要素に子要素を追加
15$root->appendChild($child1);
16$root->appendChild($child2);
17
18// DocumentTypeを作成
19$doctype = $dom->implementation->createDocumentType('html', '-//W3C//DTD HTML 4.01 Transitional//EN', 'http://www.w3.org/TR/html4/loose.dtd');
20$dom->insertBefore($doctype, $dom->documentElement);
21
22// DOMDocumentTypeオブジェクトを取得
23$docTypeNode = $dom->doctype;
24
25// 削除する子要素を指定
26$childToRemove = $child1;
27
28// 削除を実行。DocumentTypeではremoveChildは利用できないため、代わりにremoveChildをDocumentElementに対して実行
29if ($childToRemove->parentNode === $root) {
30    $removedChild = $root->removeChild($childToRemove);
31
32    if ($removedChild) {
33        echo "要素が削除されました。\n";
34    } else {
35        echo "要素の削除に失敗しました。\n";
36    }
37} else {
38    echo "指定された要素はルート要素の子ではありません。\n";
39}
40
41// 結果を出力
42echo $dom->saveXML();
43
44?>

このサンプルコードは、PHPのDOM拡張を用いて、XMLドキュメントから要素を削除する方法を示しています。DOMDocumentType クラスの removeChild メソッドは、本来 DOMDocumentType ノードの子ノードを削除するために使用するものですが、サンプルコードではDOMDocumentTypeに対して直接removeChildを使用せず、DOMDocumentのdocumentElement（ルート要素）の子要素を削除しています。

まず、DOMDocumentオブジェクトを生成し、ルート要素 (root) とその子要素 (child1, child2) を作成して、それらをドキュメントに追加しています。次に、createDocumentType メソッドを使って DocumentType ノードを作成し、ドキュメントの先頭に挿入しています。

ここで重要なのは、removeChild メソッドを使って要素を削除する部分です。削除対象の要素 (childToRemove) がルート要素の子であるかを確認し、もしそうであれば、ルート要素の removeChild メソッドを呼び出して要素を削除します。

removeChild メソッドは、引数に削除する DOMNode オブジェクトを受け取ります。削除が成功すると、削除された DOMNode オブジェクトが返されます。削除に失敗した場合は null が返されます。サンプルコードでは、返り値を $removedChild 変数に格納し、その値に応じてメッセージを表示しています。

最後に、変更されたXMLドキュメントを saveXML メソッドを使って文字列として出力します。このコードを実行すると、child1 要素が削除されたXMLドキュメントが出力されます。この例から、removeChildメソッドは、DOMツリーから特定のノードを削除するために使用できることが理解できます。