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

Copy
1<?php
2
3/**
4 * DOMCharacterDataを継承するDOMTextノードやDOMCommentノードを親ノードから削除するサンプル。
5 *
6 * DOMCharacterDataクラス自体は子ノードを持つことができないため、
7 * removeChildメソッドを自身に対して呼び出すことはありません。
8 * 通常は、DOMCharacterDataノードの親ノード（例: DOMElement）が、
9 * そのDOMCharacterDataノードを子ノードとして持っている場合に、
10 * 親ノードからDOMNode::removeChildメソッドを使用して削除します。
11 * この例では、DOMElementの子ノードであるDOMTextノードとDOMCommentノードを削除する手順を示します。
12 */
13function removeCharacterDataNodeExample(): void
14{
15    // 新しいDOMドキュメントを作成し、XML宣言を追加
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力を整形して読みやすくする
18
19    // ルート要素を作成し、ドキュメントに追加
20    $rootElement = $dom->createElement('document');
21    $dom->appendChild($rootElement);
22
23    // 親となる要素（DOMElement）を作成し、ルート要素に追加
24    $parentElement = $dom->createElement('article');
25    $rootElement->appendChild($parentElement);
26
27    // DOMCharacterDataを継承するDOMTextノードを作成
28    $textNode = $dom->createTextNode('これは削除されるテキストノードです。');
29
30    // DOMCharacterDataを継承するDOMCommentノードを作成
31    $commentNode = $dom->createComment('これは削除されるコメントノードです。');
32
33    // 親要素にテキストノードとコメントノードを追加
34    $parentElement->appendChild($textNode);
35    $parentElement->appendChild($commentNode);
36
37    echo "--- 初期状態のDOMツリー ---" . PHP_EOL;
38    echo $dom->saveXML() . PHP_EOL;
39
40    // parentElementから$textNodeを削除
41    // removeChildメソッドは削除されたノードを返します。
42    if ($parentElement->hasChildNodes()) {
43        echo "テキストノードを削除します..." . PHP_EOL;
44        $removedTextNode = $parentElement->removeChild($textNode);
45        echo "削除されたノードの種類: " . $removedTextNode->nodeName . PHP_EOL;
46        echo "削除されたノードの値: " . $removedTextNode->nodeValue . PHP_EOL;
47    } else {
48        echo "子ノードが存在しないため、テキストノードを削除できませんでした。" . PHP_EOL;
49    }
50
51    echo PHP_EOL . "--- テキストノード削除後のDOMツリー ---" . PHP_EOL;
52    echo $dom->saveXML() . PHP_EOL;
53
54    // parentElementから$commentNodeを削除
55    if ($parentElement->hasChildNodes()) {
56        echo "コメントノードを削除します..." . PHP_EOL;
57        $removedCommentNode = $parentElement->removeChild($commentNode);
58        echo "削除されたノードの種類: " . $removedCommentNode->nodeName . PHP_EOL;
59        echo "削除されたノードの値: " . $removedCommentNode->nodeValue . PHP_EOL;
60    } else {
61        echo "子ノードが存在しないため、コメントノードを削除できませんでした。" . PHP_EOL;
62    }
63
64    echo PHP_EOL . "--- コメントノード削除後のDOMツリー ---" . PHP_EOL;
65    echo $dom->saveXML() . PHP_EOL;
66}
67
68// サンプル関数の実行
69removeCharacterDataNodeExample();

DOMCharacterData::removeChildメソッドは、PHPのDOMDocumentオブジェクトにおいて、DOMCharacterDataノードの親ノードから子ノードを削除するために使用します。DOMCharacterData自体はテキストデータなどを保持するノードであり、子ノードを持つことはありません。そのため、通常はDOMElementなどの親ノードから、テキストノード (DOMText) やコメントノード (DOMComment) を削除する際に利用されます。

このメソッドは引数として削除したい子ノード (DOMNode $child) を受け取ります。指定された子ノードが親ノードの子である場合、削除が実行されます。メソッドの戻り値は、削除された子ノード (DOMNode) そのものです。もし指定されたノードが親ノードの子でなければ、エラーが発生します。

サンプルコードでは、DOMElementノードの子要素であるDOMTextノードとDOMCommentノードを削除する例を示しています。DOMDocumentを作成し、要素を追加後、removeChildメソッドを使ってこれらのノードを削除しています。削除前後のDOMツリーの状態を出力することで、メソッドの動作を確認できます。removeChildを使用する際には、対象のノードが親ノードの子ノードであることを事前に確認することが重要です。