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

Copy
1<?php
2
3/**
4 * DOMNode::removeChild を使用して、XMLドキュメントから指定した子ノードを削除するサンプル関数
5 */
6function removeXmlElement(): void
7{
8    // 操作対象となるXML文字列
9    $xmlString = <<<XML
10<?xml version="1.0" encoding="UTF-8"?>
11<bookstore>
12  <book category="cooking">
13    <title lang="en">Everyday Italian</title>
14    <author>Giada De Laurentiis</author>
15  </book>
16  <book category="children">
17    <title lang="en">Harry Potter</title>
18    <author>J. K. Rowling</author>
19  </book>
20  <book category="web" to_remove="true">
21    <title lang="en">Learning XML</title>
22    <author>Erik T. Ray</author>
23  </book>
24</bookstore>
25XML;
26
27    // DOMDocumentオブジェクトを生成
28    $dom = new DOMDocument();
29    // 空白ノードを無視して、整形して読み込む
30    $dom->preserveWhiteSpace = false;
31    $dom->loadXML($xmlString);
32
33    // XPathを使用して削除対象のノードを特定
34    $xpath = new DOMXPath($dom);
35    // 'to_remove'属性が'true'のbook要素を検索
36    $nodesToRemove = $xpath->query('//book[@to_remove="true"]');
37
38    // 削除対象のノードが存在する場合のみ処理を実行
39    if ($nodesToRemove->length > 0) {
40        // 最初のマッチしたノードを取得
41        $nodeToRemove = $nodesToRemove->item(0);
42
43        // 親ノードから指定した子ノードを削除
44        // removeChildは削除されたノードを返す
45        $removedNode = $nodeToRemove->parentNode->removeChild($nodeToRemove);
46
47        echo "--- A node has been removed. ---" . PHP_EOL;
48        echo "Removed Node Name: " . $removedNode->nodeName . PHP_EOL . PHP_EOL;
49    }
50
51    // 整形して結果のXMLを出力
52    $dom->formatOutput = true;
53    echo "--- Result XML ---" . PHP_EOL;
54    echo $dom->saveXML();
55}
56
57// サンプル関数を実行
58removeXmlElement();
59

DOMNode::removeChildは、DOMツリー構造において、ある要素（親ノード）から特定の子要素（子ノード）を削除するためのメソッドです。このメソッドは、削除したい子ノードの親ノードに対して呼び出します。

サンプルコードでは、まずXML形式の文字列をDOMDocumentオブジェクトとして読み込んでいます。次に、DOMXPathという機能を使って、削除条件に一致するノードを検索します。この例では、to_removeという属性がtrueに設定されている<book>要素を特定しています。

削除処理を実行しているのは$nodeToRemove->parentNode->removeChild($nodeToRemove)の部分です。削除対象のノード ($nodeToRemove) からparentNodeプロパティで親ノードを取得し、その親ノードのremoveChildメソッドを呼び出しています。

removeChildメソッドの引数には、削除したい子ノードのオブジェクトを渡します。処理が成功すると、戻り値として削除されたノードのオブジェクトが返されます。これにより、削除したノードの情報を後から参照できます。失敗した場合はfalseが返ります。サンプルでは、この戻り値を使って削除されたノード名を表示し、最後にノード削除後のXML全体を出力して変更を確認しています。