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

Copy
1<?php
2
3/**
4 * この関数は、DOMツリー内の既存のノードを別のノードに置き換える方法を示します。
5 * Dom\Node::replaceChild メソッドは、親ノードの既存の子ノードを新しいノードで置き換えるために使用されます。
6 * サンプルの Dom\Text ノードは Dom\CharacterData クラスを継承しています。
7 */
8function demonstrateDomNodeReplaceChild(): void
9{
10    // 1. 新しいDOMドキュメントを作成します。
11    $document = new DOM\Document('1.0', 'UTF-8');
12    $document->formatOutput = true; // 出力を整形して読みやすくします。
13
14    // 2. ルート要素を作成し、ドキュメントに追加します。
15    $rootElement = $document->createElement('root');
16    $document->appendChild($rootElement);
17
18    // 3. 親となるp要素を作成し、ルート要素に追加します。
19    $parentElement = $document->createElement('p');
20    $rootElement->appendChild($parentElement);
21
22    // 4. Dom\CharacterData の一種である Dom\Text ノードを作成し、p要素の子として追加します。
23    //    このノードが「置き換えられる古い子ノード」となります。
24    $oldTextNode = $document->createTextNode('これは置き換えられる古いテキストです。');
25    $parentElement->appendChild($oldTextNode);
26
27    echo "--- 初期状態のDOMツリー ---" . PHP_EOL;
28    echo $document->saveXML() . PHP_EOL;
29
30    // 5. 新しい要素（span）を作成します。
31    //    このノードが「置き換える新しいノード」となります。
32    $newElement = $document->createElement('span', 'これは新しいスパン要素です！');
33
34    // 6. replaceChild メソッドを使って、古いテキストノードを新しいスパン要素に置き換えます。
35    //    replaceChild は、置き換えられる子ノードの親ノード（この場合は $parentElement）に対して呼び出します。
36    //    引数: replaceChild(新しいノード, 古いノード)
37    $replacedNode = $parentElement->replaceChild($newElement, $oldTextNode);
38
39    echo "--- 置き換え後のDOMツリー ---" . PHP_EOL;
40    echo $document->saveXML() . PHP_EOL;
41
42    // replaceChild メソッドは、置き換えられた（DOMツリーから削除された）ノードを返します。
43    echo "削除されたノードの値: " . $replacedNode->nodeValue . PHP_EOL;
44
45    // 7. さらに、新しいテキストノードで置き換えることも可能です。
46    $anotherNewTextNode = $document->createTextNode('そして、これも新しいテキストに置き換えられました。');
47    $replacedSpanNode = $parentElement->replaceChild($anotherNewTextNode, $newElement);
48
49    echo "--- さらに置き換え後のDOMツリー ---" . PHP_EOL;
50    echo $document->saveXML() . PHP_EOL;
51    echo "削除されたノードの値: " . $replacedSpanNode->nodeValue . PHP_EOL;
52}
53
54// 関数を実行してデモンストレーションを開始します。
55demonstrateDomNodeReplaceChild();

このサンプルコードは、PHPのDOM拡張モジュールにおけるDom\CharacterData::replaceChildメソッドの使い方を示しています。replaceChildメソッドは、DOMツリー内の指定された子ノードを、新しいノードで置き換えるために使用します。このメソッドは、置き換える子ノードの親ノード（例えば$parentElement）に対して呼び出します。

コードではまず、DOMDocumentオブジェクトを作成し、ルート要素や子要素を追加して初期のDOMツリーを構築します。次に、createTextNodeメソッドで作成したテキストノード（Dom\CharacterDataの一種）を、createElementメソッドで作成した新しい要素（span要素）で置き換えます。

replaceChildメソッドは2つの引数を取ります。第1引数$nodeには、新しく挿入するノードを指定します。第2引数$childには、置き換えられる既存の子ノードを指定します。メソッドの戻り値は、置き換えられてDOMツリーから削除されたノード（Dom\Node）です。

サンプルコードでは、置き換え前後のDOMツリーの状態をsaveXMLメソッドで出力し、replaceChildメソッドの挙動を確認できます。また、置き換えられたノードの値をnodeValueプロパティで取得し、削除されたノードの情報も確認しています。この例ではさらに、span要素を別のテキストノードで置き換える操作も行っています。