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

Copy
1<?php
2
3/**
4 * XML_OPTION_SKIP_WHITE 定数の動作とXMLWriterの利用を示すサンプルコードです。
5 *
6 * この関数は、XMLWriterを使用して整形されたXML文字列を生成します。
7 * その後、生成したXMLをPHPのSAXパーサーで解析する際、
8 * XML_OPTION_SKIP_WHITE オプションを設定した場合と設定しない場合で
9 * パース結果がどのように異なるかを示します。
10 *
11 * XML_OPTION_SKIP_WHITE 定数は、XMLパーサーがXML要素間の空白文字
12 * （改行、タブ、スペースなど）をデータノードとしてスキップするかどうかを制御します。
13 * これを設定することで、構造的なデータのみを抽出しやすくなります。
14 * XMLWriterはXMLを書き出すための拡張であり、XML_OPTION_SKIP_WHITEはXMLを読み込む際のオプションです。
15 * このサンプルでは、両者を組み合わせて動作の違いを明確に示します。
16 */
17function demonstrateXmlProcessingWithOptions(): void
18{
19    echo "--- 1. XMLWriterを使用してXMLを生成 ---\n";
20
21    // XMLWriterインスタンスを作成し、メモリにXMLを書き込む設定にする
22    $xmlWriter = new XMLWriter();
23    $xmlWriter->openMemory();
24    // 出力XMLを見やすくするためにインデントを有効にする
25    $xmlWriter->setIndent(true);
26    $xmlWriter->setIndentString('  '); // インデントに使う文字を指定
27
28    // XML文書の開始
29    $xmlWriter->startDocument('1.0', 'UTF-8');
30    $xmlWriter->startElement('root');
31        $xmlWriter->startElement('item');
32            $xmlWriter->writeAttribute('id', '1');
33            $xmlWriter->writeElement('name', 'Apple');
34        $xmlWriter->endElement(); // item
35        $xmlWriter->startElement('item');
36            $xmlWriter->writeAttribute('id', '2');
37            $xmlWriter->writeElement('name', 'Banana');
38        $xmlWriter->endElement(); // item
39    $xmlWriter->endElement(); // root
40    $xmlWriter->endDocument();
41
42    // 生成されたXML文字列を取得
43    $xmlString = $xmlWriter->outputMemory();
44    echo "生成されたXML:\n";
45    echo htmlspecialchars($xmlString); // HTML特殊文字をエスケープして表示
46    echo "\n\n";
47
48    echo "--- 2. XML_OPTION_SKIP_WHITE を設定しない場合のパース結果 ---\n";
49
50    // XMLパーサーを作成
51    $parserNoSkip = xml_parser_create();
52    // XML文字列をパースし、要素の情報を配列に格納
53    // この場合、要素間の改行やインデントも「空白ノード」として検出されます
54    xml_parse_into_struct($parserNoSkip, $xmlString, $valuesNoSkip, $indexNoSkip);
55    xml_parser_free($parserNoSkip); // パーサーのリソースを解放
56
57    echo "検出された要素の総数: " . count($valuesNoSkip) . "\n";
58    echo "主要な要素と空白ノードのリスト:\n";
59    foreach ($valuesNoSkip as $val) {
60        if (isset($val['tag'])) {
61            // 通常のタグ付き要素
62            echo "  TAG: " . $val['tag'] . ", TYPE: " . $val['type'];
63            if (isset($val['value'])) {
64                // 空白文字を見える化するためエスケープして表示
65                echo ", VALUE: '" . str_replace(["\n", "\r", "\t"], ['\\n', '\\r', '\\t'], $val['value']) . "'";
66            }
67            echo "\n";
68        } elseif ($val['type'] === 'cdata' && trim($val['value']) === '') {
69            // XML_OPTION_SKIP_WHITE を設定しない場合に検出される空白ノード (CDATAタイプ)
70            echo "  TAG: (空白ノード), TYPE: CDATA, VALUE: '[改行・インデント]' \n";
71        }
72    }
73    echo "\n";
74
75    echo "--- 3. XML_OPTION_SKIP_WHITE を設定した場合のパース結果 ---\n";
76
77    // XMLパーサーを作成
78    $parserSkipWhite = xml_parser_create();
79    // XML_OPTION_SKIP_WHITE を true に設定し、要素間の空白ノードをスキップする
80    xml_set_option($parserSkipWhite, XML_OPTION_SKIP_WHITE, true);
81    // XML文字列をパース
82    xml_parse_into_struct($parserSkipWhite, $xmlString, $valuesSkipWhite, $indexSkipWhite);
83    xml_parser_free($parserSkipWhite); // パーサーのリソースを解放
84
85    echo "検出された要素の総数: " . count($valuesSkipWhite) . "\n";
86    echo "主要な要素のリスト (空白ノードはスキップ):\n";
87    foreach ($valuesSkipWhite as $val) {
88        if (isset($val['tag'])) {
89            // 空白ノードがスキップされるため、タグ付き要素のみが表示されます
90            echo "  TAG: " . $val['tag'] . ", TYPE: " . $val['type'];
91            if (isset($val['value'])) {
92                echo ", VALUE: '" . str_replace(["\n", "\r", "\t"], ['\\n', '\\r', '\\t'], $val['value']) . "'";
93            }
94            echo "\n";
95        }
96    }
97    echo "\n";
98}
99
100// 関数を実行して動作を確認します
101demonstrateXmlProcessingWithOptions();

このPHPサンプルコードは、XMLWriter拡張機能を使ってXML文字列を生成し、そのXML文字列をPHPのSAXパーサーで解析する際のXML_OPTION_SKIP_WHITE定数の動作を実演します。

まず、XMLWriterクラスを利用して整形されたXMLドキュメントをメモリ上に効率的に構築します。setIndent(true)でインデントを有効にすることで、人間が読みやすい形式のXMLが生成されます。

次に、生成したXMLをxml_parser_create()で作成したXMLパーサーで解析します。一つ目の解析では、XML_OPTION_SKIP_WHITE定数を設定せずにxml_parse_into_struct()関数でXML構造を抽出します。この場合、XML要素間の改行やスペースといった空白文字もデータノードとして検出されるため、多くの要素がパース結果に含まれます。

二つ目の解析では、xml_set_option()関数を使ってXML_OPTION_SKIP_WHITE定数をtrueに設定し、再度同じXMLをパースします。XML_OPTION_SKIP_WHITEは、XMLパーサーが要素間の空白文字（改行、タブ、スペースなど）を無視してスキップするかどうかを制御する定数です。引数を持たず、ブール値（true/false）をオプションとして設定します。これにより、パース結果から空白ノードが除外され、純粋なデータ要素のみが抽出されるため、取得される要素の数が大幅に減少します。

このサンプルは、XML_OPTION_SKIP_WHITE定数を利用することで、XMLデータの解析時に不要な空白ノードを排除し、構造的なデータのみを効率的に処理できることを示しています。この定数自体は戻り値を持ちませんが、xml_set_option()によってパーサーの動作を変更する役割を果たします。

Copy
1<?php
2
3/**
4 * XML文字列をパースし、XML_OPTION_SKIP_WHITE オプションの効果を示す関数。
5 *
6 * この関数は、XML_OPTION_SKIP_WHITE オプションを適用してXMLを解析し、
7 * 不要な空白ノード（主にインデントや改行）がスキップされることを示します。
8 * これは、XMLを構造化されたPHPデータに変換（デシリアライズ）する際に、
9 * 解析結果を簡潔にするのに役立ちます。
10 *
11 * @param string $xmlString 解析するXML文字列。
12 * @return array 解析された構造体の配列。
13 * @throws RuntimeException XML解析に失敗した場合。
14 */
15function parseXmlWithSkipWhiteOption(string $xmlString): array
16{
17    // XMLパーサーを作成します。
18    $parser = xml_parser_create();
19
20    // XML_OPTION_SKIP_WHITE を true に設定します。
21    // このオプションを true に設定すると、XML要素間の空白文字（スペース、タブ、改行など）が
22    // テキストノードとして認識されなくなり、解析結果がよりシンプルになります。
23    // 例えば、XMLのインデントに使われる空白が、データとして不要な場合に役立ちます。
24    xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, true);
25
26    // XML文字列を解析し、構造体の配列に変換します。
27    // $values には要素のデータが、$index には要素のインデックスが格納されます。
28    $values = [];
29    $index = [];
30    if (!xml_parse_into_struct($parser, $xmlString, $values, $index)) {
31        // 解析に失敗した場合のエラー処理
32        $errorCode = xml_get_error_code($parser);
33        $errorString = xml_error_string($errorCode);
34        $line = xml_get_current_line_number($parser);
35        xml_parser_free($parser); // エラー時もパーサーを解放
36        throw new RuntimeException("XML解析エラー: {$errorString} (行: {$line})");
37    }
38
39    // パーサーを解放します。
40    xml_parser_free($parser);
41
42    return $values;
43}
44
45// サンプルXMLデータ
46// インデントや改行を含む、一般的なXML構造です。
47$sampleXml = <<<XML
48<root>
49    <item id="1">
50        <name>Product A</name>
51        <price>100</price>
52    </item>
53    <item id="2">
54        <name>Product B</name>
55        <price>200</price>
56    </item>
57</root>
58XML;
59
60// XML_OPTION_SKIP_WHITE オプションを適用してXMLを解析し、結果を表示します。
61echo "--- XML_OPTION_SKIP_WHITE を true に設定してXMLを解析 ---" . PHP_EOL;
62try {
63    $parsedData = parseXmlWithSkipWhiteOption($sampleXml);
64
65    // 解析結果の概要を表示します。
66    // XML_OPTION_SKIP_WHITE の効果により、インデントなどの空白がノードとして
67    // 含まれていないことが分かります。
68    foreach ($parsedData as $node) {
69        echo "Tag: " . $node['tag'];
70        if (isset($node['type'])) {
71            echo ", Type: " . $node['type'];
72        }
73        if (isset($node['value'])) {
74            // 要素内の値の前後にある空白はスキップされないため、trimで整形して表示します。
75            echo ", Value: '" . trim($node['value']) . "'";
76        }
77        if (isset($node['attributes'])) {
78            echo ", Attributes: " . json_encode($node['attributes']);
79        }
80        echo PHP_EOL;
81    }
82} catch (RuntimeException $e) {
83    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
84}
85
86// (参考) XML_OPTION_SKIP_WHITE を設定しない場合 (または false に設定する場合) は、
87// インデントの空白も 'character' タイプなどのノードとして解析結果に含まれることがあります。
88// このオプションは、XMLをPHPデータにデシリアライズする際に、本当に必要なデータのみを抽出しやすくするために利用されます。
89

このサンプルコードは、PHPでXMLデータを解析する際に、不要な空白ノードを無視するためのXML_OPTION_SKIP_WHITE定数の利用方法を示しています。この定数は、XMLパーサーのオプションとして使用され、XML要素間の空白文字（スペース、タブ、改行など）を解析結果からスキップするかどうかを制御します。

具体的には、XML_OPTION_SKIP_WHITEをtrueに設定すると、XMLのインデントや改行といった、構造を視覚的に整えるための空白が、データとして意味を持たない余分なテキストノードとして扱われなくなります。これにより、XMLをPHPのデータ構造に変換（デシリアライズ）する際に、解析結果が簡潔になり、本当に必要なデータのみを効率的に抽出できるようになります。

サンプルコード内のparseXmlWithSkipWhiteOption関数は、引数として解析したいXML文字列を受け取ります。この関数は、まずxml_parser_create()でXMLパーサーを初期化し、その後xml_parser_set_option()関数を用いてパーサーにXML_OPTION_SKIP_WHITEオプションをtrueに設定します。そして、xml_parse_into_struct()関数でXML文字列をPHPの配列構造に変換し、その結果を戻り値として返します。XML解析に失敗した場合はRuntimeExceptionを発生させます。最後にxml_parser_free()でパーサーを解放しています。このオプションは、XMLから構造化されたデータをシンプルに取得したい場合に非常に有用です。