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

Copy
1<?php
2
3/**
4 * DOMDocument::nodeValue プロパティの使用例
5 * システムエンジニアを目指す初心者向けに、XML要素のテキストコンテンツ（nodeValue）を取得するサンプルです。
6 *
7 * nodeValue は、指定したノードのテキストコンテンツ（値）を取得または設定するために使用されます。
8 * 例えば、XMLやHTMLの要素の間のテキストを取得する際によく使われます。
9 */
10function getDomNodeValueExample(): void
11{
12    // 1. サンプルXML文字列を準備します。
13    // ここでは、本の情報を含むシンプルなXMLを使用します。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<bookstore>
17    <book category="cooking">
18        <title lang="en">Everyday Italian</title>
19        <author>Giada De Laurentiis</author>
20        <year>2005</year>
21        <price>30.00</price>
22    </book>
23    <book category="children">
24        <title lang="en">Harry Potter</title>
25        <author>J.K. Rowling</author>
26        <year>2005</year>
27        <price>29.99</price>
28    </book>
29</bookstore>
30XML;
31
32    // 2. DOMDocument オブジェクトを作成します。
33    // このオブジェクトを使ってXMLドキュメントを操作します。
34    $dom = new DOMDocument();
35
36    // libxmlのエラーを一時的に抑制します。
37    // これにより、XMLのパース時に発生する可能性のある警告が画面に表示されなくなります。
38    // 実際のアプリケーションでは、エラーハンドリングを適切に行うべきです。
39    libxml_use_internal_errors(true);
40    $dom->loadXML($xmlString); // XML文字列をDOMDocumentに読み込みます。
41    libxml_clear_errors();     // 処理後、エラーバッファをクリアします。
42
43    // 3. 特定のノードにアクセスし、nodeValue プロパティを取得します。
44    // ここでは、すべての <title> 要素を取得してみます。
45    $titles = $dom->getElementsByTagName('title');
46
47    // 最初の <title> 要素が存在するか確認します。
48    if ($titles->length > 0) {
49        // DOMNodeList から最初の DOMNode オブジェクトを取得します。
50        // item(0) はリストの最初の要素を返します。
51        $firstTitleNode = $titles->item(0);
52
53        // ノードが取得できた場合、その nodeValue を表示します。
54        if ($firstTitleNode !== null) {
55            $titleValue = $firstTitleNode->nodeValue; // nodeValue プロパティでノードのテキストコンテンツを取得
56
57            echo "最初の本のタイトル: " . $titleValue . PHP_EOL; // 取得した値を出力
58        }
59    } else {
60        echo "タイトル要素が見つかりませんでした。" . PHP_EOL;
61    }
62
63    echo PHP_EOL; // 見やすくするための改行
64
65    // 他のノードの nodeValue も取得してみます。
66    // 例えば、2冊目の本の <author> 要素の nodeValue を取得します。
67    $authors = $dom->getElementsByTagName('author');
68    if ($authors->length > 1) { // 2つ目の著者ノードが存在するか確認
69        $secondAuthorNode = $authors->item(1); // リストの2番目の要素（インデックスは1）を取得
70
71        if ($secondAuthorNode !== null) {
72            $authorValue = $secondAuthorNode->nodeValue; // 著者の名前を取得
73
74            echo "2冊目の本の著者: " . $authorValue . PHP_EOL;
75        }
76    }
77}
78
79// 関数を実行して、サンプルコードの動作を確認します。
80getDomNodeValueExample();

DOMDocument::nodeValueプロパティは、XMLやHTMLドキュメント内の特定のノード（要素や属性など）が持つテキストコンテンツ（値）を取得したり、設定したりするために使用されます。特に、XMLやHTMLの要素タグの間に記述されたテキストデータ、例えば書籍のタイトルや著者の名前などをプログラムで取り出したい場合に非常に役立ちます。

このサンプルコードでは、まずPHPのDOMDocumentクラスを用いてXML文字列を読み込み、コンピュータが操作しやすいドキュメント構造（DOMツリー）に変換しています。次に、getElementsByTagNameメソッドを使って特定のタグ名（例えば<title>や<author>)を持つすべての要素（ノード）を検索し、それらのノードのリストを取得します。

リストから具体的なノードを選び出した後、そのノードに対してnodeValueプロパティにアクセスすることで、そのノードが保持している純粋なテキストコンテンツを簡単に取得できます。例えば、最初の本のタイトルである「Everyday Italian」や、2冊目の本の著者である「J.K. Rowling」といった文字列が取得され、表示されています。

このnodeValueプロパティは特別な引数を必要としません。戻り値としては、取得したノードにテキストコンテンツが存在すれば文字列を返しますが、ノードに値がない場合や、そもそもノードが存在しないなどの場合にはnullが返される可能性があります。これにより、XMLやHTMLドキュメントから必要な情報を効率的に抽出する基本的な方法を学ぶことができます。

Copy
1<?php
2
3// DOMDocument を使用して XML ドキュメントを操作する例
4$xmlString = <<<XML
5<root>
6  <element attribute="value">This is the text content.</element>
7  <element2>Another text node</element2>
8</root>
9XML;
10
11$dom = new DOMDocument();
12$dom->loadXML($xmlString);
13
14$element = $dom->documentElement->firstChild; // 最初の要素ノードを取得
15
16// nodeValue を使用してノードの値を読み取る (要素ノードの場合、すべての子テキストノードを連結したものが返る)
17$nodeValue = $element->nodeValue;
18echo "nodeValue: " . $nodeValue . PHP_EOL; // 出力: nodeValue: This is the text content.
19
20// textContent プロパティを使用しても同様の結果を得られる
21$textContent = $element->textContent;
22echo "textContent: " . $textContent . PHP_EOL; // 出力: textContent: This is the text content.
23
24// 空のノードを作成
25$emptyElement = $dom->createElement("emptyElement");
26$dom->documentElement->appendChild($emptyElement);
27
28// nodeValue は null を返す場合があるため、null許容型で扱う
29$emptyNodeValue = $emptyElement->nodeValue;
30if ($emptyNodeValue === null) {
31    echo "emptyNodeValue is null" . PHP_EOL; // 出力: emptyNodeValue is null
32}
33
34// textContent は空文字列を返す
35$emptyTextContent = $emptyElement->textContent;
36echo "emptyTextContent is empty: " . ($emptyTextContent === "") . PHP_EOL; // 出力: emptyTextContent is empty: 1

DOMDocumentクラスのnodeValueプロパティは、ノードの値を文字列として取得するために使用します。このプロパティは、PHP 8で利用可能です。引数はなく、戻り値はnullable string (?string)型です。

サンプルコードでは、XML文字列をDOMDocumentオブジェクトに読み込み、最初の要素ノードを取得しています。nodeValueプロパティにアクセスすることで、要素ノードに含まれるすべての子テキストノードを連結した文字列を取得できます。textContentプロパティも同様にノードのテキストコンテンツを取得できます。

重要な違いとして、空の要素ノードに対してnodeValueを呼び出した場合、nullが返ることがあります。そのため、戻り値はnullable string型として定義されています。一方、textContentプロパティは空文字列("")を返します。

nodeValueを使用する際は、nullが返る可能性を考慮し、=== nullで厳密な比較を行うようにしましょう。このようにnodeValueとtextContentは似た機能を提供しますが、空ノードに対する挙動が異なるため、状況に応じて使い分けることが重要です。

Copy
1<?php
2
3/**
4 * DOMDocument クラスと nodeValue プロパティの基本的な使用例を示します。
5 * XMLドキュメントを読み込み、特定の要素のテキストコンテンツ（nodeValue）を取得する方法を学びます。
6 *
7 * @return void
8 */
9function demonstrateNodeValueUsage(): void
10{
11    // サンプルとなるXML文字列を定義します。
12    // ここでは、本の情報を含むシンプルなXML構造を使用します。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<bookstore>
16    <book id="bk101">
17        <title lang="en">Everyday Italian</title>
18        <author>Giada De Laurentiis</author>
19        <year>2005</year>
20        <price>30.00</price>
21    </book>
22    <book id="bk102">
23        <title lang="en">Harry Potter</title>
24        <author>J.K. Rowling</author>
25        <year>2005</year>
26        <price>29.99</price>
27    </book>
28</bookstore>
29XML;
30
31    // 新しい DOMDocument オブジェクトを作成します。
32    $dom = new DOMDocument();
33    // スペースや改行を無視してXMLを整形しない設定（オプション）
34    $dom->preserveWhiteSpace = false;
35    $dom->formatOutput = true;
36
37    // XML文字列をDOMDocumentオブジェクトに読み込みます。
38    // loadXML() は成功した場合に true を、失敗した場合に false を返します。
39    if (!$dom->loadXML($xmlString)) {
40        echo "XMLの読み込みに失敗しました。\n";
41        return;
42    }
43
44    echo "--- XML ドキュメントから 'title' 要素の nodeValue を取得 ---\n\n";
45
46    // ドキュメント内のすべての 'title' 要素を取得します。
47    // getElementsByTagName() は DOMNodeList オブジェクトを返します。
48    $titles = $dom->getElementsByTagName('title');
49
50    // 取得した各 'title' 要素をループ処理し、その nodeValue を表示します。
51    foreach ($titles as $titleElement) {
52        // DOMElement (DOMNode の子クラス) の nodeValue プロパティにアクセスします。
53        // nodeValue は要素の開始タグと終了タグの間にあるテキストコンテンツを返します。
54        // PHP 8 では、このプロパティは null 許容文字列 (?string) を返します。
55        $titleValue = $titleElement->nodeValue;
56
57        // null の可能性があるため、結合時にデフォルト値を指定することで安全に出力します。
58        echo "本のタイトル: " . ($titleValue ?? 'タイトル不明') . "\n";
59    }
60
61    echo "\n--- DOMDocument オブジェクト自体の nodeValue ---\n";
62    // DOMDocument オブジェクト自体の nodeValue は、通常は空文字列または null です。
63    // ドキュメント全体に直接テキストコンテンツが存在しないため、この値はほとんどの場合役に立ちません。
64    $documentNodeValue = $dom->nodeValue;
65    echo "DOMDocument の nodeValue: ";
66    if ($documentNodeValue === null) {
67        echo "null\n";
68    } elseif ($documentNodeValue === '') {
69        echo "(空文字列)\n";
70    } else {
71        echo "'{$documentNodeValue}'\n";
72    }
73}
74
75// 上記の関数を実行し、サンプルコードの動作を確認します。
76demonstrateNodeValueUsage();

PHPのDOMDocumentクラスのnodeValueプロパティは、XMLやHTMLドキュメント内のノード（要素、属性、テキストなど）が持つテキストコンテンツの値を取得するために使用されます。特に、要素ノードに対してこのプロパティを使用すると、その要素の開始タグと終了タグの間に含まれる純粋なテキストが返されます。

このサンプルコードでは、まずシンプルなXML文字列を定義し、それをDOMDocumentオブジェクトに読み込んでいます。その後、getElementsByTagName('title')メソッドを使って、ドキュメント内のすべての<title>要素を取得しています。ループ処理の中で、各<title>要素に対して$titleElement->nodeValueとアクセスすることで、例えば「Everyday Italian」のような本のタイトルをテキストとして取り出しているのが分かります。

nodeValueプロパティには引数はなく、PHP 8では戻り値として?string、つまり文字列またはnullを返します。これは、ノードにテキストコンテンツが存在しない場合や、DOMDocumentオブジェクト自体のように直接的なテキストを持たないノードの場合にはnullが返される可能性があることを意味します。そのため、サンプルコードでは($titleValue ?? 'タイトル不明')のように、値がnullの場合に代替の文字列を表示する安全な記述をしています。

DOMDocumentオブジェクト自体に対してnodeValueプロパティにアクセスしても、通常はnullまたは空文字列が返されます。これは、ドキュメント全体が直接テキストコンテンツを持つわけではないためです。このプロパティは、主に特定の要素や属性のテキスト情報を取得する際に非常に役立ちます。