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

Copy
1<?php
2
3// 1. DOMDocumentオブジェクトをインスタンス化します。
4// これがXMLドキュメント全体を操作するための基本となります。
5$dom = new DOMDocument('1.0', 'UTF-8');
6
7// 出力されるXMLを読みやすくするために整形する設定を有効にします。
8$dom->formatOutput = true;
9
10// 2. 操作の元となるXML文字列を定義します。
11$xmlString = <<<XML
12<users>
13  <user id="1">Alice</user>
14  <user id="2">Bob</user>
15  <user id="3">Charlie</user>
16</users>
17XML;
18
19// XML文字列をDOMDocumentに読み込み、解析させます。
20$dom->loadXML($xmlString);
21
22// 3. 削除したいノードを特定します。
23// ここではid属性が"2"の<user>要素を探します。
24$userToRemove = null;
25// getElementsByTagNameは指定したタグ名の要素をすべて取得します。
26$userList = $dom->getElementsByTagName('user');
27foreach ($userList as $user) {
28    if ($user->getAttribute('id') === '2') {
29        $userToRemove = $user;
30        break; // 対象が見つかったのでループを終了します。
31    }
32}
33
34// 4. 削除対象のノードが見つかった場合に、削除処理を実行します。
35if ($userToRemove) {
36    // 削除対象ノードの親ノードを取得します (この場合は<users>要素)。
37    $parentNode = $userToRemove->parentNode;
38
39    // 親ノードの removeChild() メソッドを呼び出して、子ノードを削除します。
40    // このメソッドは、削除されたノードオブジェクトを返します。
41    $removedNode = $parentNode->removeChild($userToRemove);
42
43    echo "--- 削除されたノード ---" . PHP_EOL;
44    // saveXMLにノードを渡すと、そのノード部分のXML文字列が取得できます。
45    echo $dom->saveXML($removedNode);
46    echo PHP_EOL;
47
48    echo "--- 削除後のXML ---" . PHP_EOL;
49    // 変更が反映されたドキュメント全体のXMLを出力します。
50    echo $dom->saveXML();
51}
52
53?>

このPHPサンプルコードは、DOM（Document Object Model）を操作してXMLデータから特定の子ノードを削除するremoveChild()メソッドの使用例です。このメソッドは、指定した親ノードから直接の子ノードを取り除く機能を提供します。

コードでは、まずDOMDocumentオブジェクトにXML文字列を読み込ませます。次に、getElementsByTagName()とgetAttribute()を使って、削除対象であるid="2"を持つ<user>要素を特定します。

removeChild()メソッドを使用する際の重要なポイントは、削除したいノードの親ノードから呼び出す必要があるという点です。そのため、サンプルでは$userToRemove->parentNodeによって親である<users>要素を取得しています。そして、この親ノードのremoveChild()メソッドを実行します。

引数には、削除したい子ノードのオブジェクト（サンプルでは$userToRemove）を渡します。メソッドが正常に実行されると、その戻り値として、ドキュメントツリーから削除されたノードオブジェクト自体が返されます。サンプルでは、この返されたノードをsaveXML()で表示することで、何が削除されたかを明確に示しています。最後に、ドキュメント全体を改めて出力し、ノードが削除された後の最終的なXML構造を確認できます。