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

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

作成日: 2025年09月11日更新日: 2025年11月25日

基本的な使い方

deleteDataメソッドは、Dom\Textオブジェクトが保持するテキストデータの一部を削除するメソッドです。このメソッドは、XMLやHTMLドキュメント内でテキストノードの内容をプログラム的に修正したい場合に利用されます。

具体的には、Dom\Textオブジェクトが持つテキストコンテンツから、指定された開始位置（オフセット）から指定された文字数だけデータを削除します。第一引数であるoffsetは、削除を開始するテキストデータの位置を0から始まるインデックスで指定します。第二引数であるcountは、offsetで指定された位置から削除する文字数を指定します。

例えば、「こんにちは世界」というテキストを持つDom\Textオブジェクトに対して、offsetに3（「に」の次、「ち」の場所）、countに3（「ち」「は」「世」）を指定すると、テキストは「こんにちは界」となります。

指定されたoffsetがテキストデータの全長を超えていたり、offsetとcountの合計がテキストデータの全長を超えたりするなど、無効な範囲を指定した場合には、Dom\Exceptionが発生する可能性があります。このメソッドは、テキストデータの削除が成功した場合、特に値を返しません。Dom\TextクラスはDOMツリーにおける純粋なテキストコンテンツを表すため、このdeleteDataメソッドは、そのテキストコンテンツを正確に管理・修正する際に重要な役割を果たします。

構文(syntax)


1<?php
2$domTextInstance->deleteData($offset, $count);
3?>

引数(parameters)

int $offset, int $count

int $offset: 削除を開始する文字位置を指定する整数
int $count: 削除する文字数を指定する整数

戻り値(return)

void

このメソッドは、Dom\Textノードに関連付けられたデータを削除しますが、何も返しません。

サンプルコード

PHP DOMText deleteDataで全データ削除


1<?php
2
3/**
4 * DOMDocument 内のテキストノードから全てのデータを削除するサンプルコード。
5 *
6 * Dom\Text::deleteData メソッドは、指定されたテキストノードの一部または全てのデータを削除します。
7 * このサンプルでは、「php deleteall」というキーワードに合わせて、テキストノードのデータを全て削除する方法を示します。
8 * PHP 8.0 以降では、Dom\Text クラスは DOMText のエイリアス元のクラス名として機能します。
9 *
10 * @param string $initialText 削除する初期テキスト
11 * @return void
12 */
13function deleteAllTextFromDomNode(string $initialText): void
14{
15    // 1. 新しいDOMDocumentオブジェクトを作成
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力XMLを見やすく整形
18
19    // 2. ルート要素を作成し、DOMに追加
20    $rootElement = $dom->createElement('document');
21    $dom->appendChild($rootElement);
22
23    // 3. テキストを保持する要素を作成
24    $paragraphElement = $dom->createElement('paragraph');
25    $rootElement->appendChild($paragraphElement);
26
27    // 4. 削除対象となるテキストノードを作成し、要素に追加
28    $textNode = $dom->createTextNode($initialText);
29    $paragraphElement->appendChild($textNode);
30
31    echo "--- 削除前のDOMツリーの状態 ---\n";
32    echo $dom->saveXML();
33    echo "\n";
34
35    // 5. Dom\Text::deleteData メソッドを使用して、テキストノードのデータを全て削除
36    // Dom\Text は DOMText クラスのインスタンスとして利用できます。
37    if ($textNode instanceof DOMText) {
38        // deleteData(int $offset, int $count)
39        // $offset: 削除を開始する文字位置 (0は先頭)。全て削除するため0を指定。
40        // $count: 削除する文字数。全て削除するためテキストノードの全長 ($textNode->length) を指定。
41        $textNode->deleteData(0, $textNode->length);
42        echo "テキストノードのデータが全て削除されました。\n";
43    } else {
44        echo "エラー: テキストノードが見つからないか、DOMTextのインスタンスではありません。\n";
45    }
46
47    echo "\n--- 削除後のDOMツリーの状態 ---\n";
48    echo $dom->saveXML();
49    echo "\n";
50}
51
52// サンプルコードの実行
53deleteAllTextFromDomNode('このテキストは完全に削除されます。');
54
55?>

このサンプルコードは、PHPでDOM（Document Object Model）ツリー内のテキストノードから文字データを削除する方法を具体的に示しています。特に「php deleteall」というキーワードに対応し、ノードに格納されているテキストコンテンツを完全に消去する手順を解説しています。

使用されているDom\Text::deleteDataメソッドは、XMLやHTMLのDOMツリー内でテキストデータを扱うためのDom\Textクラスに属しています。PHP 8からは、このDom\Textは既存のDOMTextクラスのエイリアスとして機能します。このメソッドは、テキストノードの内容の一部または全てを指定して削除する役割を持ちます。

deleteDataメソッドは二つの整数型引数を取ります。一つ目の$offsetは、削除を開始する文字位置を指定し、テキストの先頭は0番目から数えます。二つ目の$countは、$offsetで指定された位置から何文字削除するかを指定します。このサンプルコードでは、テキストノードのデータを全て削除するため、$offsetには0を、$countにはテキストノードの全長を示す$textNode->lengthを指定しています。

このメソッドの戻り値はvoidであり、操作が完了しても特に値は返されません。

コードの実行では、まず新しいDOMDocumentオブジェクトを作成し、その中にルート要素や段落要素、そして削除対象となるテキストノードを構築します。その後、Dom\Text::deleteDataメソッドを呼び出し、引数に0とテキストノードの全長を指定することで、ノード内のテキストが全て削除されます。コードの実行前後でDOMツリーのXML表現が表示され、テキストが確実に削除されたことを視覚的に確認することができます。これにより、DOMツリー内の特定のテキストコンテンツを効率的に削除する手法を学ぶことができます。

Dom\Text::deleteDataメソッドは、テキストノードが保持する「文字データ」のみを削除し、ノード自体はDOMツリーに残る点に注意が必要です。ノードそのものを削除する場合は、親ノードのremoveChildメソッドなどを使用してください。

引数の$offsetは削除開始位置（0が先頭）、$countは削除する文字数を指定します。全て削除する際は$offsetに0を、$countにはテキストノードの全長である$textNode->lengthを指定します。これらの数値が誤っていると、期待しないデータが削除される可能性があります。

PHP 8.0以降ではDom\TextはDOMTextのエイリアスです。サンプルコードのようにinstanceof DOMTextで型をチェックし、対象が確実にテキストノードであることを確認してから操作することは、予期せぬエラーを防ぐ上で非常に重要です。このメソッドの戻り値はvoidですので、削除成功の確認は削除前後のDOM状態を比較して行いましょう。

PHP DOMテキストノードの一部を削除する


1<?php
2
3// このサンプルコードは、DOM（Document Object Model）ツリー内のテキストノードの一部を削除する方法を示します。
4// データベースのDELETE文とは異なり、HTMLやXMLのようなマークアップ言語のテキストコンテンツを操作する際に使用します。
5
6function demonstrateDomTextDeleteData(): void
7{
8    // 1. 新しいDOMドキュメントを作成します。
9    // '1.0'はXMLのバージョン、'UTF-8'は文字エンコーディングを指定します。
10    $dom = new Dom\Document('1.0', 'UTF-8');
11    // 出力時に整形（インデントなど）されるように設定します。
12    $dom->formatOutput = true;
13
14    // 2. ルート要素（例えば <html>）を作成し、ドキュメントに追加します。
15    $htmlElement = $dom->createElement('html');
16    $dom->appendChild($htmlElement);
17
18    // 3. body要素を作成し、html要素に追加します。
19    $bodyElement = $dom->createElement('body');
20    $htmlElement->appendChild($bodyElement);
21
22    // 4. p要素（段落）を作成し、body要素に追加します。
23    $paragraphElement = $dom->createElement('p');
24    $bodyElement->appendChild($paragraphElement);
25
26    // 5. テキストノードを作成し、p要素に追加します。
27    // このテキストノードが Dom\Text クラスのインスタンスになります。
28    $originalTextContent = 'Hello PHP World! This is a test string.';
29    $textNode = $dom->createTextNode($originalTextContent);
30    $paragraphElement->appendChild($textNode);
31
32    echo "--- 変更前のDOM構造 ---\n";
33    echo $dom->saveHTML(); // ドキュメント全体のHTMLを出力
34    echo "元のテキストコンテンツ: '" . $textNode->data . "'\n\n";
35
36    // 6. Dom\Text::deleteData メソッドを使用して、テキストノードの一部を削除します。
37    // 例えば、" PHP" の部分を削除してみましょう。
38    // 'Hello' は5文字なので、' PHP' はオフセット5から始まります。
39    // ' PHP' はスペースを含めて4文字なので、countは4です。
40    $offsetToDelete = 5;  // 削除を開始する位置（0から始まるインデックス）
41    $countToDelete = 4;   // 削除する文字数
42
43    echo "--- テキスト削除の実行 ---\n";
44    echo "削除対象: オフセット {$offsetToDelete} から {$countToDelete} 文字\n";
45    echo "削除される部分: '" . substr($textNode->data, $offsetToDelete, $countToDelete) . "'\n";
46
47    // deleteData メソッドを呼び出し、テキストノードの内容を変更します。
48    // このメソッドは値を返しません（void）。
49    $textNode->deleteData($offsetToDelete, $countToDelete);
50
51    echo "\n--- 変更後のDOM構造 ---\n";
52    echo $dom->saveHTML(); // 変更後のドキュメント全体のHTMLを出力
53    echo "変更後のテキストコンテンツ: '" . $textNode->data . "'\n";
54}
55
56// 関数を実行して、DOM操作を確認します。
57demonstrateDomTextDeleteData();

このサンプルコードは、PHP 8 で導入された Dom\Text::deleteData メソッドを使って、HTMLやXMLのようなマークアップ言語のテキストコンテンツを操作する方法を示しています。このメソッドは、データベースのDELETE文のようにテーブルの行を削除するものではなく、DOM（Document Object Model）ツリー内の特定のテキストノードから、指定した範囲の文字を削除するために使用されます。

Dom\Text::deleteData メソッドは、テキストノードのデータの一部を削除します。引数として int $offset と int $count を受け取ります。$offset は、テキストの削除を開始する位置を0から始まるインデックスで指定し、$count は、$offset の位置から何文字削除するかを整数で指定します。このメソッドは void 型を返すため、処理が完了しても直接的な値を返しません。

サンプルコードでは、まずDOMドキュメントを作成し、<html>、<body>、<p> といった要素を追加した後、Dom\Text クラスのインスタンスとなるテキストノードを <p> 要素内に作成します。その後、textNode->deleteData($offsetToDelete, $countToDelete) のようにメソッドを呼び出し、指定した位置から指定した文字数を削除しています。実行前後のテキストコンテンツを比較することで、変更がどのように適用されたかを確認できます。この機能は、Webページの動的なテキスト編集やXMLデータのプログラム的な加工に利用できます。

このdeleteDataメソッドは、データベースのレコードを削除するSQLのDELETE文とは全く異なり、HTMLやXMLのようなマークアップ言語のDOMツリーにおけるテキストノードの一部を削除するために使用します。削除を開始する位置である$offsetは、文字列の先頭を0として数えるため、指定の際には注意が必要です。また、削除する文字数である$countがテキストの残り文字数を超えても、エラーは発生しませんが、意図した結果になるか必ず確認してください。このメソッドは削除処理を実行するだけで、操作の成功・失敗を示す値は返しません（戻り値がvoidです）。使用する際は、Dom\Textクラスのインスタンスであることを確認してください。