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

Copy
1<?php
2
3/**
4 * DOMDocumentFragment クラスの textContent プロパティの使用例を示します。
5 *
6 * この関数は、DOMDocumentFragment を作成し、要素ノードとテキストノードを追加します。
7 * その後、textContent プロパティを使用して、フラグメント内のすべてのテキストコンテンツを
8 * 結合した単一の文字列として取得し、出力します。
9 */
10function demonstrateDomFragmentTextContent(): void
11{
12    // 1. 新しい DOMDocument オブジェクトを作成します。
13    //    これは、DOM ノード（要素、テキストなど）を作成するためのコンテキストとして機能します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 2. DOMDocumentFragment オブジェクトを作成します。
17    //    DOMDocumentFragment は、複数のノードを一時的に保持できる軽量なコンテナです。
18    //    DOMツリーに直接追加する前に、ノードのグループを構築するのに便利です。
19    $fragment = $dom->createDocumentFragment();
20
21    // 3. フラグメントにコンテンツを追加します。
22    //    まず、シンプルなテキストノードを追加します。
23    $fragment->appendChild($dom->createTextNode('最初の部分のテキストです。 '));
24
25    //    次に、'em' (強調) 要素を作成し、その中にさらにテキストノードを追加します。
26    $emphasisElement = $dom->createElement('em');
27    $emphasisElement->appendChild($dom->createTextNode('これは強調されたテキストです。'));
28    $fragment->appendChild($emphasisElement);
29
30    //    最後に、別のテキストノードを追加します。
31    $fragment->appendChild($dom->createTextNode(' 最後のテキスト。'));
32
33    // 4. textContent プロパティを使用して、フラグメント内のすべてのテキストコンテンツを取得します。
34    //    textContent は、ノード自身とすべての子孫ノードのテキストコンテンツを結合した文字列を返します。
35    //    HTMLタグなどのマークアップは含まれず、純粋なテキストのみが抽出されます。
36    $combinedText = $fragment->textContent;
37
38    // 5. 取得した結合済みテキストコンテンツを出力します。
39    echo "--- DOMDocumentFragment::textContent プロパティのデモンストレーション ---" . PHP_EOL;
40    echo "DOMDocumentFragment から抽出された結合テキスト: " . PHP_EOL;
41    echo $combinedText . PHP_EOL;
42    echo "--- 実行完了 ---" . PHP_EOL;
43}
44
45// 上記のデモンストレーション関数を実行します。
46demonstrateDomFragmentTextContent();

PHPのDOMDocumentFragment::textContentプロパティは、複数のノードを一時的にまとめることができるDOMDocumentFragmentオブジェクトから、その内部にあるすべてのテキストコンテンツを抽出するためのものです。このプロパティに引数はなく、ノード自身と、その子孫ノードに含まれるテキストをすべて結合した単一のstring型の値を返します。

サンプルコードでは、まずDOMDocumentFragmentを作成し、そこに直接テキストノードや、テキストを含むem要素などのノードを追加しています。具体的には、「最初の部分のテキストです。」「これは強調されたテキストです。」「最後のテキスト。」といった複数のテキストコンテンツがフラグメント内に配置されます。その後、$fragment->textContentを実行すると、これらのテキストが結合され、「最初の部分のテキストです。 これは強調されたテキストです。 最後のテキスト。」という一つの文字列として取得されます。この際、emタグのようなHTMLマークアップは取り除かれ、純粋なテキストデータのみが抽出される点がこのプロパティの重要な特徴です。これにより、複雑なDOM構造から視覚的なテキスト内容を簡潔にまとめることが可能となります。

Copy
1<?php
2
3/**
4 * DOMDocumentFragmentにおけるnodeValueとtextContentの違いを比較します。
5 *
6 * この関数は、DOMDocumentFragmentを作成し、その中に複数のHTML要素を追加します。
7 * そして、`textContent`プロパティと`nodeValue`プロパティの値を取得し、
8 * その違いをコンソールに出力して示します。
9 */
10function compareNodeValueAndTextContent(): void
11{
12    // 1. DOMDocumentとDOMDocumentFragmentのインスタンスを作成します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $fragment = $dom->createDocumentFragment();
15
16    // 2. フラグメントに複数の子ノード（HTML要素）を追加します。
17    // appendXMLは文字列をHTMLとしてパースし、ノードとして追加します。
18    $fragment->appendXML('<p>段落1</p><span>テキスト</span><!-- コメント -->');
19
20    // --- textContentの動作確認 ---
21    // `textContent`は、自身とそのすべての子孫ノードのテキストコンテンツを連結して返します。
22    // HTMLタグやコメントは無視され、テキスト部分だけが抽出されます。
23    echo '--- $fragment->textContent ---' . PHP_EOL;
24    echo $fragment->textContent . PHP_EOL; // 出力: 段落1テキスト
25
26    echo PHP_EOL;
27
28    // --- nodeValueの動作確認 ---
29    // `nodeValue`は、ノード自体の値を返します。
30    // DOMDocumentFragmentのような、子ノードをまとめるためのノードは
31    // それ自体にテキスト値を持たないため、`nodeValue`は常にnullを返します。
32    echo '--- $fragment->nodeValue ---' . PHP_EOL;
33    var_dump($fragment->nodeValue); // 出力: NULL
34
35    echo PHP_EOL;
36
37    // --- 補足：テキストノードでの比較 ---
38    // テキストノードの場合、`nodeValue`と`textContent`は同じ値を返します。
39    $textNode = $dom->createTextNode('これはテキストノードです');
40    echo '--- Text Node ---' . PHP_EOL;
41    echo 'textContent: ' . $textNode->textContent . PHP_EOL; // 出力: これはテキストノードです
42    echo 'nodeValue:   ' . $textNode->nodeValue . PHP_EOL;   // 出力: これはテキストノードです
43}
44
45// 関数を実行して結果を表示します。
46compareNodeValueAndTextContent();

PHP 8におけるDOMDocumentFragmentクラスのtextContentプロパティは、DOMDocumentFragmentとその内部にある全ての子孫ノードから、HTMLタグやコメントを除いた純粋なテキストコンテンツを連結して文字列として取得します。このプロパティには引数はなく、常に文字列型の値を返します。

サンプルコードでは、<p>タグや<span>タグ、さらにコメントを含むDOMDocumentFragmentを作成しています。ここで$fragment->textContentを実行すると、「段落1テキスト」という結果が得られます。これは、<p>や<span>といったHTMLタグ、およびコメントが無視され、それらの内部にあるテキスト部分のみが連結されて抽出されていることを示しています。

一方、nodeValueプロパティはノード自体の値を返します。DOMDocumentFragmentは複数の子ノードをまとめるためのコンテナノードであり、それ自体には直接的なテキスト値を持たないため、$fragment->nodeValueは常にNULLを返します。この違いは重要で、textContentは子孫ノードのテキストコンテンツ全体を取得する際に使用し、nodeValueはノード自身の値、特にテキストノードなど、ノード自体がテキスト値を持つ場合に利用されると理解すると良いでしょう。実際にサンプルコードの補足部分では、テキストノードの場合にtextContentとnodeValueが同じ値を返すことが示されています。