【PHP8.x】XMLReader::SIGNIFICANT_WHITESPACE定数の使い方

Copy
1<?php
2
3/**
4 * XMLReader::SIGNIFICANT_WHITESPACE 定数の動作を示すサンプルコードです。
5 * この定数は、XMLReaderがXML構造内の「意味のある空白」(例: 要素間の改行やインデント)
6 * をノードとして報告するかどうかを制御します。
7 */
8function demonstrateXmlReaderSignificantWhitespace(): void
9{
10    // 処理するXMLデータ
11    $xmlString = <<<XML
12<root>
13    <item>Value 1</item>
14    <item2>  Value 2  </item2>
15</root>
16XML;
17
18    echo "--- XMLReader::SIGNIFICANT_WHITESPACE (デフォルト: true) の場合 ---\n";
19    $reader = new XMLReader();
20    $reader->xml($xmlString);
21
22    // デフォルト設定では、XMLの構造を保つための空白 (改行、インデントなど) も
23    // NodeType 14 (XMLReader::WHITESPACE) として報告されます。
24    while ($reader->read()) {
25        echo "NodeType: " . $reader->nodeType . ", Name: " . $reader->name . ", Value: '" . substr($reader->value, 0, 20) . "'\n";
26    }
27    $reader->close();
28    echo "\n";
29
30    echo "--- XMLReader::SIGNIFICANT_WHITESPACE (false に設定) の場合 ---\n";
31    $reader = new XMLReader();
32    $reader->xml($xmlString);
33
34    // XMLReader::SIGNIFICANT_WHITESPACE を false に設定すると、
35    // DTDやスキーマで意味がないと判断される要素間の空白ノードはスキップされます。
36    // これにより、XMLの純粋なコンテンツノードに集中しやすくなります。
37    //
38    // 注意: 要素内の空白 (例: <item2> の "  Value 2  ") はテキストノードの一部であり、
39    // この設定でスキップされることはありません。
40    $reader->setParserProperty(XMLReader::SIGNIFICANT_WHITESPACE, false);
41
42    while ($reader->read()) {
43        echo "NodeType: " . $reader->nodeType . ", Name: " . $reader->name . ", Value: '" . substr($reader->value, 0, 20) . "'\n";
44    }
45    $reader->close();
46}
47
48// 関数を実行して動作を確認します
49demonstrateXmlReaderSignificantWhitespace();
50

XMLReader::SIGNIFICANT_WHITESPACEは、PHPのXMLReaderクラスで利用される定数です。この定数は、XMLReaderがXMLドキュメントを解析する際、「意味のある空白」（例：要素間の改行やインデントなど、XMLの構造を整形するための空白）をノードとして認識し報告するかどうかを制御します。定数であるため、引数や戻り値はありません。

サンプルコードでは、この定数をXMLReaderオブジェクトのパーサープロパティとして設定し、その動作の違いを示しています。デフォルト設定（true相当）の場合、XMLの整形に使われる空白もXMLReader::WHITESPACE（NodeType 14）のようなノードとして報告されます。これにより、XMLドキュメントの物理的な構造を細かく追跡できます。

一方、XMLReader::SIGNIFICANT_WHITESPACEをfalseに設定すると、DTDやスキーマで意味がないと判断される要素間の空白ノードはスキップされます。この設定により、XMLの純粋なコンテンツや主要な構造に集中しやすくなり、不必要な空白ノードの処理を削減できます。

ただし、注意点として、<item2> Value 2 </item2>のように要素の内部に含まれる空白（例：「Value 2」の前後にある空白）は、テキストノードの一部として扱われるため、この設定に関わらずスキップされません。この定数は、要素間の構造的な空白に影響を与えることを理解し、XMLデータの用途に応じて適切に設定することが重要です。

Copy
1<?php
2
3/**
4 * XMLReader を使用してXMLドキュメントを読み込み、
5 * ノードタイプ、特に XMLReader::SIGNIFICANT_WHITESPACE 定数で示される
6 * 「有意な空白」ノードを識別するサンプル関数です。
7 *
8 * XMLReader::SIGNIFICANT_WHITESPACE は、XMLパーサーがDTDやxml:space="preserve"属性に基づいて
9 * XMLドキュメント内で意味を持つ空白と判断したノードのタイプを示します。
10 * この関数は、そのような空白を検出する方法を実演します。
11 *
12 * @param string $xmlString 処理するXML文字列。
13 */
14function identifyXmlNodeTypes(string $xmlString): void
15{
16    // XMLReader オブジェクトを初期化
17    $reader = new XMLReader();
18
19    // XML文字列をリーダーに設定。失敗した場合はエラーを出力して終了。
20    if (!$reader->xml($xmlString)) {
21        echo "エラー: XML文字列をロードできませんでした。\n";
22        return;
23    }
24
25    echo "--- XML解析開始 ---\n";
26    echo "対象XML:\n" . $xmlString . "\n\n";
27
28    // ドキュメント内の各ノードを順次読み進める
29    while ($reader->read()) {
30        $nodeType = $reader->nodeType; // 現在のノードのタイプ (XMLReader::ELEMENT など)
31        $nodeName = $reader->name;     // 現在のノードの名前 (要素名、属性名など)
32        $nodeValue = $reader->value;   // 現在のノードの値 (テキストコンテンツなど)
33
34        // ノードタイプが XMLReader::SIGNIFICANT_WHITESPACE かどうかをチェック
35        // これは、XMLパーサーが特別な意味を持つと判断した空白文字です。
36        if ($nodeType === XMLReader::SIGNIFICANT_WHITESPACE) {
37            echo ">>> 【検出】 SIGNIFICANT_WHITESPACE ノード <<< \n";
38            echo "  名前: '{$nodeName}'\n";
39            echo "  値  : '" . addcslashes($nodeValue, "\n\r\t") . "'\n"; // 改行などをエスケープして表示
40            echo "--------------------------------------------------\n";
41        } elseif ($nodeType === XMLReader::WHITESPACE) {
42            // 通常の空白ノードの場合
43            echo "通常の WHITESPACE ノードを検出しました。\n";
44            echo "  名前: '{$nodeName}'\n";
45            echo "  値  : '" . addcslashes($nodeValue, "\n\r\t") . "'\n";
46            echo "--------------------------------------------\n";
47        } else {
48            // その他のノードタイプを表示 (理解を助けるため)
49            echo "ノードタイプ: " . getNodeTypeName($nodeType) . "\n";
50            echo "  名前: '{$nodeName}'\n";
51            echo "  値  : '" . addcslashes($nodeValue, "\n\r\t") . "'\n";
52            echo "--------------------------------------------\n";
53        }
54    }
55
56    // XMLReader のリソースを解放
57    $reader->close();
58    echo "\n--- XML解析終了 ---\n";
59}
60
61/**
62 * XMLReader のノードタイプを示す整数値に対応する定数名を取得する補助関数。
63 * システムエンジニアを目指す初心者の理解を助けるためのものです。
64 *
65 * @param int $type XMLReader ノードタイプを示す整数値。
66 * @return string ノードタイプの定数名。
67 */
68function getNodeTypeName(int $type): string
69{
70    $typeMap = [
71        XMLReader::NONE => 'NONE',
72        XMLReader::ELEMENT => 'ELEMENT',
73        XMLReader::ATTRIBUTE => 'ATTRIBUTE',
74        XMLReader::TEXT => 'TEXT',
75        XMLReader::CDATA => 'CDATA',
76        XMLReader::ENTITY_REF => 'ENTITY_REF',
77        XMLReader::ENTITY => 'ENTITY',
78        XMLReader::PI => 'PROCESSING_INSTRUCTION',
79        XMLReader::COMMENT => 'COMMENT',
80        XMLReader::DTD => 'DTD',
81        XMLReader::DOC_TYPE => 'DOC_TYPE',
82        XMLReader::DOCUMENT => 'DOCUMENT',
83        XMLReader::DOC_FRAGMENT => 'DOC_FRAGMENT',
84        XMLReader::NOTATION => 'NOTATION',
85        XMLReader::WHITESPACE => 'WHITESPACE',
86        XMLReader::SIGNIFICANT_WHITESPACE => 'SIGNIFICANT_WHITESPACE', // 目的の定数
87        XMLReader::END_ELEMENT => 'END_ELEMENT',
88        XMLReader::END_ENTITY => 'END_ENTITY',
89        XMLReader::XML_DECLARATION => 'XML_DECLARATION',
90    ];
91
92    return $typeMap[$type] ?? 'UNKNOWN_TYPE (' . $type . ')';
93}
94
95// サンプルXML文字列
96// xml:space="preserve" 属性が設定された要素内の空白は、
97// パーサーによっては XMLReader::SIGNIFICANT_WHITESPACE として識別されることがあります。
98// ただし、環境やlibxmlのバージョンにより、必ずしもこのノードタイプとして検出されるとは限りません。
99$sampleXml = <<<XML
100<?xml version="1.0" encoding="UTF-8"?>
101<root>
102    <item>   Hello World!   </item>
103    <preformatted_content xml:space="preserve">
104        This is
105        pre-formatted
106        text.
107    </preformatted_content>
108    <another_item>  Another  text.  </another_item>
109</root>
110XML;
111
112// サンプル関数を実行してXMLを解析
113identifyXmlNodeTypes($sampleXml);
114
115?>

このサンプルコードは、PHPのXMLReader拡張機能を利用してXMLドキュメントを読み込み、XMLReader::SIGNIFICANT_WHITESPACE定数で識別される「有意な空白」ノードを検出する方法を示すものです。XMLReader::SIGNIFICANT_WHITESPACEは、XMLパーサーがDTDやxml:space="preserve"属性などに基づいて、XMLデータ内で意味を持つと判断した空白文字（スペース、タブ、改行など）のタイプを示します。これは、レイアウト目的の通常の空白（XMLReader::WHITESPACE）とは区別されます。

identifyXmlNodeTypes関数は、対象のXML文字列を引数として受け取り、XMLReaderオブジェクトを使ってXMLノードを順次解析します。そして、現在のノードのタイプがXMLReader::SIGNIFICANT_WHITESPACEであるかを確認し、検出した場合にはその情報を出力します。これにより、XMLデータ構造において内容の一部と見なされる空白を識別し、アプリケーションで適切に扱えるようになります。この関数の戻り値はvoidであり、具体的な値を返しません。定数XMLReader::SIGNIFICANT_WHITESPACE自体は引数を持たず、特定の値を意味する識別子として機能します。