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

Copy
1<?php
2
3/**
4 * DOMDocument を使用して、既存の要素を新しい要素で置き換えるサンプル。
5 * DOMNode::replaceChild メソッドの基本的な使い方を示します。
6 * (DOMComment は子ノードを持たないため、DOMElement を使用して一般的な置き換え操作を示します。)
7 */
8function replaceDomElementExample(): void
9{
10    // 1. DOMDocument オブジェクトを初期化
11    // XML バージョン1.0、エンコーディングUTF-8を指定
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力を整形して読みやすくする
14
15    // 2. ルート要素 '<root>' を作成し、DOMツリーの最上位に追加
16    $root = $dom->createElement('root');
17    $dom->appendChild($root);
18
19    // 3. 置き換えの対象となる既存の子要素 '<old_item>' を作成し、ルート要素に追加
20    $oldElement = $dom->createElement('old_item', 'これは置き換えられる古い要素です。');
21    $root->appendChild($oldElement);
22
23    // 4. 別の要素も追加し、DOMツリーがより複雑であることを示す
24    $anotherElement = $dom->createElement('another_item', 'これは置き換えられない別の要素です。');
25    $root->appendChild($anotherElement);
26
27    echo "--- 置き換え前後のXML構造 ---\n";
28    echo $dom->saveXML(); // 現在のDOMツリーをXML形式で出力
29    echo "\n";
30
31    // 5. 新しい子要素 '<new_item>' を作成
32    $newElement = $dom->createElement('new_item', 'これは新しく追加される要素です。');
33
34    // 6. 親ノード ($root) に対して replaceChild メソッドを呼び出し、
35    //    $oldElement を $newElement で置き換える
36    //    replaceChild は置き換えられた古いノードを返します。
37    try {
38        $replacedNode = $root->replaceChild($newElement, $oldElement);
39        echo "情報: ノード '{$replacedNode->nodeName}' (値: '{$replacedNode->nodeValue}') が正常に置き換えられました。\n";
40    } catch (DOMException $e) {
41        // エラーが発生した場合（例: oldChildがparentの子ではない場合など）
42        echo "エラー: ノードの置き換えに失敗しました - " . $e->getMessage() . "\n";
43    }
44
45    echo "\n--- 置き換え後のXML構造 ---\n";
46    echo $dom->saveXML(); // 置き換え後のDOMツリーをXML形式で出力
47}
48
49// サンプル関数を実行
50replaceDomElementExample();

このPHPサンプルコードは、DOM（Document Object Model）を使用してXMLやHTMLドキュメント内のノードを操作し、既存の要素を新しい要素で置き換える方法を示しています。特に、DOMNodeクラスが提供するreplaceChildメソッドの利用例を学ぶことができます。

replaceChildメソッドは、指定された親ノードの子ノードリスト内で、既存の子ノードを新しい子ノードに置き換える役割を持ちます。リファレンス情報ではDOMCommentに所属すると記載されていますが、コメントノードは子ノードを持たないため、実際には本サンプルコードのようにDOMElementなど、子ノードを持つDOMNodeを継承するクラスのインスタンスに対して使用されることが一般的です。

サンプルコードでは、まずDOMDocumentオブジェクトを初期化し、ルート要素と、置き換えの対象となる<old_item>という既存の要素を作成して追加します。次に、置き換えに使用する<new_item>という新しい要素を作成します。そして、親ノードであるルート要素に対してreplaceChildメソッドを呼び出し、引数に新しい要素（$newChild）と置き換えたい古い要素（$oldChild）を渡すことで、指定した古い要素が新しい要素に置き換えられます。このメソッドは、置き換えられた古いノードを戻り値として返します。これにより、置き換え前後のXML構造の変化を確認できます。エラーが発生した場合に備え、try-catchブロックで例外処理も行っています。