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

Copy
1<?php
2
3/**
4 * DOMText::insertData() を使用してテキストノードに文字列を挿入するサンプル関数
5 */
6function demonstrateInsertData(): void
7{
8    // 1. DOMDocumentオブジェクトを作成し、HTML文字列を読み込みます
9    $html = '<p>Hello world!</p>';
10    $dom = new DOMDocument();
11    // HTMLフラグメントとして正しく解析するためにオプションを指定します
12    libxml_use_internal_errors(true);
13    $dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
14    libxml_clear_errors();
15
16    // 2. <p>要素内のテキストノードを取得します
17    // getElementsByTagName('p')でp要素のリストを取得し、item(0)で最初の要素を選択します。
18    // firstChildプロパティで、その要素内の最初の子ノード（この場合はテキストノード）を取得します。
19    /** @var DOMText $textNode */
20    $textNode = $dom->getElementsByTagName('p')->item(0)->firstChild;
21
22    // 変更前のテキストを表示します
23    echo 'Before: ' . $textNode->nodeValue . PHP_EOL;
24
25    // 3. insertData(オフセット, 挿入データ) を使って文字列を挿入します
26    // オフセット6は、"Hello " の直後を指します。
27    $offset = 6;
28    $data = 'beautiful ';
29    $textNode->insertData($offset, $data);
30
31    // 変更後のテキストを表示します
32    echo 'After: ' . $textNode->nodeValue . PHP_EOL;
33
34    // 4. 変更後のHTML全体を出力します
35    echo 'Result HTML: ' . $dom->saveHTML() . PHP_EOL;
36}
37
38// 関数を実行します
39demonstrateInsertData();
40
41?>

PHPのDOMText::insertData()メソッドは、既存のテキストノード内の指定した位置に、新しい文字列を挿入するために使用します。このメソッドは、テキストノードの値を直接変更するもので、戻り値はありません。

サンプルコードでは、まずDOMDocumentオブジェクトを利用して<p>Hello world!</p>というHTMLを解析し、p要素内のテキストノード「Hello world!」を取得しています。

次に、このテキストノードに対してinsertData()メソッドを呼び出します。第一引数の$offsetは、文字列を挿入する開始位置を0から始まる数値で指定するためのものです。サンプルコードの6は、6番目の文字の後、つまり「Hello 」の直後を指します。第二引数の$dataには、実際に挿入したい文字列である「beautiful 」を渡します。

このメソッドが実行されると、元のテキスト「Hello world!」の指定位置に新しい文字列が挿入され、テキストノードの内容が「Hello beautiful world!」に更新されます。最終的にsaveHTML()でHTML全体を出力すると、変更が反映された<p>Hello beautiful world!</p>が得られます。このように、insertData()はプログラムでHTMLのテキスト内容を部分的に、かつ正確に操作する際に役立ちます。