【PHP8.x】xml_parser_set_option()関数の使い方

Copy
1<?php
2
3/**
4 * XMLパーサーを使用してXMLデータを解析し、その階層構造を追跡するサンプル。
5 *
6 * xml_parser_set_option() を使用してパーサーの設定を行い、
7 * 要素の開始/終了イベントでXMLの階層レベルを表示します。
8 * キーワード "addchild" は通常、XMLドキュメントに新しい子要素を追加する操作を指しますが、
9 * xml_parser_set_option() はXMLの解析設定を行う関数であり、直接の「追加」操作は行いません。
10 * このサンプルでは、xml_parser_set_option() の使い方を示しつつ、
11 * XMLの「階層構造」への関心を満たすように、解析中に要素の親子関係を可視化します。
12 *
13 * @param string $xmlString 解析するXML文字列。
14 */
15function parseXmlAndTrackHierarchy(string $xmlString): void
16{
17    // 1. XMLパーサーを作成します。
18    // 'UTF-8' はXMLデータのエンコーディングを指定します。
19    $parser = xml_parser_create('UTF-8');
20
21    if (!$parser) {
22        echo "エラー: XMLパーサーの作成に失敗しました。\n";
23        return;
24    }
25
26    // 2. xml_parser_set_option() を使用してパーサーのオプションを設定します。
27    // XML_OPTION_CASE_FOLDING を false に設定すると、要素名や属性名が元のケースを維持します。
28    // (デフォルトは true で、大文字に変換されます。)
29    if (!xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false)) {
30        echo "エラー: パーサーオプションの設定に失敗しました。\n";
31        xml_parser_free($parser); // エラーが発生した場合はリソースを解放します。
32        return;
33    }
34
35    // 現在のXML階層レベルを追跡するための変数
36    $currentDepth = 0;
37
38    // 3. 要素の開始タグと終了タグが検出されたときのハンドラ関数を設定します。
39    // PHP 8 の記法で、匿名関数 (クロージャ) と use を使用して $currentDepth 変数を参照します。
40    xml_set_element_handler(
41        $parser,
42        // 開始タグハンドラ
43        function (XMLParser $parser, string $name, array $attribs) use (&$currentDepth) {
44            $currentDepth++;
45            echo str_repeat('  ', $currentDepth - 1) . "開始: <{$name}>";
46            if (!empty($attribs)) {
47                // 属性がある場合は表示
48                $formattedAttribs = array_map(fn($k, $v) => "{$k}=\"{$v}\"", array_keys($attribs), $attribs);
49                echo ' (属性: ' . implode(', ', $formattedAttribs) . ')';
50            }
51            echo "\n";
52        },
53        // 終了タグハンドラ
54        function (XMLParser $parser, string $name) use (&$currentDepth) {
55            echo str_repeat('  ', $currentDepth - 1) . "終了: </{$name}>\n";
56            $currentDepth--;
57        }
58    );
59
60    // 4. 文字データ（要素間のテキスト）が検出されたときのハンドラ関数を設定します。
61    xml_set_character_data_handler(
62        $parser,
63        function (XMLParser $parser, string $data) use (&$currentDepth) {
64            $trimmedData = trim($data);
65            if (!empty($trimmedData)) {
66                echo str_repeat('  ', $currentDepth) . "データ: \"{$trimmedData}\"\n";
67            }
68        }
69    );
70
71    // 5. XML文字列を解析します。
72    // 第2引数は解析するXMLデータ、第3引数はこれがデータの最後のブロックであるかを示します。
73    if (!xml_parse($parser, $xmlString, true)) {
74        // 解析中にエラーが発生した場合
75        $errorCode = xml_get_error_code($parser);
76        $errorString = xml_error_string($errorCode);
77        $line = xml_get_current_line_number($parser);
78        $column = xml_get_current_column_number($parser);
79        echo "XML解析エラー: {$errorString} (行: {$line}, カラム: {$column})\n";
80    }
81
82    // 6. パーサーのリソースを解放します。
83    xml_parser_free($parser);
84}
85
86// 実際に解析するサンプルXMLデータ
87$sampleXml = <<<EOT
88<?xml version="1.0" encoding="UTF-8"?>
89<bookstore>
90    <book category="cooking">
91        <title lang="en">Everyday Italian</title>
92        <author>Giada De Laurentiis</author>
93        <year>2005</year>
94        <price>30.00</price>
95    </book>
96    <book category="children">
97        <title lang="en">Harry Potter</title>
98        <author>J.K. Rowling</author>
99        <year>2005</year>
100        <price>29.99</price>
101    </book>
102</bookstore>
103EOT;
104
105// 定義した関数を実行してXMLを解析します。
106parseXmlAndTrackHierarchy($sampleXml);

このサンプルコードは、PHPのxml_parser_set_option()関数を用いてXMLパーサーの動作を設定し、XMLデータを解析する過程でその階層構造を追跡する方法を示しています。xml_parser_set_option()は、第一引数で指定したXMLパーサーに対して、第二引数のオプション種類（int $option）とその設定値（mixed $value）を適用する関数です。オプション設定が成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。

このコードでは、XML_OPTION_CASE_FOLDINGオプションをfalseに設定することで、XMLの要素名や属性名が解析中に大文字に変換されず、元のケース（大文字・小文字）を保持するようにパーサーを設定しています。これにより、XMLの記述通りの名前で要素を扱うことが可能になります。

コードの流れとしては、まずxml_parser_create()でXMLパーサーを作成し、その後xml_parser_set_option()で上記の設定を行います。続いて、xml_set_element_handler()などを使って、XMLの要素の開始・終了時や文字データが検出された際に実行する処理（ハンドラ関数）を登録します。これらのハンドラは、解析中にXMLの階層レベルをインデントで表示し、要素の親子関係を視覚的に分かりやすく表現します。最後に、xml_parse()で実際のXML文字列を解析し、処理が完了したらxml_parser_free()でパーサーのリソースを解放します。この関数はXML要素を直接追加するものではなく、XMLの解析動作を細かく制御するために利用されます。

Copy
1<?php
2
3/**
4 * XMLパーサーのオプションを設定し、XML文字列をパースするデモンストレーション関数。
5 *
6 * この関数は、XML_OPTION_CASE_FOLDING オプションを false に設定することで、
7 * タグ名の大文字小文字をそのまま保持するXMLパースの挙動を示します。
8 * (デフォルトではタグ名は大文字に変換されます。)
9 *
10 * @param string $xmlString パースするXMLデータを含む文字列。
11 * @return void
12 */
13function demonstrateXmlParserOption(string $xmlString): void
14{
15    echo "--- パース対象のXML ---" . PHP_EOL;
16    echo $xmlString . PHP_EOL;
17    echo "----------------------" . PHP_EOL . PHP_EOL;
18
19    // 1. XMLパーサーを作成します。
20    // 成功するとXMLParserオブジェクトを返し、失敗した場合は false を返します。
21    $parser = xml_parser_create();
22    if (!$parser) {
23        echo "エラー: XMLパーサーの作成に失敗しました。" . PHP_EOL;
24        return;
25    }
26
27    // 2. xml_parser_set_option を使用してパーサーオプションを設定します。
28    // 引数1: XMLParser $parser - 作成したパーサーオブジェクト。
29    // 引数2: int $option - 設定するオプションの定数 (例: XML_OPTION_CASE_FOLDING)。
30    // 引数3: mixed $value - オプションに設定する値 (例: true/false)。
31    // 戻り値: bool - 設定が成功すれば true、失敗すれば false。
32    //
33    // ここでは、XML_OPTION_CASE_FOLDING (タグ名の大文字変換) を false に設定し、
34    // タグ名が元の表記のまま処理されるようにします。
35    $optionSetSuccess = xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
36
37    if (!$optionSetSuccess) {
38        echo "エラー: オプション (XML_OPTION_CASE_FOLDING) の設定に失敗しました。" . PHP_EOL;
39        xml_parser_free($parser); // エラー時はパーサーを解放
40        return;
41    }
42
43    echo "オプション設定: XML_OPTION_CASE_FOLDING を false に設定しました。" . PHP_EOL;
44    echo "これにより、XMLのタグ名 (例: <RootElement> や <subItem>) の大文字小文字は" . PHP_EOL;
45    echo "元のXMLの表記が維持されてパースされます。" . PHP_EOL . PHP_EOL;
46
47    // 3. 要素の開始と終了を処理するハンドラ関数を設定します。
48    // これらの関数は、XMLパース中に対応するイベントが発生したときに自動的に呼び出されます。
49    xml_set_element_handler(
50        $parser,
51        /**
52         * 開始要素ハンドラ: 要素の開始タグ (<tag>) が見つかったときに呼び出されます。
53         *
54         * @param XMLParser $parser XMLパーサーオブジェクト。
55         * @param string $name 見つかった要素のタグ名。
56         * @param array $attrs 要素に定義されている属性の連想配列。
57         */
58        function (XMLParser $parser, string $name, array $attrs) {
59            echo "要素開始: <" . $name;
60            foreach ($attrs as $key => $value) {
61                echo " $key=\"$value\"";
62            }
63            echo ">" . PHP_EOL;
64        },
65        /**
66         * 終了要素ハンドラ: 要素の終了タグ (</tag>) が見つかったときに呼び出されます。
67         *
68         * @param XMLParser $parser XMLパーサーオブジェクト。
69         * @param string $name 見つかった要素のタグ名。
70         */
71        function (XMLParser $parser, string $name) {
72            echo "要素終了: </" . $name . ">" . PHP_EOL;
73        }
74    );
75
76    // 4. XML文字列をパースします。
77    // 成功すると true を、失敗すると false を返します。
78    $parseSuccess = xml_parse($parser, $xmlString);
79
80    if (!$parseSuccess) {
81        // パースエラーが発生した場合の処理
82        $errorCode = xml_get_error_code($parser);
83        $errorString = xml_error_string($errorCode);
84        $line = xml_get_current_line_number($parser);
85        $column = xml_get_current_column_number($parser);
86        echo "XMLパースエラー: " . $errorString . " (行: " . $line . ", 列: " . $column . ")" . PHP_EOL;
87    } else {
88        echo PHP_EOL . "XMLパースが正常に完了しました。" . PHP_EOL;
89    }
90
91    // 5. 使用したXMLパーサーを解放します。
92    // これにより、パーサーが占有していたメモリなどのリソースが解放されます。
93    xml_parser_free($parser);
94}
95
96// サンプルXMLデータ
97// タグ名に大文字と小文字が混在していることに注意してください。
98// `demonstrateXmlParserOption` 関数によって、これらのタグ名が元の表記のまま処理されることを確認できます。
99$sampleXmlData = <<<XML
100<RootElement attribute="value">
101    <ChildNode id="123">
102        <subItem>Example Data</subItem>
103    </ChildNode>
104    <AnotherChild/>
105</RootElement>
106XML;
107
108// 関数を実行してXMLパーサーオプション設定のデモンストレーションを行います。
109demonstrateXmlParserOption($sampleXmlData);

xml_parser_set_option関数は、PHPでXMLデータを解析する際に使用するXMLパーサーの挙動を細かく設定するために利用されます。この関数は、引数として、まずxml_parser_create関数で作成したXMLParserオブジェクトを受け取ります。次に、設定したいオプションの種類を示す整数値（例えば、タグ名の大文字小文字の扱いを設定するXML_OPTION_CASE_FOLDINGなど）を指定します。そして、そのオプションに設定する具体的な値を渡します。サンプルコードでは、XML_OPTION_CASE_FOLDINGをfalseに設定することで、XML内のタグ名が元の表記（例えば<RootElement>や<subItem>)のままパースされ、デフォルトのようにすべて大文字に変換されないように制御しています。これにより、XMLの構造をより忠実に扱うことが可能になります。関数の実行が成功した場合はtrue、失敗した場合はfalseが戻り値として返されるため、オプション設定の成否を確認できます。この関数を使うことで、開発者はXMLパース処理をニーズに合わせて柔軟にカスタマイズできます。