Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

nodeValueプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『nodeValueプロパティは、Dom\Documentオブジェクトが表すドキュメントノード自体の値を保持するプロパティです。しかし、ドキュメントノードはDOMツリー全体のコンテナとしての役割を持ち、特定のテキスト値を持たないという特性があります。そのため、Dom\DocumentオブジェクトのnodeValueプロパティにアクセスした場合、その値は常にnullとなります。このプロパティは、ノードの種類によってその意味が異なり、例えばテキストノードやコメントノードではその内容の文字列を返しますが、ドキュメントノードや要素ノードではnullを返す仕様です。このプロパティに対して値を設定しようとしても、ドキュメントノードには適用されず、その操作は無視されます。したがって、Dom\Documentオブジェクトにおいてこのプロパティを直接利用する場面はほとんどありません。ドキュメントに含まれる全てのテキスト内容を連結して取得したい場合は、textContentプロパティのような別の手段を用いる必要があります。』

構文(syntax)

1<?php
2
3$document = new Dom\Document();
4
5$value = $document->nodeValue;
6
7var_dump($value);
8
9?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string|null

Dom\Document::nodeValue プロパティは、ノードのテキストコンテンツを表す文字列、またはノードにテキストコンテンツがない場合は null を返します。

サンプルコード

PHP DOMDocument nodeValueでテキストを取得する

1<?php
2
3/**
4 * Dom\Document::nodeValue の使用例を示します。
5 * ドキュメントノード自体の nodeValue は通常 null ですが、
6 * その子ノード(要素やテキストノード)のテキストコンテンツを取得する際に利用されます。
7 */
8function demonstrateDomNodeValue(): void
9{
10    // Dom\Document クラスの新しいインスタンスを作成します。
11    $document = new Dom\Document();
12
13    // 解析するシンプルなHTMLコンテンツを定義します。
14    $htmlContent = <<<HTML
15<!DOCTYPE html>
16<html>
17<head>
18    <title>DOM nodeValue サンプル</title>
19</head>
20<body>
21    <h1>PHP DOMでテキストを取得</h1>
22    <p>この<strong>段落</strong>のテキストコンテンツを取得します。</p>
23</body>
24</html>
25HTML;
26
27    // 定義したHTMLコンテンツをDom\Documentにロードします。
28    // loadHTML() はエラーを発生させることがありますが、ここでは処理の簡潔さを優先します。
29    $document->loadHTML($htmlContent);
30
31    echo "--- Dom\\Document::nodeValue の動作 --- \n\n";
32
33    // Dom\Document オブジェクト自体の nodeValue は通常 null です。
34    // ドキュメントノード自体は直接的なテキストコンテンツを持たないためです。
35    echo "Dom\\Document オブジェクトの nodeValue: " . var_export($document->nodeValue, true) . "\n\n";
36
37    // nodeValue は、DOMツリー内の個々の要素やテキストノードから
38    // そのテキストコンテンツを取得する際に非常に有用です。
39
40    // 例1: 最初の <h1> 要素の nodeValue を取得します。
41    // getElementsByTagName('h1') は、全ての <h1> 要素の DomNodeList を返します。
42    // item(0) でリストの最初の要素(ノード)を取得します。
43    $h1Elements = $document->getElementsByTagName('h1');
44    if ($h1Elements->count() > 0) {
45        $h1Node = $h1Elements->item(0);
46        // <h1> 要素の nodeValue は、その中のテキストコンテンツになります。
47        echo "最初の <h1> 要素の nodeValue: " . $h1Node->nodeValue . "\n";
48    }
49
50    // 例2: 最初の <p> 要素の nodeValue を取得します。
51    $pElements = $document->getElementsByTagName('p');
52    if ($pElements->count() > 0) {
53        $pNode = $pElements->item(0);
54        // <p>要素内の <strong> タグは無視され、その子孫ノード全てのテキストが結合されて取得されます。
55        echo "最初の <p> 要素の nodeValue: " . $pNode->nodeValue . "\n";
56    }
57
58    // 例3: <title> 要素の nodeValue を取得します。
59    $titleElements = $document->getElementsByTagName('title');
60    if ($titleElements->count() > 0) {
61        $titleNode = $titleElements->item(0);
62        echo "最初の <title> 要素の nodeValue: " . $titleNode->nodeValue . "\n";
63    }
64}
65
66// 上記の関数を実行して、nodeValue の動作を確認します。
67demonstrateDomNodeValue();
68

PHPのDom\Document::nodeValueプロパティは、DOM(Document Object Model)拡張機能の一部として、HTMLやXMLドキュメント内の特定のノードが持つテキストコンテンツを取得するために使用されます。このプロパティは引数を取らず、ノードのテキストコンテンツを表すstring型、またはテキストコンテンツがない場合はnullを返します。

ドキュメント全体を表すDom\Documentオブジェクト自体のnodeValueは、通常nullとなります。これは、ドキュメントノード自体が直接的なテキストコンテンツを持たないためです。しかし、ドキュメント内の特定の要素ノード(例えば、<h1><p>タグなど)に対してnodeValueを使用すると、その要素に含まれる全てのテキストコンテンツが結合されて取得されます。この際、子要素のタグ自体は無視され、その中にあるテキストのみが抽出される点が特徴です。例えば、<p>この<strong>段落</strong>のテキスト</p>のようなノードのnodeValueは、「この段落のテキスト」という文字列を返します。

提示されたサンプルコードでは、シンプルなHTMLコンテンツをDom\Documentオブジェクトにロードし、Dom\Documentオブジェクト自身のnodeValuenullであることを最初に示しています。その後、<h1><p><title>といったHTML要素ノードを具体的に取得し、それぞれのnodeValueがどのようにテキストコンテンツを返すかを出力しています。これにより、nodeValueがHTMLやXMLの構造からテキスト情報を効率的に抽出する際に非常に有用なプロパティであることが理解できます。

Dom\Documentオブジェクト自体のnodeValueは通常nullとなる点にご注意ください。これは、ドキュメントノード自体が直接的なテキストコンテンツを持たないためです。nodeValueは、要素ノードやテキストノードから、その子孫ノードを含むすべてのテキストコンテンツを、HTMLタグを無視して結合した形で取得する際に利用します。

特定の要素のnodeValueを取得する際は、getElementsByTagNameのようなメソッドで取得したノードリストが空でないか(つまり、要素が存在するか)を必ず確認してからアクセスするようにしてください。これにより、存在しない要素へのアクセスによるエラーを防ぎ、プログラムがより安全に動作します。このプロパティは、HTML要素内の純粋なテキストデータ抽出に非常に便利です。

PHP nodeValue でHTML要素の値を取得する

1<?php
2
3// HTML ドキュメントをロードします。
4$html = <<<HTML
5<!DOCTYPE html>
6<html>
7<head>
8  <title>Example</title>
9</head>
10<body>
11  <h1>Hello, World!</h1>
12  <p>This is a paragraph.</p>
13</body>
14</html>
15HTML;
16
17$dom = new DOMDocument();
18$dom->loadHTML($html);
19
20// h1 要素を取得します。
21$h1 = $dom->getElementsByTagName('h1')->item(0);
22
23// h1 要素の nodeValue を取得します。
24if ($h1) {
25  $nodeValue = $h1->nodeValue;
26
27  // nodeValue を表示します。
28  echo "h1 nodeValue: " . $nodeValue . PHP_EOL; // 出力: h1 nodeValue: Hello, World!
29}
30
31// p 要素を取得します。
32$p = $dom->getElementsByTagName('p')->item(0);
33
34// p 要素の nodeValue を取得します。
35if ($p) {
36  $nodeValue = $p->nodeValue;
37
38  // nodeValue を表示します。
39  echo "p nodeValue: " . $nodeValue . PHP_EOL; // 出力: p nodeValue: This is a paragraph.
40}
41?>

このサンプルコードは、PHPのDOMDocumentクラスを使用してHTMLドキュメントを解析し、特定の要素のテキストコンテンツ(nodeValue)を取得する方法を示します。

まず、DOMDocumentクラスのインスタンスを作成し、loadHTML()メソッドでHTML文字列を読み込みます。次に、getElementsByTagName()メソッドを使って、取得したい要素(ここではh1要素とp要素)を指定します。item(0)で最初に見つかった要素を取得します。

取得した要素に対して、nodeValueプロパティにアクセスすることで、その要素に含まれるテキストコンテンツを取得できます。nodeValueは、要素内のテキストノードの値を示す文字列を返します。もし要素が存在しない場合は、nullが返される可能性があります。サンプルコードでは、if ($h1)のように要素の存在を確認してからnodeValueを取得することで、エラーを回避しています。

取得したnodeValueは、echo文で表示しています。PHP_EOLは改行コードを表し、出力結果を見やすくするために使用しています。このコードを実行すると、h1要素とp要素のテキストコンテンツがそれぞれ表示されます。

nodeValueプロパティは、HTMLドキュメントからテキスト情報を抽出する際に非常に便利です。例えば、WebスクレイピングやHTMLデータの解析など、さまざまな場面で活用できます。

nodeValueは、要素ノードが持つテキストコンテンツを取得する際に使用します。HTMLタグ自体は含まれません。getElementsByTagNameDOMNodeListを返すため、item(0)で最初の要素を取得する必要があります。もし要素が見つからない場合(item(0)nullを返す場合)は、nodeValueにアクセスする前にif文でnullチェックを行うことが重要です。nodeValueの戻り値は文字列またはnullであるため、型を意識して扱いましょう。loadHTMLメソッドを使用する際は、文字コードの問題に注意し、必要に応じてエンコーディングを指定してください。HTML構造が複雑な場合、XPathを使用するとより柔軟に要素を特定できます。

関連コンテンツ

関連プログラミング言語