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

Copy
1<?php
2
3/**
4 * DOMText::remove() メソッドの使用例を示します。
5 * このメソッドは、DOMツリーから特定のテキストノード自体を削除するために使用されます。
6 * 引数は不要で、何も返しません（void）。
7 *
8 * システムエンジニアを目指す初心者の方へ：
9 * PHPのDOM拡張機能は、HTMLやXML文書をオブジェクトとして操作するための強力なツールです。
10 * DOMText::remove() メソッドは、文書内のテキスト部分（テキストノード）を削除する際に利用します。
11 * ファイルシステムからファイルを削除するPHPのunlink()関数とは異なりますのでご注意ください。
12 *
13 * @return void
14 */
15function demonstrateDomTextRemove(): void
16{
17    // 新しいDOMドキュメントを作成します。XMLバージョンとエンコーディングを指定。
18    $dom = new DOMDocument('1.0', 'UTF-8');
19    // 出力されるXMLを見やすくするために、フォーマットを有効にします。
20    $dom->formatOutput = true;
21
22    // ルート要素 '<root>' を作成し、ドキュメントに追加します。
23    $rootElement = $dom->createElement('root');
24    $dom->appendChild($rootElement);
25
26    // 削除対象となるテキストノードを作成し、ルート要素の子として追加します。
27    $textNodeToRemove = $dom->createTextNode('このテキストは削除されます。');
28    $rootElement->appendChild($textNodeToRemove);
29
30    // 削除されない別の要素とテキストノードを追加し、比較のために残します。
31    $spanElement = $dom->createElement('span', 'このスパン内のテキストは残ります。');
32    $rootElement->appendChild($spanElement);
33
34    // 別のテキストノードを追加します。これも削除されません。
35    $anotherTextNode = $dom->createTextNode('これも残るテキストです。');
36    $rootElement->appendChild($anotherTextNode);
37
38    echo "--- 削除前のDOMツリーの状態 ---" . PHP_EOL;
39    // 現在のDOMツリーのXML表現を出力して確認します。
40    echo $dom->saveXML() . PHP_EOL;
41
42    // DOMText::remove() メソッドを呼び出して、
43    // $textNodeToRemove で指定したテキストノードをDOMツリーから削除します。
44    // このメソッドは引数を取らず、戻り値もありません（void）。
45    echo "「このテキストは削除されます。」というテキストノードを削除します..." . PHP_EOL;
46    $textNodeToRemove->remove();
47
48    echo "--- 削除後のDOMツリーの状態 ---" . PHP_EOL;
49    // 削除後のDOMツリーのXML表現を出力して確認します。
50    // 最初のテキストノードがなくなっていることを確認してください。
51    echo $dom->saveXML() . PHP_EOL;
52}
53
54// 上記の関数を実行して、DOMText::remove() メソッドの動作を確認します。
55demonstrateDomTextRemove();

PHPのDOMText::remove()メソッドは、HTMLやXML文書をオブジェクトとして扱うDOM拡張機能に属します。このメソッドの主な目的は、DOMツリー（文書の内部構造）から特定のテキストノード自体を削除することです。システムエンジニアを目指す初心者の方は、文書内の文字コンテンツを表現する「テキストノード」を削除する際にこのメソッドを利用すると覚えてください。

DOMText::remove()メソッドは引数を必要とせず、呼び出すだけで対象のテキストノードがDOMツリーから取り除かれます。戻り値もありません（void）ので、メソッド呼び出し後に結果を受け取る必要はありません。

注意点として、このメソッドはファイルシステム上のファイルを削除するPHPのunlink()関数とは全く異なります。DOMText::remove()は、メモリ上で展開されたHTMLやXMLの文書構造内のテキスト部分を操作するためのものであり、ファイル自体には影響を与えません。

サンプルコードでは、まずDOMドキュメントを作成し、いくつかの要素とテキストノードを追加しています。その中で削除対象となるテキストノードを意図的に作成し、$textNodeToRemove->remove();と呼び出すことで、そのテキストノードがDOMツリーから正確に削除される様子を示しています。削除前後のXML出力を比較することで、対象のテキストノードが消失していることを確認できます。

Copy
1<?php
2
3/**
4 * PHP 8 の DOMText::remove() メソッドの使用例です。
5 * このメソッドは、DOMツリーから特定のテキストノードを削除します。
6 *
7 * DOMText::remove() は引数を取らず、戻り値は void です。
8 */
9function demonstrateDomTextRemoval(): void
10{
11    // 新しいDOMDocumentオブジェクトを作成し、HTMLコンテンツを読み込みます。
12    $dom = new DOMDocument();
13    // HTMLパース時の警告を抑制し、内部エラーとして扱います。
14    // これにより、HTMLの構文が厳密でない場合でもスクリプトの実行が中断されにくくなります。
15    libxml_use_internal_errors(true);
16    $dom->loadHTML('<p>これは削除対象のテキストです。<span>これはspan要素です。</span>そして、別のテキストです。</p>');
17    libxml_clear_errors(); // 処理後、内部エラーキューをクリアします。
18
19    echo "--- 削除前 ---" . PHP_EOL;
20    // 現在のDOMツリーのHTML構造全体を出力します。
21    // デバッグ目的で、何が読み込まれたかを確認できます。
22    echo $dom->saveHTML() . PHP_EOL . PHP_EOL;
23
24    // ドキュメント内の最初の <p> 要素を取得します。
25    $paragraph = $dom->getElementsByTagName('p')->item(0);
26
27    if ($paragraph) {
28        // <p> 要素の子ノードをループし、削除対象のテキストノードを見つけます。
29        // ここでは「これは削除対象のテキストです。」というテキストノードを探します。
30        // DOMTextインスタンスであり、かつ内容が空白ではない最初のノードを選択します。
31        $targetTextNode = null;
32        foreach ($paragraph->childNodes as $node) {
33            if ($node instanceof DOMText && trim($node->nodeValue) !== '') {
34                $targetTextNode = $node;
35                break;
36            }
37        }
38
39        if ($targetTextNode) {
40            echo "--- 削除実行 ---" . PHP_EOL;
41            echo "削除するテキストノードの内容: 「" . trim($targetTextNode->nodeValue) . "」" . PHP_EOL . PHP_EOL;
42
43            // DOMText::remove() メソッドを呼び出して、このテキストノードをその親ノードから削除します。
44            // このメソッドは引数なしで呼び出され、操作後はDOMツリーからノードが取り除かれます。
45            $targetTextNode->remove();
46
47            echo "テキストノードを正常に削除しました。" . PHP_EOL . PHP_EOL;
48        } else {
49            echo "指定されたテキストノードが見つかりませんでした。" . PHP_EOL . PHP_EOL;
50        }
51    } else {
52        echo "HTMLドキュメント内に <p> 要素が見つかりませんでした。" . PHP_EOL . PHP_EOL;
53    }
54
55    echo "--- 削除後 ---" . PHP_EOL;
56    // テキストノード削除後のDOMツリーのHTML構造全体を出力します。
57    // 最初のテキストノードが取り除かれていることが確認できます。
58    echo $dom->saveHTML() . PHP_EOL;
59}
60
61// 作成した関数を実行し、DOMText::remove() の動作を確認します。
62demonstrateDomTextRemoval();
63

PHP 8のDOMText::remove()メソッドは、HTMLやXMLドキュメントの構造（DOMツリー）から、特定のテキストノードを削除するために利用されます。このメソッドは特別な引数を必要とせず、処理が完了しても値を何も返さないvoid型です。

提供されたサンプルコードでは、最初にDOMDocumentオブジェクトを使ってHTMLコンテンツを読み込み、内部的にDOMツリーを構築します。このHTMLには「これは削除対象のテキストです。」というテキストが含まれています。次に、コードはドキュメント内の最初の<p>要素を探し、その子ノードの中から削除したい特定のテキストノード（この場合は「これは削除対象のテキストです。」）を特定します。

削除対象のテキストノードが見つかったら、$targetTextNode->remove();のようにメソッドを呼び出します。これにより、対象のテキストノードはその親要素から完全に切り離され、DOMツリーから取り除かれます。コードの実行前後でHTML構造を出力しているため、テキストノードが実際に削除されたことを確認できます。このメソッドは、ウェブページの内容を動的に変更する際に、特定のテキスト部分だけを除去したい場合に非常に有効です。