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

Copy
1<?php
2
3/**
4 * DOMText::replaceData メソッドの使用例を示します。
5 * テキストノード内の特定の部分を、ダブルクォーテーションを含む文字列で置換します。
6 *
7 * システムエンジニアを目指す初心者向けに、DOM操作と文字列置換の基本を解説します。
8 */
9function demonstrateDomTextReplaceData(): void
10{
11    // 1. 新しい DOMDocument を作成します。
12    //    XMLバージョンとエンコーディングを指定します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力されるXMLを見やすくするために整形を有効にします。
15    $dom->formatOutput = true;
16
17    // 2. ルート要素（例えば 'document'）を作成し、DOMに追加します。
18    $rootElement = $dom->createElement('document');
19    $dom->appendChild($rootElement);
20
21    // 3. テキストコンテンツを持つ子要素（例えば 'paragraph'）を作成します。
22    $paragraphElement = $dom->createElement('paragraph');
23    // 初期テキストコンテンツを定義します。
24    $initialText = 'Original text with a placeholder for change.';
25    // テキストノードを作成し、段落要素の子として追加します。
26    $paragraphElement->appendChild($dom->createTextNode($initialText));
27    $rootElement->appendChild($paragraphElement);
28
29    echo "--- 元のXMLコンテンツ ---" . PHP_EOL;
30    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
31
32    // 4. 操作対象となる DOMText ノードを取得します。
33    //    ここでは、<paragraph>要素の最初の子ノードがテキストノードであることを期待します。
34    $textNode = $paragraphElement->firstChild;
35
36    // 取得したノードが実際に DOMText のインスタンスであることを確認します。
37    if ($textNode instanceof DOMText) {
38        $originalData = $textNode->data; // 置換前のテキストデータを取得
39
40        echo "置換前のテキストコンテンツ: " . $originalData . PHP_EOL;
41
42        // 5. DOMText::replaceData メソッドを使用して文字列の一部を置換します。
43        //    'placeholder' という文字列を 'a "special" value' に置換します。
44        $targetString = 'placeholder';
45        // 置換開始位置を検索します。strpos は文字列が見つからない場合に false を返します。
46        $offset = strpos($originalData, $targetString);
47        // 置換する文字数を決定します。
48        $count = strlen($targetString);
49        // 新しい文字列。ダブルクォーテーションをPHP文字列内で含める場合はエスケープ(\")します。
50        $newData = 'a "special" value';
51
52        // 対象文字列が見つかった場合のみ置換を実行します。
53        if ($offset !== false) {
54            // replaceData メソッドを呼び出し、指定された部分を新しいデータで置換します。
55            // PHP 8では戻り値は常に true です。
56            $success = $textNode->replaceData($offset, $count, $newData);
57
58            if ($success) {
59                echo PHP_EOL . "--- 置換後のXMLコンテンツ ---" . PHP_EOL;
60                echo $dom->saveXML() . PHP_EOL;
61                echo "置換後のテキストコンテンツ: " . $textNode->data . PHP_EOL;
62                echo "テキストノードのデータが正常に置換されました。" . PHP_EOL;
63            } else {
64                echo "テキストノードのデータ置換に失敗しました。" . PHP_EOL;
65            }
66        } else {
67            echo "'" . $targetString . "' という文字列が見つかりませんでした。置換は行われませんでした。" . PHP_EOL;
68        }
69    } else {
70        echo "エラー: 'paragraph' 要素内にテキストノードが見つかりませんでした。" . PHP_EOL;
71    }
72}
73
74// 上記の関数を実行し、DOMText::replaceData の動作を確認します。
75demonstrateDomTextReplaceData();

このサンプルコードは、PHPのDOM拡張機能にあるDOMTextクラスのreplaceDataメソッドの利用方法を解説しています。このメソッドは、XMLやHTMLなどのドキュメント構造を表現するDOMにおいて、テキストデータ（要素内の文字情報）の一部を指定した文字列で置き換える機能を提供します。

コードでは最初にDOMDocumentを作成し、document要素とその子要素であるparagraph要素を構築します。このparagraph要素には、初期のテキストコンテンツを持つDOMTextノードが追加されています。

その後、このDOMTextノードを取得し、replaceDataメソッドを呼び出してテキストの一部を置換します。メソッドの第一引数$offsetは置換を開始する文字の位置（0から始まるインデックス）を示し、第二引数$countはその位置から削除する文字数です。第三引数$dataには、削除された部分に挿入される新しい文字列を指定します。サンプルコードでは、「placeholder」という文字列を「a "special" value」という、ダブルクォーテーションを含む文字列に置き換えています。PHPの文字列内でダブルクォーテーションを文字として含める際は、バックスラッシュ（\）でエスケープしている点もポイントです。

replaceDataメソッドは、処理が成功したかどうかをbool型の戻り値で示しますが、PHP 8においては常にtrueが返されます。このメソッドにより、XMLドキュメント内のテキストデータがプログラムから動的に、かつ正確に変更される様子を理解できます。

Copy
1<?php
2
3/**
4 * HTML文字列内のDOMTextノードに含まれる全ての改行文字を置換する関数。
5 * DOMText::replaceData メソッドの具体的な使い方を、改行置換の例で示します。
6 *
7 * @param string $htmlString HTML文字列。
8 * @param string $replacement 改行文字を置換する文字列。デフォルトはスペース。
9 * @return string 置換後のHTML文字列。
10 */
11function replaceAllNewlinesInDomText(string $htmlString, string $replacement = ' '): string
12{
13    // DOMDocumentを初期化し、HTMLをロードします。
14    $dom = new DOMDocument();
15    // エラー抑制演算子 (@) は、HTMLパース時の警告を抑制します。
16    // LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD オプションは、
17    // DOMDocumentが自動的にHTML、HEAD、BODYタグを追加するのを抑制し、
18    // 元のHTMLスニペットに近い構造を保つために使用されます。
19    @$dom->loadHTML($htmlString, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
20
21    // DOMXPathオブジェクトを作成し、DOMツリー内の全てのテキストノードを効率的に取得します。
22    $xpath = new DOMXPath($dom);
23    // '//text()' は、DOMツリーのルートから全てのテキストノードを選択するXPathクエリです。
24    $textNodes = $xpath->query('//text()');
25
26    // 取得した全てのテキストノードをループ処理します。
27    foreach ($textNodes as $textNode) {
28        // テキストノードの現在の値を取得します。
29        $originalText = $textNode->nodeValue;
30
31        // 改行文字（\nまたは\r）が含まれていない場合は、このノードの処理をスキップします。
32        if (!str_contains($originalText, "\n") && !str_contains($originalText, "\r")) {
33            continue;
34        }
35
36        // 正規表現 '/\R/' を使用して、全ての改行コード（LF, CR, CRLF）の位置を検索します。
37        // PREG_OFFSET_CAPTURE フラグは、マッチした文字列とそのオフセット（開始位置）を返します。
38        preg_match_all('/\R/', $originalText, $matches, PREG_OFFSET_CAPTURE);
39
40        // 改行が見つかった場合のみ処理を実行します。
41        if (!empty($matches[0])) {
42            // DOMText::replaceData メソッドはDOMノードの値を直接変更します。
43            // 前の方の文字列を置換すると、その後の文字列のオフセット（開始位置）がずれてしまいます。
44            // この問題を避けるため、見つかった改行の位置を逆順にソートし、
45            // ドキュメントの後ろから順に置換処理を行います。
46            $matchesToProcess = array_reverse($matches[0]);
47
48            foreach ($matchesToProcess as $match) {
49                $offset = $match[1];       // 改行文字の開始オフセット
50                $count = strlen($match[0]); // 改行文字の長さ（例: '\n'は1文字、'\r\n'は2文字）
51
52                // DOMText::replaceData メソッドを使用して、テキストノードの内容を置換します。
53                // 引数:
54                //   $offset: 置換を開始するオフセット（0から始まる文字位置）。
55                //   $count: 置換する文字数。
56                //   $data: 置換後の新しい文字列。
57                $textNode->replaceData($offset, $count, $replacement);
58            }
59        }
60    }
61
62    // 更新されたDOMツリーからHTML文字列を再構築して返します。
63    // saveHTML() は完全なHTMLドキュメントを生成しますが、ロード時に指定したオプションにより、
64    // 元のHTMLスニペットに近い形で出力されます。
65    return $dom->saveHTML();
66}
67
68// --- サンプルコードの使用例 ---
69
70// 改行を含むHTMLスニペットを定義します。
71// <p>タグ内のテキストと<pre>タグ内のテキストの両方に改行を含めます。
72$originalHtml = <<<HTML
73<p>これは
74複数行の
75テキストです。</p>
76<p>別の段落の
77テキストです。</p>
78<pre>これは
79<br>preタグ内の
80テキストですが、
81DOMTextノード内の改行も置換されます。</pre>
82HTML;
83
84echo "--- 元のHTML ---\n";
85// HTML特殊文字をエスケープして、コンソールで読みやすく表示します。
86echo htmlspecialchars($originalHtml) . "\n\n";
87
88// 例1: 全ての改行をスペースに置換します。
89$modifiedHtmlSpace = replaceAllNewlinesInDomText($originalHtml, ' ');
90
91echo "--- 全ての改行をスペースに置換したHTML ---\n";
92echo htmlspecialchars($modifiedHtmlSpace) . "\n\n";
93
94// 例2: 全ての改行を削除します（空文字列に置換）。
95$modifiedHtmlNoNewline = replaceAllNewlinesInDomText($originalHtml, '');
96
97echo "--- 全ての改行を削除したHTML ---\n";
98echo htmlspecialchars($modifiedHtmlNoNewline) . "\n";

DOMText::replaceDataは、PHPのDOM（Document Object Model）拡張機能において、HTMLやXMLドキュメント内のテキストノード（DOMTextクラスのインスタンス）の文字データを部分的に置換するメソッドです。

このメソッドは、テキストノードのコンテンツを直接操作するために使用されます。引数として、$offsetには置換を開始する文字の位置を0から数えて整数で指定します。$countには$offsetで指定した位置から何文字を置換するかを整数で指定します。そして$dataには、置換後の新しい文字列を指定します。メソッドが成功した場合はtrueを、失敗した場合はfalseを返します。

サンプルコードでは、このreplaceDataメソッドの具体的な使い方として、HTML文字列内のDOMTextノードに含まれる全ての改行文字を置換する処理を示しています。DOMDocumentにHTMLをロードし、DOMXPathで全てのテキストノードを走査します。各テキストノード内で改行文字が見つかった場合、replaceDataを使って改行をスペースや空文字列などの指定された文字列に置換します。このとき、文字列の途中で置換を行うと、その後の文字のオフセットがずれてしまうため、改行の位置を逆順に処理することで、置換前のオフセット情報が常に正しく保たれるよう工夫されています。最終的に、変更されたDOMツリーから新しいHTML文字列を再構築して返します。