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

Copy
1<?php
2
3/**
4 * PHP DOMを使用して、DOMDocument内のCDATAセクションを別のノードに置換するサンプルコード。
5 *
6 * この関数は、DOMDocumentを作成し、CDATAセクションを含む要素を追加します。
7 * その後、replaceChildメソッドを使ってCDATAセクションを別の要素に置換し、
8 * 前後のXML出力を表示して変更を確認します。
9 *
10 * @return void
11 */
12function replaceCdataSectionInDomDocument(): void
13{
14    // 1. DOMDocumentインスタンスを作成
15    // XMLバージョンとエンコーディングを指定し、出力が整形されるように設定します。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true;
18
19    // 2. ルート要素 'document' を作成し、ドキュメントに追加
20    $rootElement = $dom->createElement('document');
21    $dom->appendChild($rootElement);
22
23    // 3. 'message' 要素を作成し、ルート要素に追加
24    $messageElement = $dom->createElement('message');
25    $rootElement->appendChild($messageElement);
26
27    // 4. CDATAセクションを作成し、'message' 要素の子ノードとして追加
28    // CDATAセクションは、XMLパーサによって解析されない生データを格納するために使用されます。
29    $cdataContent = "This is some <important> data </important> that contains special characters.";
30    $cdataNode = $dom->createCDATASection($cdataContent);
31    $messageElement->appendChild($cdataNode);
32
33    echo "--- 置換前のXMLドキュメント ---\n";
34    echo $dom->saveXML();
35    echo "\n";
36
37    // 5. CDATAセクションを置換するための新しいノードを作成
38    // ここでは、新しいテキストノードを持つ 'replacement' 要素を作成します。
39    $replacementElement = $dom->createElement('replacement', 'The original CDATA section was replaced.');
40
41    // 6. replaceChildメソッドを使用してノードを置換
42    // 親ノード ($messageElement) の子ノードリスト内で、$cdataNode を $replacementElement に置換します。
43    // replaceChildは、置換された古いノード（$cdataNode）を返すか、失敗した場合はfalseを返します。
44    $oldNode = $messageElement->replaceChild($replacementElement, $cdataNode);
45
46    // 7. 置換の成功をチェックし、結果を表示
47    if ($oldNode !== false) {
48        echo "--- 置換後のXMLドキュメント ---\n";
49        echo $dom->saveXML();
50        echo "\n";
51        echo "成功: CDATAセクションが新しい要素に置換されました。\n";
52    } else {
53        echo "エラー: ノードの置換に失敗しました。\n";
54    }
55}
56
57// 関数を実行して、サンプルコードの動作を確認
58replaceCdataSectionInDomDocument();
59
60?>

このサンプルコードは、PHPのDOM拡張機能を利用してXMLドキュメント内のノードを操作する方法を示しています。具体的には、既存のCDATAセクションを別の要素に置き換えるreplaceChildメソッドの使い方を解説しています。

まず、DOMDocumentインスタンスを生成し、XMLバージョンとエンコーディングを設定しています。次に、ルート要素やmessage要素を追加し、その子ノードとしてCDATAセクションを作成・追加して初期のXML構造を構築します。CDATAセクションは、特殊文字を含む生データをXMLパーサに解析させずに格納したい場合に使用されます。

コードは、この初期状態のXMLドキュメントを表示した後、新しく置き換え用の要素（replacement要素）を作成します。そして、親ノードである$messageElementのreplaceChildメソッドを呼び出します。このメソッドは、第一引数$newnodeに新しいノード（ここでは$replacementElement）を、第二引数$oldnodeに置き換えたい既存のノード（ここでは$cdataNode）を指定することで、$oldnodeを$newnodeで置き換えます。メソッドの戻り値は、置き換えられた古いノード自身、または操作が失敗した場合はfalseとなります。コードではこの戻り値を使って置換の成功・失敗を判定しています。

最終的に、CDATAセクションが新しい要素に置き換わった後のXMLドキュメントが表示され、DOMツリーが正常に変更されたことを確認できます。この機能は、XMLドキュメントの内容を動的に更新する際に非常に役立ちます。