【PHP8.x】Dom\CharacterData::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要素を別のテキストノードで置き換える操作も行っています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMNode::replaceChild() メソッドの使用例を示します。
7 * このメソッドは、親ノードの子ノードリスト内で、既存の子ノードを新しい子ノードで置き換えます。
8 *
9 * @link https://www.php.net/manual/en/domnode.replacechild.php
10 */
11function demonstrateDomReplaceChild(): void
12{
13    // 1. 新しい DOM ドキュメントを作成します。
14    // このドキュメントはXML構造を表現し、要素やテキストノードなどを保持できます。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力時にHTMLを整形して読みやすくします。
17    $dom->formatOutput = true;
18
19    // 2. ドキュメントのルートとなる要素 '<container>' を作成し、ドキュメントに追加します。
20    // この '<container>' が、子ノードを持つ親ノードとなります。
21    $root = $dom->createElement('container');
22    $dom->appendChild($root);
23
24    // 3. 置き換え対象となる既存の子ノードをいくつか作成し、親ノードに追加します。
25    // ここでは、'Old Item 2' を持つ要素を置き換えるターゲットとします。
26    $oldChild1 = $dom->createElement('item', 'Old Item 1');
27    $oldChild2 = $dom->createElement('item', 'Old Item 2 (to be replaced)'); // このノードを置き換えます
28    $oldChild3 = $dom->createElement('item', 'Old Item 3');
29
30    $root->appendChild($oldChild1);
31    $root->appendChild($oldChild2);
32    $root->appendChild($oldChild3);
33
34    echo "--- 置換前 (Before replacement) ---\n";
35    // 現在のDOMツリーのHTML表現を出力します。
36    echo $dom->saveHTML();
37    echo "\n";
38
39    // 4. 新しい子ノードを作成します。このノードが既存のノードと置き換わります。
40    $newChild = $dom->createElement('item', 'New Item (replaced)');
41
42    // 5. DOMNode::replaceChild() メソッドを使用して、
43    // $root の子である $oldChild2 を $newChild で置き換えます。
44    // メソッドは、置き換えられた古い子ノード (ここでは $oldChild2) を返します。
45    try {
46        // $root (DOMElement は DOMNode を継承) は replaceChild メソッドを持ちます。
47        // 引数: ($新しい子ノード, $置き換えられる古い子ノード)
48        $replacedNode = $root->replaceChild($newChild, $oldChild2);
49
50        echo "--- 置換後 (After replacement) ---\n";
51        echo $dom->saveHTML();
52        echo "\n";
53
54        // 置き換えられたノードに関する情報も取得できます。
55        echo "置き換えられた古いノードの名前: " . $replacedNode->nodeName . "\n";
56        echo "置き換えられた古いノードの値: " . $replacedNode->nodeValue . "\n";
57    } catch (DOMException $e) {
58        // 例えば、$oldChild2 が $root の子ノードではない場合など、エラーが発生する可能性があります。
59        echo "エラーが発生しました: " . $e->getMessage() . "\n";
60    }
61}
62
63// 上記で定義した関数を実行し、DOMNode::replaceChild() の動作を確認します。
64demonstrateDomReplaceChild();

PHP 8のDOM拡張機能で提供されるDOMNode::replaceChildメソッドは、XMLやHTMLドキュメントの構造を操作し、ノードの置き換えを行うための機能です。このメソッドは、親ノードが持つ子ノードのリストの中から、指定された既存の子ノードを、用意した新しい子ノードで置き換える役割を果たします。

引数としては、親ノードに挿入する「新しい子ノード（$node）」と、親ノードの子リストから削除される「置き換えられる古い子ノード（$child）」の二つをDom\Node型で受け取ります。そして、メソッドが成功すると、置き換えられた「古い子ノード」をDom\Node型で返します。この戻り値は、もはやDOMツリーの一部ではなくなったものの、メモリ上にはまだ存在しているノードを示します。

サンプルコードでは、まずDOMDocumentを作成し、<container>というルート要素とその子要素として複数の<item>要素を構築しています。この中で「Old Item 2 (to be replaced)」を持つitem要素が、置き換えのターゲットとなります。その後、「New Item (replaced)」という新しいitem要素を作成し、親ノードである$root要素に対してreplaceChildメソッドを呼び出し、既存の古いノードを新しいノードで置き換えています。これにより、DOMツリーの内容が更新され、置換前後のHTML出力でその変化を確認できます。置換処理中に問題が発生した場合は、DOMExceptionがスローされます。