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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMDocumentのreplaceChildメソッドを使用して、特定のノードを置き換えるサンプル関数。
7 *
8 * この例では、XML内の特定の要素の子であるCDATAセクションを、
9 * 新しく作成したテキストノードで置き換えます。
10 */
11function domReplaceChildExample(): void
12{
13    // 1. DOMDocumentオブジェクトを初期化
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 出力されるXMLを人間が読みやすいように整形する
17    $dom->formatOutput = true;
18
19    // 2. XMLの基本構造を作成
20    $rootElement = $dom->createElement('root');
21    $dom->appendChild($rootElement);
22
23    $itemElement = $dom->createElement('item');
24    $rootElement->appendChild($itemElement);
25
26    // 3. 置き換え対象となる元のCDATAセクションを作成し、item要素に追加
27    $oldCdataNode = $dom->createCDATASection('This is the original content that needs to be protected.');
28    $itemElement->appendChild($oldCdataNode);
29
30    // 変更前のXMLを出力
31    echo "--- Before replacement ---" . PHP_EOL;
32    echo $dom->saveXML();
33    echo PHP_EOL;
34
35    // 4. 置き換えるための新しいテキストノードを作成
36    $newTextNode = $dom->createTextNode('This is the new, replaced content.');
37
38    // 5. item要素を親として、古いCDATAノードを新しいテキストノードに置き換える
39    // replaceChild(新しいノード, 置き換え対象の古い子ノード)
40    $replacedNode = $itemElement->replaceChild($newTextNode, $oldCdataNode);
41
42    // 変更後のXMLを出力
43    echo "--- After replacement ---" . PHP_EOL;
44    echo $dom->saveXML();
45    echo PHP_EOL;
46
47    // 補足: replaceChildの戻り値は、取り除かれた古いノード ($oldCdataNode) です。
48    echo "--- Content of the replaced node ---" . PHP_EOL;
49    echo $replacedNode->nodeValue . PHP_EOL;
50}
51
52// サンプル関数を実行
53domReplaceChildExample();

このPHPコードは、DOMDocumentクラスのreplaceChildメソッドを使い、XML文書内の特定の子ノードを別のノードに置き換える方法を説明するものです。

まず、<root>要素とその子要素である<item>を持つ基本的なXML構造を作成します。次に、この<item>要素の子として、createCDATASectionメソッドでCDATAセクション（特殊文字をそのままテキストとして扱うためのセクション）を追加します。これが置き換え対象となる元のノードです。続いて、置き換え後となる新しいテキストノードをcreateTextNodeメソッドで作成します。

中心となるreplaceChildメソッドは、親ノード（この例では<item>要素）から呼び出します。第1引数に新しく挿入したいノードを、第2引数に置き換えたい既存の子ノードを指定します。この処理により、元のCDATAセクションが新しいテキストノードに置き換えられます。

また、replaceChildメソッドは、戻り値として置き換えられてXML構造から取り除かれた古いノードを返します。サンプルコードの最後では、この戻り値の内容を出力し、元のCDATAセクションが正しく返却されていることを確認しています。このように、replaceChildメソッドはXMLの構造を動的に更新する際に非常に便利な機能です。

Copy
1<?php
2
3/**
4 * 指定した子ノードを別のノードに置き換える方法を示します。
5 *
6 * この例では、DOMElementのreplaceChildメソッドを使用して、
7 * 子ノードであるCDATASectionを、新しく作成したTextノードに置き換えます。
8 * replaceChildは親ノードオブジェクトから呼び出します。
9 */
10function replaceChildExample(): void
11{
12    // 1. DOMDocumentオブジェクトを作成
13    $doc = new DOMDocument('1.0', 'UTF-8');
14    $doc->formatOutput = true; // 出力するXMLを整形する
15
16    // 2. XMLの基本構造を作成
17    $root = $doc->createElement('root');
18    $item = $doc->createElement('item');
19
20    // 3. 置き換え対象となるCDATAセクションノードを作成
21    $cdata = $doc->createCDATASection('This is a CDATA section.');
22    $item->appendChild($cdata);
23    $root->appendChild($item);
24    $doc->appendChild($root);
25
26    echo "--- Before replaceChild() ---\n";
27    echo $doc->saveXML();
28    echo "\n";
29
30    // 4. 新しい置き換え先のノードを作成 (この例ではElementノード)
31    $newNode = $doc->createElement('message', 'This node replaced the CDATA section.');
32
33    // 5. 親ノード($item)のreplaceChildメソッドを実行
34    // 第1引数: 新しいノード ($newNode)
35    // 第2引数: 置き換えたい古い子ノード ($cdata)
36    $item->replaceChild($newNode, $cdata);
37
38    echo "--- After replaceChild() ---\n";
39    echo $doc->saveXML();
40}
41
42// 関数を実行
43replaceChildExample();
44
45?>

このサンプルコードは、PHPのDOM拡張機能を使い、XML文書内のある子ノードを別の新しいノードに置き換えるreplaceChildメソッドの使用法を示しています。このメソッドは、親となるノードオブジェクトから呼び出して使用します。

コードでは、まずDOMDocumentオブジェクトを生成し、<root>要素の中に<item>要素を配置しています。そして、この<item>要素の子として、置き換え対象となるCDATAセクションを追加します。replaceChildメソッドを実行する前のXML構造を出力し、初期状態を確認します。

次に、置き換え後に追加したい新しいノードとして<message>要素を生成します。ここで中心となるのが、親ノードである$itemオブジェクトから呼び出すreplaceChildメソッドです。第1引数には新しく挿入したいノード ($newNode) を、第2引数には置き換えたい既存の子ノード ($cdata) を指定します。メソッドが成功すると、置き換えられて削除された古いノードが戻り値として返されます。

最終的に、メソッド実行後のXMLを出力します。実行前後の結果を比較することで、<item>要素内にあったCDATAセクションが、指定した新しい<message>要素に正しく置き換えられたことを確認できます。