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

Copy
1<?php
2
3/**
4 * PHPのXMLParserクラスを使ったXML解析のサンプルコードです。
5 * PHP 8.2以降で導入されたオブジェクト指向のXMLParserクラスを使用します。
6 * 名前空間宣言の終了時に呼び出されるハンドラを設定し、要素の開始/終了ハンドラも設定します。
7 */
8
9// XMLParserの要素開始ハンドラ関数
10function startElementHandler(XMLParser $parser, string $name, array $attributes): void
11{
12    // 名前空間プレフィックスとローカル名を分離して表示
13    [$ns, $localName] = explode(':', $name, 2) + [1 => $name];
14    echo "要素開始: " . ($ns !== $name ? "({$ns}){$localName}" : $localName);
15    if (!empty($attributes)) {
16        echo " 属性: " . print_r($attributes, true);
17    }
18    echo "\n";
19}
20
21// XMLParserの要素終了ハンドラ関数
22function endElementHandler(XMLParser $parser, string $name): void
23{
24    // 名前空間プレフィックスとローカル名を分離して表示
25    [$ns, $localName] = explode(':', $name, 2) + [1 => $name];
26    echo "要素終了: " . ($ns !== $name ? "({$ns}){$localName}" : $localName) . "\n";
27}
28
29// XMLParserの名前空間宣言終了ハンドラ関数
30// 名前空間の宣言がスコープを終了したときに呼び出されます。
31function endNamespaceDeclHandler(XMLParser $parser, string $prefix): void
32{
33    echo "名前空間宣言終了: プレフィックス '" . $prefix . "'\n";
34}
35
36// パースするXMLデータ
37$xmlData = <<<XML
38<root xmlns:ns1="http://example.com/ns1" xmlns:ns2="http://example.com/ns2">
39    <ns1:item id="1">アイテム1</ns1:item>
40    <data>データ</data>
41    <ns2:another_item>別のアイテム</ns2:another_item>
42</root>
43XML;
44
45// オブジェクト指向のXMLパーサを作成 (PHP 8.2以降で利用可能)
46$parser = XMLParser::create();
47
48// XMLパーサのオプション設定（名前空間パーサでは通常、XML_OPTION_CASE_FOLDINGは無効）
49$parser->setOption(XML_OPTION_CASE_FOLDING, 0); 
50
51// 要素開始/終了ハンドラを設定 (キーワードに関連する機能)
52$parser->setElementHandler("startElementHandler", "endElementHandler");
53
54// 名前空間宣言終了ハンドラを設定
55// 旧来のxml_set_end_namespace_decl_handler関数に対応する機能
56$parser->setEndNamespaceDeclHandler("endNamespaceDeclHandler");
57
58// XMLデータをパース
59try {
60    $parser->parse($xmlData);
61} catch (XmlException $e) {
62    echo "XMLパースエラー: " . $e->getMessage() . "\n";
63}
64
65?>

PHPのxml_set_end_namespace_decl_handler関数（PHP 8.2以降ではXMLParserクラスのsetEndNamespaceDeclHandlerメソッド）は、XMLデータを解析する際に、名前空間の宣言がそのスコープを終了したときに自動的に呼び出される処理を設定するために使用されます。

この関数は、対象となるXMLパーサのインスタンス（XMLParser $parser）と、実行したい処理を記述したコールバック関数（callable|string|null $handler）を引数に取ります。設定するハンドラ関数は、XMLパーサのインスタンスと、スコープを終了した名前空間のプレフィックスを受け取るように定義します。ハンドラの設定が成功すると、trueが返されます。

サンプルコードでは、XMLParser::setEndNamespaceDeclHandlerメソッドを使い、endNamespaceDeclHandler関数を名前空間宣言終了時のハンドラとして登録しています。これにより、XMLパース中にns1やns2といった名前空間のスコープが終了するイベントが発生すると、この関数が実行され、該当するプレフィックスが表示されます。これは、キーワードにあるxml_set_element_handlerで要素の開始・終了を処理するのと同様に、XMLの名前空間に関連する特定のイベントを捕捉し、きめ細やかな処理を行う際に役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたXML文字列をパースし、XMLの名前空間宣言の開始と終了を検出するハンドラを呼び出します。
5 * xml_set_end_namespace_decl_handler の使用例を含みます。
6 *
7 * @param string $xmlString パースするXML文字列
8 */
9function parseXmlWithNamespaceHandlers(string $xmlString): void
10{
11    echo "--- XMLパース開始 ---\n";
12
13    // 名前空間をサポートするXMLパーサを作成します。
14    // PHP 8では、xml_parser_create_ns() は XMLParser オブジェクトを返します。
15    $parser = xml_parser_create_ns();
16
17    // 各種ハンドラ関数を設定します。これらはXMLパース中に特定のイベントが発生したときに呼び出されます。
18    // 無名関数 (クロージャ) を使用して、関数をその場で定義しています。
19
20    // 要素の開始タグが検出されたときに呼び出されます。
21    xml_set_element_handler(
22        $parser,
23        function (XMLParser $parser, string $name, array $attrs): void {
24            echo "開始要素: " . $name . "\n";
25            foreach ($attrs as $attrName => $attrValue) {
26                // 属性名には名前空間プレフィックスとURIが含まれる場合があります（例: myns:attrName）。
27                echo "  属性: {$attrName}=\"{$attrValue}\"\n";
28            }
29        },
30        // 要素の終了タグが検出されたときに呼び出されます。
31        function (XMLParser $parser, string $name): void {
32            echo "終了要素: " . $name . "\n";
33        }
34    );
35
36    // 要素間の文字データが検出されたときに呼び出されます。
37    xml_set_character_data_handler(
38        $parser,
39        function (XMLParser $parser, string $data): void {
40            $trimmedData = trim($data);
41            if ($trimmedData !== '') {
42                echo "  文字データ: '" . $trimmedData . "'\n";
43            }
44        }
45    );
46
47    // 名前空間宣言が開始されたときに呼び出されます (例: xmlns:prefix="uri")。
48    xml_set_start_namespace_decl_handler(
49        $parser,
50        function (XMLParser $parser, string $prefix, string $uri): void {
51            $prefixDisplay = $prefix === '' ? "(デフォルト)" : $prefix;
52            echo "名前空間宣言開始: プレフィックス='{$prefixDisplay}', URI='{$uri}'\n";
53        }
54    );
55
56    // 名前空間宣言の有効範囲が終了したときに呼び出されます。
57    // これがこのサンプルコードの主要な目的です。
58    // 名前空間宣言のスコープは、その宣言を行った要素の終了タグで終わります。
59    xml_set_end_namespace_decl_handler(
60        $parser,
61        function (XMLParser $parser, string $prefix): void {
62            $prefixDisplay = $prefix === '' ? "(デフォルト)" : $prefix;
63            echo "名前空間宣言終了: プレフィックス='{$prefixDisplay}'\n";
64        }
65    );
66
67    // XML文字列をパースします。
68    // 第3引数を true にすると、最後のデータチャンクとして扱われます。
69    if (!xml_parse($parser, $xmlString, true)) {
70        // パースエラーが発生した場合、エラー情報を表示します。
71        $errorCode = xml_get_error_code($parser);
72        $errorString = xml_error_string($errorCode);
73        $line = xml_get_current_line_number($parser);
74        $column = xml_get_current_column_number($parser);
75        echo "XMLパースエラー: {$errorString} (コード: {$errorCode}) @ 行: {$line}, カラム: {$column}\n";
76    }
77
78    echo "--- XMLパース終了 ---\n";
79
80    // 使用したXMLパーサを解放し、リソースをクリーンアップします。
81    xml_parser_free($parser);
82}
83
84// サンプルとして使用するXMLデータです。
85// "myns"というプレフィックスを持つ名前空間と、デフォルトの名前空間の両方を宣言しています。
86$xmlData = <<<XML
87<root xmlns:myns="http://example.com/myns" xmlns="http://example.com/default">
88    <myns:element attr1="value1">
89        Hello from <myns:subelement/> myns!
90    </myns:element>
91    <anotherElement>Default namespace element.</anotherElement>
92</root>
93XML;
94
95// 定義した関数を呼び出し、XMLパースを実行します。
96parseXmlWithNamespaceHandlers($xmlData);

PHP 8のxml_set_end_namespace_decl_handler関数は、XMLの名前空間をサポートするパーサにおいて、名前空間宣言の有効範囲が終了した際に特定の処理を実行するためのコールバック関数を設定します。この関数は、第一引数にxml_parser_create_ns()で作成されたXMLパーサオブジェクト（XMLParser）、第二引数にイベント発生時に呼び出されるハンドラ関数（callable型）を受け取ります。ハンドラ関数は、XMLParserオブジェクトと、有効範囲が終了した名前空間のプレフィックス（デフォルト名前空間の場合は空文字列）を受け取り、その名前空間のスコープ終了を正確に追跡するのに役立ちます。設定が成功するとtrueを返します。

提供されたサンプルコードでは、xml_parser_create_ns()で名前空間対応のパーサを作成し、xml_set_end_namespace_decl_handlerを使って、XMLパース中に名前空間宣言の有効範囲が終了するたびに、どのプレフィックスの名前空間が終了したかをコンソールに出力しています。これにより、XML文書内の名前空間のライフサイクルを細かく制御し、例えば、特定の名前空間内の要素が終了した際に特別なクリーンアップ処理を行うなど、文書構造に応じた柔軟な処理を実装することが可能になります。