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

Copy
1<?php
2
3/**
4 * XMLデータ文字列。
5 * このサンプルでは、簡単な書店情報をXML形式で表現しています。
6 */
7$xml_data = <<<XML
8<?xml version="1.0" encoding="UTF-8"?>
9<bookstore>
10    <book category="cooking">
11        <title lang="en">Everyday Italian</title>
12        <author>Giada De Laurentiis</author>
13        <year>2005</year>
14        <price>30.00</price>
15    </book>
16    <book category="children">
17        <title lang="en">Harry Potter</title>
18        <author>J.K. Rowling</author>
19        <year>2005</year>
20        <price>29.99</price>
21    </book>
22</bookstore>
23XML;
24
25// 現在のXML要素のネストレベルを追跡するための変数
26// 出力を見やすくするためにインデントとして使用します。
27$current_indent_level = 0;
28
29/**
30 * XMLパーサーが開始タグ（要素の開始）を見つけたときに呼び出されるハンドラ関数です。
31 *
32 * @param XMLParser $parser XMLパーサーインスタンス。
33 * @param string $name 見つかった要素の名前。
34 * @param array $attrs 要素に付随する属性の連想配列（属性名 => 値）。
35 * @return void
36 */
37function start_element(XMLParser $parser, string $name, array $attrs): void
38{
39    global $current_indent_level; // グローバル変数にアクセス
40    
41    // 現在のネストレベルに基づいてインデントを出力
42    echo str_repeat("  ", $current_indent_level) . "開始要素: " . $name . "\n";
43    
44    // 属性が存在する場合、それらも出力
45    if (!empty($attrs)) {
46        echo str_repeat("  ", $current_indent_level + 1) . "属性:\n";
47        foreach ($attrs as $attr_name => $attr_value) {
48            echo str_repeat("  ", $current_indent_level + 2) . " - " . $attr_name . " = '" . $attr_value . "'\n";
49        }
50    }
51    
52    // ネストレベルを深くする
53    $current_indent_level++;
54}
55
56/**
57 * XMLパーサーが終了タグ（要素の終了）を見つけたときに呼び出されるハンドラ関数です。
58 *
59 * @param XMLParser $parser XMLパーサーインスタンス。
60 * @param string $name 見つかった要素の名前。
61 * @return void
62 */
63function end_element(XMLParser $parser, string $name): void
64{
65    global $current_indent_level; // グローバル変数にアクセス
66    
67    // ネストレベルを浅くする
68    $current_indent_level--;
69    
70    // 現在のネストレベルに基づいてインデントを出力
71    echo str_repeat("  ", $current_indent_level) . "終了要素: " . $name . "\n";
72}
73
74/**
75 * 指定されたXML文字列をパースし、要素の開始と終了を処理します。
76 *
77 * @param string $xml_string パースするXMLデータ。
78 * @return bool パースが成功した場合はtrue、失敗した場合はfalse。
79 */
80function parseXmlDocument(string $xml_string): bool
81{
82    // 1. XMLパーサーを作成します。
83    // xml_parser_create() は、XMLデータを解析するためのパーサーインスタンスを返します。
84    $parser = xml_parser_create();
85    if ($parser === false) {
86        echo "エラー: XMLパーサーの作成に失敗しました。\n";
87        return false;
88    }
89
90    // 2. 要素のハンドラを設定します。
91    // xml_set_element_handler() は、開始タグと終了タグがそれぞれ見つかったときに
92    // どの関数を呼び出すかをパーサーに指示します。
93    // 第2引数が開始要素ハンドラ、第3引数が終了要素ハンドラです。
94    // ここでは、定義済みの 'start_element' と 'end_element' 関数を指定しています。
95    xml_set_element_handler($parser, 'start_element', 'end_element');
96
97    // 3. XMLデータをパースします。
98    // xml_parse() は、XMLデータを実際に解析します。
99    // 第3引数を true にすると、これがデータの最後のチャンクであることを示します。
100    if (!xml_parse($parser, $xml_string, true)) {
101        // パース中にエラーが発生した場合
102        $error_code = xml_get_error_code($parser);
103        $line = xml_get_current_line_number($parser);
104        $col = xml_get_current_column_number($parser);
105        echo "XMLパースエラー: " . xml_error_string($error_code) . " (行: $line, 列: $col)\n";
106        xml_parser_free($parser); // エラー時でもパーサーを解放
107        return false;
108    }
109
110    // 4. パーサーを解放します。
111    // xml_parser_free() は、使用済みのXMLパーサーリソースを解放し、メモリを節約します。
112    xml_parser_free($parser);
113
114    echo "XMLパースが正常に完了しました。\n";
115    return true;
116}
117
118// サンプルXMLデータをパースする関数を実行
119parseXmlDocument($xml_data);
120

PHPのxml_set_element_handler関数は、XMLデータを解析する際に、XMLの開始タグと終了タグが見つかったときに実行する処理を設定するために使用されます。

第一引数には、xml_parser_create()で作成したXMLパーサーのインスタンスを指定し、どのXMLデータに対する処理を設定するかをパーサーに伝えます。

第二引数の$start_element_handlerには、<book>のようなXMLの開始タグが見つかったときに呼び出される関数を指定します。この関数は、要素名と属性情報を受け取ります。サンプルコードではstart_element関数がこれにあたり、要素名や属性の表示とインデント調整を行います。

第三引数の$end_element_handlerには、</book>のようなXMLの終了タグが見つかったときに呼び出される関数を指定します。この関数は、終了した要素の名前を受け取ります。サンプルコードではend_element関数がこれにあたり、要素名の表示とインデント調整を行います。

xml_set_element_handler関数は、これらのハンドラの設定が成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。この設定により、xml_parse()でXMLデータが読み込まれる際、タグの出現に合わせて指定した関数が自動実行され、XMLの構造をたどりながら必要な処理を行えるようになります。

Copy
1<?php
2
3/**
4 * XMLデータをパースし、要素の開始・終了タグを処理するサンプル関数。
5 * システムエンジニアを目指す初心者の方にもXMLパーサーの基本的な使い方を理解してもらえるよう、
6 * xml_set_element_handler 関数の利用方法に焦点を当てています。
7 *
8 * @param string $xmlData パース対象のXML文字列。
9 * @return void
10 */
11function processXmlElementHandling(string $xmlData): void
12{
13    // XMLパーサーを作成します。文字エンコーディングはUTF-8を指定。
14    $parser = xml_parser_create("UTF-8");
15
16    // パーサーの作成に失敗した場合は処理を終了します。
17    if (!$parser) {
18        echo "エラー: XMLパーサーの作成に失敗しました。\n";
19        return;
20    }
21
22    // 開始タグを処理するハンドラ関数を定義します。
23    // タグ名と属性を標準出力します。
24    $startElementHandler = function (XMLParser $parser, string $name, array $attrs): void {
25        echo "開始タグ: " . $name . "\n";
26        if (!empty($attrs)) {
27            // 属性がある場合は表示します。
28            echo "  属性: " . implode(", ", array_map(fn($key, $val) => "$key=\"$val\"", array_keys($attrs), $attrs)) . "\n";
29        }
30    };
31
32    // 終了タグを処理するハンドラ関数を定義します。
33    // タグ名を標準出力します。
34    $endElementHandler = function (XMLParser $parser, string $name): void {
35        echo "終了タグ: " . $name . "\n";
36    };
37
38    // xml_set_element_handler を使用して、開始タグと終了タグのハンドラ関数を設定します。
39    // 第1引数: XMLパーサーリソース
40    // 第2引数: 開始タグが見つかったときに呼び出される callable (クロージャ)
41    // 第3引数: 終了タグが見つかったときに呼び出される callable (クロージャ)
42    if (!xml_set_element_handler($parser, $startElementHandler, $endElementHandler)) {
43        echo "エラー: ハンドラ関数の設定に失敗しました。\n";
44        xml_parser_free($parser); // エラー時はパーサーを解放
45        return;
46    }
47
48    // XMLデータをパースします。
49    // xml_parse は成功した場合 true、失敗した場合 false を返します。
50    if (!xml_parse($parser, $xmlData, true)) {
51        // パースに失敗した場合、エラー情報を取得して表示します。
52        $errorCode = xml_get_error_code($parser);
53        $errorString = xml_error_string($errorCode);
54        $line = xml_get_current_line_number($parser);
55        $column = xml_get_current_column_number($parser);
56        echo "XMLパースエラー: {$errorString} (コード: {$errorCode}) at line {$line}, column {$column}\n";
57    } else {
58        echo "\nXMLパースが正常に完了しました。\n";
59    }
60
61    // パース処理が完了したら、XMLパーサーリソースを解放します。
62    xml_parser_free($parser);
63}
64
65// -----------------------------------------------------------------------------
66// サンプルXMLデータ
67// -----------------------------------------------------------------------------
68$sampleXml = <<<XML
69<?xml version="1.0" encoding="UTF-8"?>
70<bookstore>
71    <book category="cooking">
72        <title lang="en">Everyday Italian</title>
73        <author>Giada De Laurentiis</author>
74        <year>2005</year>
75        <price>30.00</price>
76    </book>
77    <book category="children">
78        <title lang="en">Harry Potter</title>
79        <author>J.K. Rowling</author>
80        <year>2005</year>
81        <price>29.99</price>
82    </book>
83</bookstore>
84XML;
85
86// サンプル関数を呼び出してXMLパースを実行します。
87processXmlElementHandling($sampleXml);

PHPのxml_set_element_handler関数は、XMLデータを解析する際に、要素の開始タグと終了タグがそれぞれ見つかったときに実行する処理を設定するために利用します。この関数は、XMLパーサーが特定のイベント（タグの開始や終了）を検出した際に、あらかじめ指定したコールバック関数を自動的に呼び出す仕組みを提供します。

サンプルコードでは、まずxml_parser_createでXMLパーサーを作成し、その後、開始タグ用と終了タグ用の二つの匿名関数を定義しています。xml_set_element_handlerの第1引数には作成したXMLParserオブジェクト（パーサーリソース）、第2引数には開始タグ処理用のcallable関数、第3引数には終了タグ処理用のcallable関数をそれぞれ渡して設定しています。これにより、XMLパーサーがXMLデータを解析する際に、要素の開始タグを検出すると$startElementHandlerが、終了タグを検出すると$endElementHandlerが自動的に呼び出され、それぞれのタグ名や属性に応じた処理が実行されるのです。

本関数の戻り値はbool型で、ハンドラの設定が成功すればtrue、失敗すればfalseが返されます。設定後、xml_parse関数で実際のXML文字列をパースし、エラーが発生した場合はxml_get_error_codeなどで詳細を確認します。最終的に、パース処理が終わったらxml_parser_freeでパーサーリソースを解放することが重要です。この一連の流れにより、柔軟にXMLの構造を解析し、必要な情報を抽出することができます。