【PHP8.x】XMLReader::nodeTypeプロパティの使い方

Copy
1<?php
2
3/**
4 * Demonstrates how to use XMLReader::nodeType to identify the type of an XML node
5 * and XMLReader::nodeValue to retrieve the value associated with that node.
6 *
7 * This function parses a simple XML string and prints the type and value of each node,
8 * illustrating how these properties are used in XML processing for beginners.
9 */
10function demonstrateXmlReaderNodeProperties(): void
11{
12    // Sample XML string containing elements, text nodes, and an attribute.
13    // This will be parsed to show different node types and their values.
14    $xmlString = <<<XML
15<library>
16    <book id="php-101">
17        <title>PHP for Beginners</title>
18        <author>Alice Developer</author>
19    </book>
20    <book id="xml-guide">
21        <title>Understanding XML</title>
22        <author>Bob Coder</author>
23    </book>
24    <!-- This is a comment -->
25</library>
26XML;
27
28    $reader = new XMLReader();
29
30    // Load the XML string into the XMLReader instance.
31    if (!$reader->XML($xmlString)) {
32        echo "Error: Could not load XML string.\n";
33        return;
34    }
35
36    echo "--- XML Node Processing Starts ---\n";
37
38    // Loop through each node in the XML document until no more nodes are found.
39    while ($reader->read()) {
40        echo "---------------------------------\n";
41        echo "Current Node Name: " . $reader->name . "\n";
42        echo "Current Node Type (Integer Code): " . $reader->nodeType . "\n";
43
44        // The nodeType property returns an integer representing the type of the current node.
45        // PHP provides constants (e.g., XMLReader::ELEMENT, XMLReader::TEXT) for these integer codes.
46        $nodeTypeDescription = match ($reader->nodeType) {
47            XMLReader::ELEMENT     => 'Element Node (e.g., <tag>...</tag>)',
48            XMLReader::TEXT        => 'Text Node (actual textual content inside elements)',
49            XMLReader::WHITESPACE  => 'Whitespace Node (indentation, newlines between tags)',
50            XMLReader::CDATA       => 'CDATA Section Node',
51            XMLReader::COMMENT     => 'Comment Node (e.g., <!-- ... -->)',
52            XMLReader::END_ELEMENT => 'End Element Node (closing tag, e.g., </tag>)',
53            default                => 'Other Node Type (Code: ' . $reader->nodeType . ')',
54        };
55        echo "Node Type (Description): " . $nodeTypeDescription . "\n";
56
57        // The nodeValue property retrieves the string value of the current node.
58        // Its content varies significantly based on the nodeType:
59        // - For TEXT nodes, it contains the actual text content.
60        // - For ELEMENT nodes, it usually contains the concatenated text content of its children
61        //   (often empty or whitespace if elements only contain other elements).
62        // - For WHITESPACE nodes, it contains the whitespace characters.
63        // - For COMMENT nodes, it contains the comment's text.
64        echo "Node Value: '" . $reader->nodeValue . "'\n";
65
66        // Optional: Demonstrate reading attributes if the current node is an Element and has them.
67        if ($reader->nodeType === XMLReader::ELEMENT && $reader->hasAttributes) {
68            echo "  Attributes for '" . $reader->name . "':\n";
69            while ($reader->moveToNextAttribute()) {
70                echo "    - " . $reader->name . " = '" . $reader->value . "'\n";
71            }
72            $reader->moveToElement(); // Important: Move back to the element node after processing its attributes.
73                                     // This ensures subsequent calls to read() correctly advance to the next sibling or child.
74        }
75    }
76
77    // Close the XMLReader instance to release system resources.
78    $reader->close();
79    echo "---------------------------------\n";
80    echo "--- XML Node Processing Ends ----\n";
81}
82
83// Execute the demonstration function to see XMLReader in action.
84demonstrateXmlReaderNodeProperties();

このサンプルコードは、PHPのXMLReaderクラスを使ってXMLデータを効率的に読み込み、各ノードの種類とその値を取得する方法を示しています。

XMLReaderは、XMLファイルをノード単位で順に読み進めるためのクラスです。$reader->read()メソッドを呼び出すたびに、次のノードに移動します。

$reader->nodeTypeプロパティは、現在読み込んでいるXMLノードの種類を示す整数値を返します。この戻り値の整数は、XMLReader::ELEMENT（要素ノード、例: <tag>...</tag>)やXMLReader::TEXT（テキストノード、要素内の文字コンテンツ）のようなPHPの定数と比較することで、ノードの具体的な種類を判別できます。サンプルコードでは、この整数値から人間が理解しやすい説明に変換して表示しています。

一方、$reader->nodeValueプロパティは、現在のノードが持つ文字列値を返します。この値はノードの種類によって異なり、例えばテキストノードであれば実際のテキスト内容、コメントノードであればコメント文が格納されます。要素ノードの場合は、通常その子ノードのテキストコンテンツが連結されたものが含まれますが、多くの場合空か空白になります。

このコードでは、与えられたXML文字列をXMLReaderで解析し、ループ処理で各ノードのnodeTypeとnodeValueを出力することで、XML構造の把握や特定情報の抽出方法を具体的に理解することができます。また、要素ノードに属性が存在する場合の読み込み方も示されており、XMLデータの多岐にわたる処理の基礎を学ぶのに役立ちます。

Copy
1<?php
2
3/**
4 * Parses an XML string and outputs information about each node,
5 * specifically demonstrating the use of XMLReader::nodeType.
6 *
7 * This function helps beginners understand how to iterate through an XML
8 * document node by node and identify the type of each node encountered,
9 * which is fundamental for processing XML data or "nodelists".
10 *
11 * @param string $xmlString The XML content to parse.
12 */
13function processXmlNodesAndDisplayTypes(string $xmlString): void
14{
15    $reader = new XMLReader();
16
17    // Load the XML string into the reader
18    if (!$reader->XML($xmlString)) {
19        echo "Error: Failed to load XML string.\n";
20        return;
21    }
22
23    echo "--- Parsing XML Document ---\n";
24
25    // Loop through each node in the XML document
26    while ($reader->read()) {
27        // Get the integer value of the current node's type
28        $nodeTypeInt = $reader->nodeType;
29
30        // Map the integer node type to its human-readable constant name for clarity
31        $nodeTypeName = match ($nodeTypeInt) {
32            XMLReader::NONE                   => 'NONE',
33            XMLReader::ELEMENT                => 'ELEMENT',
34            XMLReader::ATTRIBUTE              => 'ATTRIBUTE', // Note: Attributes are not directly iterated by read()
35            XMLReader::TEXT                   => 'TEXT',
36            XMLReader::CDATA                  => 'CDATA',
37            XMLReader::ENTITY_REF             => 'ENTITY_REFERENCE',
38            XMLReader::ENTITY                 => 'ENTITY',
39            XMLReader::PI                     => 'PROCESSING_INSTRUCTION',
40            XMLReader::COMMENT                => 'COMMENT',
41            XMLReader::DOC_TYPE               => 'DOCUMENT_TYPE',
42            XMLReader::DOCUMENT               => 'DOCUMENT',
43            XMLReader::DOC_FRAGMENT           => 'DOCUMENT_FRAGMENT',
44            XMLReader::NOTATION               => 'NOTATION',
45            XMLReader::WHITESPACE             => 'WHITESPACE',
46            XMLReader::SIGNIFICANT_WHITESPACE => 'SIGNIFICANT_WHITESPACE',
47            XMLReader::END_ELEMENT            => 'END_ELEMENT',
48            XMLReader::END_ENTITY             => 'END_ENTITY',
49            XMLReader::XML_DECLARATION        => 'XML_DECLARATION',
50            default                           => 'UNKNOWN',
51        };
52
53        // Output information about the current node
54        echo sprintf(
55            "Node Type: %-25s (Integer Value: %2d), Name: '%s', Value: '%s'\n",
56            $nodeTypeName,
57            $nodeTypeInt,
58            $reader->name,    // The name of the node (e.g., tag name for elements)
59            $reader->value    // The value of the node (e.g., text content, comment text)
60        );
61    }
62
63    // Close the XMLReader to release resources
64    $reader->close();
65    echo "--- XML Parsing Finished ---\n";
66}
67
68// --- Example Usage ---
69$exampleXml = <<<XML
70<?xml version="1.0" encoding="UTF-8"?>
71<!-- This is a sample comment node -->
72<bookstore>
73    <book category="cooking">
74        <title lang="en">Everyday Italian</title>
75        <author>Giada De Laurentiis</author>
76        <price>30.00</price>
77    </book>
78    <book category="children">
79        <title lang="en">Harry Potter</title>
80        <author>J.K. Rowling</author>
81        <price>29.99</price>
82    </book>
83    <description><![CDATA[<special_chars>This & that</special_chars> is CDATA content.]]></description>
84</bookstore>
85XML;
86
87// Call the function to process the example XML string
88processXmlNodesAndDisplayTypes($exampleXml);

PHPのXMLReaderクラスは、XMLドキュメントを効率的にストリーム形式で読み込むための機能を提供します。これは、特に大きなXMLファイルを扱う際にメモリ消費を抑えるのに役立ちます。

このサンプルコードでは、XMLReaderクラスのnodeTypeプロパティを使用して、XMLドキュメント内の各ノードの種類を識別する方法を示しています。nodeTypeプロパティは、現在のノードが要素、テキスト、コメント、CDATAセクションなど、どのタイプのノードであるかを整数値で返します。このプロパティには引数はなく、戻り値は常にint型です。

コードではまず、指定されたXML文字列をXMLReaderオブジェクトに読み込みます。次に、read()メソッドを使ってXMLドキュメントをノードごとに順次処理していきます。ループの中で$reader->nodeTypeを用いて現在のノードタイプを取得し、その整数値を対応する定数名に変換して表示しています。これにより、各ノードの具体的な種類だけでなく、その名前や値も合わせて確認できます。

この方法は、XMLデータを解析し、特定の種類のノード（例えば、特定のタグを持つ要素やテキストコンテンツなど）を効率的に見つけて処理する際の基本的なアプローチとなります。XMLの「ノードリスト」を扱う上で、各ノードのタイプを正確に判別することは、適切な処理ロジックを実装するために不可欠です。システムエンジニアを目指す方にとって、XMLの構造を理解し、個々のノードをプログラムで識別する基礎を学ぶ上で非常に有用な例となります。