【PHP8.x】insertDataメソッドの使い方

insertDataメソッドは、CDATAセクションノード内のテキストデータの指定した位置に、新しい文字列を挿入する処理を実行するメソッドです。このメソッドは、XMLやHTMLドキュメントにおける<![CDATA[...]]>で囲まれた部分の文字列をプログラムで操作する際に使用されます。最初の引数であるoffsetには、文字列を挿入したい開始位置を0から始まる数値（オフセット）で指定します。例えば、文字列の先頭に挿入したい場合は0を指定します。2番目の引数dataには、実際に挿入する文字列そのものを渡します。このメソッドを呼び出すと、既存のデータは削除されず、指定したoffsetの位置に新しいdataが挿入され、以降の文字列は後ろにずれます。処理が正常に完了した場合はtrueを返します。ただし、offsetにデータの長さを超えるような無効な値を指定した場合にはDOMExceptionという例外が発生するため、適切なエラーハンドリングが必要です。このメソッドにより、既存のCDATAセクションの内容を動的に、かつ正確に変更することが可能になります。

Copy
1<?php
2
3// DOMDocumentオブジェクトを準備します
4$doc = new DOMDocument('1.0', 'UTF-8');
5$root = $doc->createElement('root');
6$doc->appendChild($root);
7
8// 元となるデータを持つCDATAセクションを作成します
9$cdata = $doc->createCDATASection("Initial data.");
10$root->appendChild($cdata);
11
12// public function DOMCdataSection::insertData(int $offset, string $data): bool
13
14// $offsetで指定した位置に、$dataで指定した文字列を挿入します。
15// 例: オフセット8の位置（"data"の前）に "new " を挿入
16$cdata->insertData(8, "new ");
17
18// 結果のXMLを出力します
19// 出力: <?xml version="1.0" encoding="UTF-8"?>
20//       <root><

int $offset, string $data

• int $offset: データを挿入する位置を指定する整数
• string $data: 挿入する文字列

bool

DOMCdataSection::insertDataメソッドは、指定されたオフセット位置に文字データを挿入し、挿入が成功した場合は true を返します。