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

Copy
1<?php
2
3/**
4 * DOMCharacterData::nodeValue プロパティの使用例を示します。
5 *
6 * DOMCharacterData は、テキストノード (DOMText) やコメントノード (DOMComment) などの
7 * 文字データを扱うノードの基底クラスです。
8 * nodeValue プロパティは、これらのノードのテキスト内容を取得したり設定したりするために使用されます。
9 */
10function demonstrateDomNodeValue(): void
11{
12    // 1. DOMDocument オブジェクトを作成
13    // XML バージョンとエンコーディングを指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力XMLを整形し、読みやすくします。
16    $dom->formatOutput = true;
17
18    // 2. ルート要素を作成し、ドキュメントに追加
19    $root = $dom->createElement('data');
20    $dom->appendChild($root);
21
22    // 3. テキストノードを持つ要素を作成
23    $messageElement = $dom->createElement('message');
24    $initialTextNode = $dom->createTextNode('Hello PHP DOM!');
25    $messageElement->appendChild($initialTextNode);
26    $root->appendChild($messageElement);
27
28    // 4. コメントノードを作成
29    $commentNode = $dom->createComment('これは重要な情報です。');
30    $root->appendChild($commentNode);
31
32    echo "--- 初期ドキュメントの状態 ---\n";
33    echo $dom->saveXML(); // 現在のXMLを出力
34    echo "\n";
35
36    // 5. DOMXPath を使用してノードを検索
37    // DOMXPath は、複雑なドキュメントから特定のノードを見つけるのに便利です。
38    $xpath = new DOMXPath($dom);
39
40    // '/data/message/text()' は、'data'要素の下にある'message'要素内のテキストノードを指します。
41    $foundTextNode = $xpath->query('/data/message/text()')->item(0);
42
43    // '/data/comment()' は、'data'要素の下にあるコメントノードを指します。
44    $foundCommentNode = $xpath->query('/data/comment()')->item(0);
45
46    // 6. nodeValue プロパティを読み取る
47    echo "--- nodeValue の読み取り ---\n";
48    if ($foundTextNode instanceof DOMCharacterData) {
49        echo "現在のテキストノードの値: " . $foundTextNode->nodeValue . "\n";
50    } else {
51        echo "テキストノードが見つからないか、DOMCharacterDataではありません。\n";
52    }
53
54    if ($foundCommentNode instanceof DOMCharacterData) {
55        echo "現在のコメントノードの値: " . $foundCommentNode->nodeValue . "\n";
56    } else {
57        echo "コメントノードが見つからないか、DOMCharacterDataではありません。\n";
58    }
59    echo "\n";
60
61    // 7. nodeValue プロパティを更新する
62    echo "--- nodeValue の更新 ---\n";
63    if ($foundTextNode instanceof DOMCharacterData) {
64        $foundTextNode->nodeValue = '新しいDOMテキストに更新されました。';
65        echo "テキストノードが更新されました: " . $foundTextNode->nodeValue . "\n";
66    }
67
68    if ($foundCommentNode instanceof DOMCharacterData) {
69        $foundCommentNode->nodeValue = '更新されたコメントです。';
70        echo "コメントノードが更新されました: " . $foundCommentNode->nodeValue . "\n";
71    }
72    echo "\n";
73
74    // 8. 更新後のドキュメントの状態を出力
75    echo "--- 更新後のドキュメントの状態 ---\n";
76    echo $dom->saveXML();
77    echo "\n";
78}
79
80// 関数を実行して、DOMCharacterData::nodeValue の動作を確認します。
81demonstrateDomNodeValue();

PHPのDOMCharacterData::nodeValueプロパティは、XMLやHTMLドキュメント内のテキスト内容を操作するための機能です。このプロパティは、DOMText（テキストノード）やDOMComment（コメントノード）など、文字データを持つノードの基底クラスであるDOMCharacterDataに属しています。ノードが保持する実際のテキスト内容を取得したり、新しい内容に設定したりするために使用されます。

nodeValueプロパティに引数はなく、ノードのテキスト内容を文字列（string）として返します。もしノードにテキスト内容が存在しない場合や、該当しないノードタイプの場合にはnullを返すことがあります。

提供されたサンプルコードでは、DOMDocumentを使用してXMLドキュメントを作成し、テキストノードとコメントノードを追加しています。その後、DOMXPathを使って特定のテキストノードとコメントノードを検索します。見つかったノードがDOMCharacterData型であることを確認した後、$ノード->nodeValueのようにアクセスすることで、そのノードの現在のテキスト内容を簡単に読み出すことができます。さらに、$ノード->nodeValue = '新しい値';のように文字列を代入することで、ノードのテキスト内容を更新することも可能です。このプロパティを用いることで、ドキュメント内の文字データを柔軟に操作できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMElementのnodeValueとtextContentの違いを比較します。
7 */
8function compareNodeValueAndTextContent(): void
9{
10    // 比較用のHTML文字列を準備
11    $html = '<p>これは<strong>重要</strong>なテキストです。</p>';
12
13    // DOMDocumentオブジェクトを作成し、HTMLを読み込む
14    $dom = new DOMDocument();
15    // HTML5としてパースし、エラーを抑制
16    libxml_use_internal_errors(true);
17    $dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
18    libxml_clear_errors();
19
20    // p要素 (DOMElement) を取得
21    $pElement = $dom->getElementsByTagName('p')->item(0);
22
23    echo "--- p要素 (DOMElement) での比較 ---\n";
24
25    // nodeValueは要素ノード（DOMElement）自体にはテキスト値を持たないため、nullを返す
26    echo 'p要素の $node->nodeValue: ';
27    var_dump($pElement->nodeValue); // 出力: NULL
28
29    // textContentは、その要素とすべての子孫ノードのテキストを連結して返す
30    echo 'p要素の $node->textContent: ';
31    var_dump($pElement->textContent); // 出力: string(48) "これは重要なテキストです。"
32
33    echo "\n";
34
35    // p要素の最初の子ノードであるテキストノード (DOMText) を取得
36    $textNode = $pElement->firstChild;
37
38    echo "--- テキストノード (DOMText) での比較 ---\n";
39
40    // テキストノードの場合、nodeValueはそのノード自身のテキスト内容を返す
41    echo 'テキストノードの $node->nodeValue: ';
42    var_dump($textNode->nodeValue); // 出力: string(9) "これは"
43
44    // テキストノードの場合、textContentもnodeValueと同様にそのノード自身のテキスト内容を返す
45    echo 'テキストノードの $node->textContent: ';
46    var_dump($textNode->textContent); // 出力: string(9) "これは"
47}
48
49compareNodeValueAndTextContent();

このPHPサンプルコードは、DOM操作におけるnodeValueプロパティとtextContentプロパティの挙動の違いを解説しています。nodeValueは、ノードの値を文字列で取得または設定するためのプロパティです。引数はなく、戻り値はノードの種類によって文字列 (string) または null となります。

コード前半のp要素（DOMElement）での比較を見ると、nodeValueはnullを返します。これは、要素ノード自体はテキスト値を持たないという仕様に基づいています。一方でtextContentは、その要素とすべての子孫ノードのテキストを連結した「これは重要なテキストです。」という文字列を返します。

コード後半では、p要素内の最初のテキスト「これは」を表すテキストノード（DOMText）で比較しています。この場合、nodeValueとtextContentはどちらも同じように、ノード自身が持つテキスト「これは」を返します。

このように、nodeValueはテキストノードやコメントノードなど、値を持つ特定のノードから直接値を取得するのに適しています。対してtextContentは、要素ツリー全体からテキスト情報だけをまとめて抽出したい場合に便利です。