【PHP8.x】Dom\Text::nodeValueプロパティの使い方

Copy
1<?php
2
3// Dom\Text クラスの nodeValue プロパティと textContent プロパティの比較
4
5// XML 文字列を定義
6$xmlString = <<<XML
7<root>
8  <element>
9    This is some text. &amp; This is more text.
10  </element>
11</root>
12XML;
13
14// DOMDocument を作成し、XML 文字列を読み込む
15$dom = new DOMDocument();
16$dom->loadXML($xmlString);
17
18// element ノードを取得
19$element = $dom->getElementsByTagName('element')->item(0);
20
21// element ノードの最初の子ノード（テキストノード）を取得
22$textNode = $element->firstChild;
23
24// nodeValue プロパティと textContent プロパティの値を出力
25echo "nodeValue: " . $textNode->nodeValue . PHP_EOL;
26echo "textContent: " . $element->textContent . PHP_EOL;
27
28// nodeValue はテキストノード自身の値（エスケープされた文字を含む）を返す
29// textContent はノードとその子孫のテキストコンテンツを結合して返す（エスケープを解除した文字を含む）
30
31?>

PHPのDom\TextクラスにおけるnodeValueプロパティとtextContentプロパティの違いを示すサンプルコードです。nodeValueは、テキストノード自身の値を返します。一方、textContentは、ノードとその子孫ノードのテキストコンテンツを結合して返します。

このサンプルでは、まずXML文字列を定義し、DOMDocumentオブジェクトに読み込んでいます。次に、XML内の <element> タグの最初の子ノード（テキストノード）を取得します。そして、nodeValueプロパティとtextContentプロパティの値を出力しています。

nodeValueは、テキストノードに直接含まれるテキストを返し、XMLエンティティ（例: &）はエスケープされたままとなります。つまり、テキストノードが持つ、文字参照やCDATAセクションを含む生のテキストデータをそのまま取得したい場合に適しています。

対照的に、textContentは、要素ノードとそのすべての子孫ノードに含まれるテキストコンテンツを結合して返します。この際、XMLエンティティはデコードされます。このため、要素ノードの内容全体を取得したい場合に便利です。

このサンプルコードを実行することで、nodeValueとtextContentがそれぞれどのような値を返すかを確認できます。nodeValueプロパティは引数を取りませんが、string型もしくはnull型を返します。テキストノードが存在しない場合や、ノードがテキストノードでない場合は、nullを返すことがあります。