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

replaceWithメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月01日

基本的な使い方

replaceWithメソッドは、このメソッドが呼び出されたDom\CDATASectionノード自身を、引数で指定された新しいノードまたはノードのリストに置き換えるメソッドです。これは、DOM（Document Object Model）ツリー内で特定のCDATAセクションの内容を変更したり、その位置に別の要素やテキストコンテンツを挿入したりする際に使用します。

このメソッドは可変長引数を受け入れるため、複数のDom\Nodeオブジェクトや文字列を引数として渡すことができます。例えば、replaceWith($newNode1, $newNode2, '新しいテキスト')のように指定すると、元のDom\CDATASectionノードがあった位置に、指定された$newNode1、$newNode2、そして「新しいテキスト」を表すテキストノードが順に挿入されます。元のDom\CDATASectionノードはDOMツリーから完全に削除されます。

引数として文字列を渡した場合、その文字列は自動的にテキストノードとして扱われ、DOMツリーに挿入されます。これにより、既存のCDATAセクションを別のテキストコンテンツや、他の要素に手軽に置き換えることが可能です。この機能を利用することで、XMLやHTMLなどのドキュメント構造や内容をプログラムから動的に、かつ柔軟に操作し、更新することができます。例えば、アプリケーションのロジックに基づいてドキュメント内の特定の部分を更新する場面などで活用できます。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$cdataSection = $document->createCDATASection('既存のCDATA'); // Dom\CDATASection オブジェクトを仮定
5$replacementNode = $document->createElement('新しい要素'); // Dom\Node オブジェクトを仮定
6
7// $cdataSection を $replacementNode で置き換える
8$cdataSection->replaceWith($replacementNode);
9
10// 複数のノードや文字列で置き換えることも可能
11// $cdataSection->replaceWith($document->createTextNode('テキスト1'), 'テキスト2', $document->createElement('要素2'));
12
13?>

引数(parameters)

Dom\Node|string ...$nodes

Dom\Node|string ...$nodes: 置換する新しいノードまたは文字列のリスト。可変長引数。

戻り値(return)

void

このメソッドは値を返しません。

サンプルコード

PHP DOM CDATASectionを置換する


1<?php
2
3// CDATASection ノードを新しいノードで置き換える例
4$dom = new DOMDocument();
5$dom->loadXML('<root><![CDATA[元の内容]]></root>');
6
7$cdata = $dom->documentElement->firstChild;
8
9// 新しいテキストノードを作成
10$newText = $dom->createTextNode("置換後の内容");
11
12// CDATASection を新しいテキストノードで置き換える
13$cdata->replaceWith($newText);
14
15// 結果を表示
16echo $dom->saveXML();

PHPのDom\CDATASectionクラスのreplaceWithメソッドは、CDATASectionノードを、指定されたノード（または文字列）で置き換えるために使用します。このメソッドはPHP 8で導入されました。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、XML文字列をロードしています。そして、CDATASectionノード（<![CDATA[元の内容]]>部分）を取得しています。

次に、createTextNodeメソッドを用いて、新しいテキストノードを作成しています。このテキストノードが、元のCDATASectionノードと置き換えられることになります。

replaceWithメソッドは、引数として置き換えるノード（または文字列）を可変長引数として受け取ります。この例では、作成したテキストノードを引数として渡しています。

replaceWithメソッドを実行すると、CDATASectionノードが新しいテキストノードで置き換えられます。メソッド自体は戻り値を持ちません（void）。

最後に、saveXMLメソッドを使って、変更されたXMLドキュメントを文字列として出力しています。出力結果は、CDATASectionノードがテキストノードに置き換わったXML文字列になります。この例では、<![CDATA[元の内容]]>が置換後の内容に置き換わったXMLが出力されます。replaceWithメソッドを使用することで、DOMツリー内のノードを効率的に更新できます。

DOMCDATASection::replaceWithは、CDATAセクションを他のノードや文字列で置き換えるメソッドです。引数には、置き換えたいノード（DOMNode）または文字列を指定します。複数のノードを渡すことも可能です。

注意点として、replaceWithはPHP8から利用可能です。古いバージョンでは動作しません。また、置き換えるノードは、同じDOMDocumentに属している必要があります。異なるドキュメントのノードを渡すとエラーが発生します。

サンプルコードでは、CDATAセクションをテキストノードで置き換えています。置き換えるノードの種類（要素ノード、テキストノードなど）によって、XMLの構造が変わる点に注意してください。saveXML()で結果を確認する際は、XML宣言などが正しく出力されるか確認しましょう。