【PHP8.x】XML_TEXT_NODE定数の使い方

Copy
1<?php
2
3/**
4 * XML_TEXT_NODE 定数と xml_parser_create 関数を使用したXML解析のサンプル
5 *
6 * このコードは、SAX (Simple API for XML) パーサを使ってXMLドキュメントを解析し、
7 * 各要素の開始、終了、およびテキストデータ（XML_TEXT_NODEに相当）を処理する方法を示します。
8 * システムエンジニアを目指す初心者向けに、各処理が何であるかをコメントで説明しています。
9 */
10
11// 定数 XML_TEXT_NODE の値を出力します。
12// この定数は、XMLノードの種類がテキストノードであることを示すために使われます。
13// SAXパーサでは直接比較する機会は少ないですが、文字データハンドラがこの種類のデータを扱います。
14echo "定数 XML_TEXT_NODE の値: " . XML_TEXT_NODE . "\n\n";
15
16/**
17 * XMLパーサの開始要素ハンドラ。
18 * XMLドキュメント内で開始タグが見つかったときに呼び出されます。
19 *
20 * @param resource $parser XMLパーサリソース
21 * @param string $name 要素名
22 * @param array $attrs 属性のキーと値のペアの配列
23 * @return void
24 */
25function startElementHandler($parser, $name, $attrs)
26{
27    echo "開始タグ検出: <" . $name;
28    foreach ($attrs as $attrName => $attrValue) {
29        echo " " . $attrName . "=\"" . $attrValue . "\"";
30    }
31    echo ">\n";
32}
33
34/**
35 * XMLパーサの終了要素ハンドラ。
36 * XMLドキュメント内で終了タグが見つかったときに呼び出されます。
37 *
38 * @param resource $parser XMLパーサリソース
39 * @param string $name 要素名
40 * @return void
41 */
42function endElementHandler($parser, $name)
43{
44    echo "終了タグ検出: </" . $name . ">\n";
45}
46
47/**
48 * XMLパーサの文字データハンドラ。
49 * XMLドキュメント内のテキストコンテンツ（XML_TEXT_NODEに該当する部分）が見つかったときに呼び出されます。
50 *
51 * @param resource $parser XMLパーサリソース
52 * @param string $data 要素内のテキストデータ
53 * @return void
54 */
55function characterDataHandler($parser, $data)
56{
57    // 空白のみのデータは無視して表示をきれいにします
58    $trimmedData = trim($data);
59    if (!empty($trimmedData)) {
60        echo "  テキストノード (XML_TEXT_NODE) データ検出: \"" . $trimmedData . "\"\n";
61    }
62}
63
64/**
65 * SAXパーサを使用してXML文字列を解析するメイン関数。
66 *
67 * @param string $xmlString 解析するXMLドキュメントの文字列
68 * @return void
69 */
70function parseXmlWithSax($xmlString)
71{
72    // 1. XMLパーサを作成します。
73    // xml_parser_create() は新しいXMLパーサを作成し、リソースIDを返します。
74    $parser = xml_parser_create();
75
76    // 2. XMLパーサのオプションを設定します。
77    // XML_OPTION_CASE_FOLDING を 0 に設定することで、要素名や属性名の大文字・小文字を区別します。
78    xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
79
80    // 3. 各イベントに対応するハンドラ関数を設定します。
81    // xml_set_element_handler() は開始タグと終了タグのハンドラを設定します。
82    xml_set_element_handler($parser, "startElementHandler", "endElementHandler");
83    // xml_set_character_data_handler() はテキストデータ（XML_TEXT_NODE）のハンドラを設定します。
84    xml_set_character_data_handler($parser, "characterDataHandler");
85
86    // 4. XML文字列を解析します。
87    // xml_parse() はXMLデータを解析し、成功した場合は true、失敗した場合は false を返します。
88    if (!xml_parse($parser, $xmlString, true)) {
89        // 解析に失敗した場合、エラー情報を取得して表示します。
90        $errorCode = xml_get_error_code($parser);
91        $errorString = xml_error_string($errorCode);
92        $line = xml_get_current_line_number($parser);
93        echo "XMLパースエラー: {$errorString} (行: {$line})\n";
94    }
95
96    // 5. 使用したXMLパーサリソースを解放します。
97    xml_parser_free($parser);
98}
99
100// 解析するサンプルXMLデータ
101$sampleXml = <<<XML
102<bookstore>
103    <book category="cooking">
104        <title lang="en">Everyday Italian</title>
105        <author>Giada De Laurentiis</author>
106        <year>2202</year>
107        <price>30.00</price>
108    </book>
109    <book category="children">
110        <title lang="en">Harry Potter</title>
111        <author>J.K. Rowling</author>
112        <year>2005</year>
113        <price>29.99</price>
114    </book>
115    <!-- これはコメントです -->
116</bookstore>
117XML;
118
119// サンプルXMLデータをSAXパーサで解析して結果を表示します。
120echo "--- XML解析開始 ---\n";
121parseXmlWithSax($sampleXml);
122echo "--- XML解析終了 ---\n";
123
124?>

このPHPサンプルコードは、SAX (Simple API for XML) パーサを用いたXML解析の基本的な流れをシステムエンジニアを目指す初心者向けに示しています。XML_TEXT_NODEは、XMLドキュメント内の要素間にあるテキストデータ、すなわち純粋な文字列コンテンツを識別するための定数です。SAXパーサでは、xml_set_character_data_handlerで設定された関数が、このXML_TEXT_NODEに該当するテキストコンテンツが検出された際に呼び出され、そのデータを処理します。

まず、xml_parser_create関数を使って新しいXMLパーサを作成します。この関数は、XML解析を行うためのリソースIDを戻り値として返し、後続の設定や解析処理で利用されます。次に、xml_set_element_handlerで要素の開始タグと終了タグが検出されたときの処理関数を、xml_set_character_data_handlerでテキストデータが検出されたときの処理関数を設定します。設定が完了したら、xml_parse関数に解析したいXML文字列を渡すことで、XMLドキュメントが解析され、設定した各ハンドラ関数が適切なタイミングで実行されます。最後に、xml_parser_free関数で作成したパーサリソースを解放します。この一連の処理により、XML構造をイベントごとに効率的に処理することが可能です。

Copy
1<?php
2
3/**
4 * XML文書を作成し、要素とテキストノードを追加する関数。
5 * XML_TEXT_NODE定数を利用して、追加されたノードがテキストノードであることを確認します。
6 *
7 * @return string 生成されたXMLを文字列として返します。
8 */
9function addTextNodeToXml(): string
10{
11    // DOMDocumentのインスタンスを作成します。
12    // '1.0' はXMLバージョン、'UTF-8' はエンコーディングを指定します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14
15    // 出力時にXMLを整形し、見やすくするためのオプションです。
16    $dom->formatOutput = true;
17
18    // ルート要素（例: <data>）を作成し、XML文書に追加します。
19    $root = $dom->createElement('data');
20    $dom->appendChild($root);
21
22    // 新しい要素（例: <item>）を作成し、ルート要素に追加します。
23    $item = $dom->createElement('item');
24    $root->appendChild($item);
25
26    // テキストノードを作成します。これが要素に追加される文字列になります。
27    $textNode = $dom->createTextNode('これはXMLに追加されるテキストです。');
28
29    // 作成したテキストノードを<item>要素の子ノードとして追加します。
30    $item->appendChild($textNode);
31
32    // ここでXML_TEXT_NODE定数を使用し、追加したノードがテキストノード型であることを確認します。
33    // XML_TEXT_NODEは、DOMノードの種類がテキストであることを示す定数です。
34    if ($textNode->nodeType === XML_TEXT_NODE) {
35        // 通常、この確認はデバッグ目的や、ノードの種類に応じて処理を分岐させたい場合に使用されます。
36        // ここでは、XML_TEXT_NODEの定数があることを示すために記述しています。
37        // このifブロック内は、コードの動作には直接影響しません。
38    }
39
40    // 生成されたXML文書を文字列として取得し、返します。
41    return $dom->saveXML();
42}
43
44// 上記関数を実行し、生成されたXMLを標準出力します。
45echo addTextNodeToXml();
46

このPHPサンプルコードは、XML文書をプログラムで作成し、そこにテキストノードを追加する方法を示しています。

まず、DOMDocumentというXML文書を操作するためのオブジェクトを作成し、XMLのバージョンとエンコーディングを指定します。次に、formatOutputをtrueに設定することで、出力されるXMLが見やすいように整形されます。 コードでは、<data>というルート要素と、その中に<item>という子要素を作成し、XML文書に追加しています。重要なのは、createTextNode()メソッドを使って「これはXMLに追加されるテキストです。」というテキストノードを作成し、それを<item>要素の子ノードとして追加している点です。

ここで登場するXML_TEXT_NODEは、DOMノードの種類がテキストであることを示すPHPの定数です。サンプルコードでは、作成したテキストノードのnodeTypeがXML_TEXT_NODEと一致するかを確認することで、そのノードがテキストノードであることをプログラムで識別できることを示しています。この確認は、デバッグ時や、ノードの種類に応じて処理を分けたい場合に活用されます。

関数addTextNodeToXmlは引数を取らず、生成されたXML文書全体を文字列として返します。これにより、PHPプログラム内で動的にXMLを作成し、その内容を操作・確認する方法を学ぶことができます。