【PHP8.x】wholeTextプロパティの使い方

wholeTextプロパティは、Dom\CDATASectionクラスが持つ、ノードのテキストコンテンツを保持するプロパティです。このプロパティは、XMLやHTMLなどの構造化された文書（DOMツリー）において、CDATASection（CDATAセクション）ノードが含むテキスト、あるいはその前後に隣接するテキストノード群の全体の内容を、一つのまとまった文字列として取得するために使用されます。

プログラミングにおいて文書のテキストを扱う際、実際には一つの連続したテキストが、内部的に複数の小さなテキストノードに分割されて格納されていることがあります。wholeTextプロパティは、現在対象としているCDATASectionノードから見て、その前後に連続して存在するすべてのテキスト関連ノード（通常のテキストノードや、同じCDATASectionノード）のコンテンツを、自動的に結合します。

結果として、これらの隣接するノードに分散しているテキストを、開発者が個別にたどって連結する手間をかけることなく、あたかも最初から一つの文字列であったかのように、論理的な意味での完全なテキストコンテンツとして一度に取得できます。これは、文書から特定のテキスト情報を効率的に抽出したい場合や、複数のノードにまたがるテキストをまとめて処理したい場合に特に有用です。wholeTextプロパティは読み込み専用であるため、このプロパティを通じて取得した文字列の内容を直接変更することはできません。

Copy
1<?php
2$dom = new DOMDocument();
3$cdataSection = $dom->createCDATASection("これはCDATAセクションの内容です。");
4
5echo $cdataSection->wholeText;
6?>

引数なし

引数はありません

string

このプロパティは、DOM CDATA セクションノードに含まれる全てのテキストコンテンツを文字列として返します。