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

Copy
1<?php
2
3/**
4 * Demonstrates parsing an XML string with namespace support using xml_parser_create_ns.
5 *
6 * This function creates an XML parser that understands namespaces and sets up
7 * handlers to process XML elements and their content. It showcases how namespace URIs
8 * are incorporated into element names when using a parser created with xml_parser_create_ns.
9 */
10function parseXmlWithNsExample(): void
11{
12    // An XML string containing both a default namespace and a prefixed namespace.
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<root xmlns="http://example.com/default-ns" xmlns:p="http://example.com/prefix-ns">
16    <p:item p:id="item-prefixed">
17        Prefixed Namespace Item Content
18    </p:item>
19    <item id="item-default">
20        Default Namespace Item Content
21    </item>
22    <no-ns-item>
23        No Namespace Item Content (this will inherit the default NS from 'root')
24    </no-ns-item>
25</root>
26XML;
27
28    // Create a new XML parser that explicitly supports namespaces.
29    // The second argument defines the separator used between the namespace URI and the local name
30    // in the element and attribute names passed to the handlers. The default is ':',
31    // but it's specified here for clarity.
32    $parser = xml_parser_create_ns(null, ':');
33
34    // Check if the parser was created successfully.
35    if ($parser === false) {
36        echo "Error: Could not create XML parser.\n";
37        return;
38    }
39
40    // Set handlers for start elements, end elements, and character data.
41    // For parsers created with xml_parser_create_ns, the element name and attribute names
42    // in handlers will be formatted as "NAMESPACE_URI:LOCAL_NAME" for namespaced elements/attributes.
43    xml_set_element_handler(
44        $parser,
45        // Start Element Handler: Called when an opening tag is encountered.
46        // $name will be "NAMESPACE_URI:LOCAL_NAME" for namespaced elements.
47        function (XMLParser $parser, string $name, array $attributes) {
48            echo "START Element: {$name}\n";
49            if (!empty($attributes)) {
50                echo "  Attributes:\n";
51                foreach ($attributes as $attrName => $attrValue) {
52                    echo "    - {$attrName} = '{$attrValue}'\n";
53                }
54            }
55        },
56        // End Element Handler: Called when a closing tag is encountered.
57        // $name will also be "NAMESPACE_URI:LOCAL_NAME".
58        function (XMLParser $parser, string $name) {
59            echo "END Element: {$name}\n";
60        }
61    );
62
63    // Set handler for character data (the text content within an element).
64    xml_set_character_data_handler(
65        $parser,
66        function (XMLParser $parser, string $data) {
67            $trimmedData = trim($data);
68            if ($trimmedData !== '') {
69                echo "  Character Data: '{$trimmedData}'\n";
70            }
71        }
72    );
73
74    // Parse the entire XML string. The `true` argument indicates it's the final part of the XML.
75    if (!xml_parse($parser, $xmlString, true)) {
76        // If parsing fails, retrieve and display the error information.
77        $errorCode = xml_get_error_code($parser);
78        $errorString = xml_error_string($errorCode);
79        $currentLine = xml_get_current_line_number($parser);
80        echo "XML Parse Error: {$errorString} at line {$currentLine}\n";
81    }
82
83    // Free the XML parser to release system resources.
84    xml_parser_free($parser);
85    echo "\nXML parsing complete.\n";
86}
87
88// Execute the example function to see the parsing in action.
89parseXmlWithNsExample();

PHP 8のxml_parser_create_ns関数は、XMLドキュメントを解析する際に名前空間を適切に処理できるXMLパーサを作成します。これは、名前空間URIを含むXML要素名や属性名の処理に特に有用です。

最初の引数$encodingはXMLの文字エンコーディングを指定し、nullで自動検出します。二番目の引数$separatorは、名前空間URIとローカル名を区切る文字で、デフォルトはコロン:です。このセパレータは、パーサハンドラに渡される要素名などが「名前空間URI:ローカル名」形式で整形される際に使用されます。関数が成功するとXMLParserオブジェクトを、失敗した場合はfalseを返します。

サンプルコードは、この関数で名前空間対応パーサを作成し、XML文字列を解析する基本的な流れを示しています。作成されたパーサは、xml_set_element_handlerなどのハンドラに、名前空間情報と$separatorで結合された要素名や属性名を渡します。これにより、名前空間を考慮したXMLコンテンツを効率的に処理できます。解析失敗時はエラー情報を取得でき、処理完了後はxml_parser_freeでリソースを解放します。

Copy
1<?php
2
3// サンプルとしてパースするXMLデータ
4$xml_data = <<<XML
5<root xmlns:prod="http://example.com/products">
6    <prod:item id="p123">
7        <prod:name>商品A</prod:name>
8        <description>これは商品Aの詳細です。</description>
9        <price>19.99</price>
10    </prod:item>
11    <prod:item id="p456">
12        <prod:name>商品B</prod:name>
13        <description>これは商品Bの詳細です。</description>
14        <price>29.99</price>
15    </prod:item>
16</root>
17XML;
18
19/**
20 * 名前空間対応のXMLデータをパースし、イベントごとに情報を出力する関数。
21 *
22 * @param string $xml_string パースするXML文字列。
23 * @param string $encoding XMLのエンコーディング。省略可能、デフォルトはUTF-8。
24 * @param string $separator 名前空間とローカル名を区切るセパレータ。省略可能、デフォルトは':'。
25 * @return void
26 */
27function parseXmlWithNamespace(string $xml_string, ?string $encoding = null, string $separator = ':'): void
28{
29    // 1. 名前空間対応のXMLパーサーを作成
30    // 第1引数: エンコーディング (nullを指定するとデフォルトのUTF-8が使われることが多い)
31    // 第2引数: 名前空間セパレータ (デフォルトはコロン ':' )
32    // 戻り値はXMLParserオブジェクト、または失敗した場合はfalse
33    $parser = xml_parser_create_ns($encoding, $separator);
34
35    if (!$parser) {
36        echo "エラー: XMLパーサーの作成に失敗しました。\n";
37        return;
38    }
39
40    // 2. イベントハンドラ関数を設定
41    // 要素の開始タグが見つかったときに呼び出される関数
42    xml_set_element_handler($parser,
43        function ($parser_res, $name, $attribs) use ($separator) {
44            echo "開始要素: " . $name;
45            // 名前空間付きの要素名の場合、分解して表示することも可能
46            // if (strpos($name, $separator) !== false) {
47            //     list($prefix, $local_name) = explode($separator, $name, 2);
48            //     echo " (プレフィックス: {$prefix}, ローカル名: {$local_name})";
49            // }
50            echo "\n";
51
52            if (!empty($attribs)) {
53                echo "  属性: ";
54                foreach ($attribs as $key => $value) {
55                    echo "{$key}=\"{$value}\" ";
56                }
57                echo "\n";
58            }
59        },
60        // 要素の終了タグが見つかったときに呼び出される関数
61        function ($parser_res, $name) {
62            echo "終了要素: " . $name . "\n";
63        }
64    );
65
66    // 文字データ（要素間のテキスト）が見つかったときに呼び出される関数を設定
67    xml_set_character_data_handler($parser,
68        function ($parser_res, $data) {
69            $trimmed_data = trim($data);
70            if ($trimmed_data !== '') {
71                echo "  データ: " . $trimmed_data . "\n";
72            }
73        }
74    );
75
76    // オプション設定: 大文字・小文字を区別しないように設定 (デフォルトは1: 大文字に変換)
77    // 0に設定すると、XMLファイル内の要素名や属性名の大文字・小文字がそのまま使われる
78    xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
79
80    // 3. XMLデータをパース
81    // 最後の引数(is_final)は、これが最後のデータチャンクであるかを示す
82    // この例では全データを一度に渡すため true
83    if (!xml_parse($parser, $xml_string, true)) {
84        // パースエラーが発生した場合
85        $error_code = xml_get_error_code($parser);
86        $error_message = xml_error_string($error_code);
87        $line_number = xml_get_current_line_number($parser);
88        $column_number = xml_get_current_column_number($parser);
89
90        echo "\nエラー: XMLパースエラーが発生しました。\n";
91        echo "メッセージ: " . $error_message . " (コード: " . $error_code . ")\n";
92        echo "場所: 行 " . $line_number . ", 列 " . $column_number . "\n";
93    }
94
95    // 4. 使用したXMLパーサーリソースを解放
96    xml_parser_free($parser);
97}
98
99// サンプル関数を実行
100parseXmlWithNamespace($xml_data);
101
102?>

PHPのxml_parser_create_ns関数は、名前空間に対応したXMLデータを解析するためのXMLパーサーを作成する際に使用されます。XML文書において、要素名が衝突しないようにするために名前空間が使われることがあり、この関数はそのような複雑なXMLを適切に処理する起点となります。

この関数は二つの引数を取ります。最初の$encoding引数では、パースするXMLデータの文字エンコーディング（例: 'UTF-8'や'SJIS'など）を指定します。この引数をnullにすると、PHPはデフォルトのエンコーディング（通常は'UTF-8'）を使用します。二番目の$separator引数は、XML要素名において名前空間のプレフィックスとローカル名を区切る文字を指定します。デフォルトではコロン:が使われます。例えば<prod:item>のような要素では、prodがプレフィックス、itemがローカル名となり、コロンがそれらを区切っています。

関数が正常に実行されると、XMLデータを解析するためのXMLParserオブジェクトが返されます。このオブジェクトは、後続のxml_set_element_handlerやxml_parseといった関数で使用され、XMLデータの構造に基づいて特定の処理を行うイベント駆動型の解析を可能にします。もしパーサーの作成に失敗した場合は、falseが返されますので、エラーハンドリングを行うことが重要です。

サンプルコードでは、xml_parser_create_nsを使って名前空間に対応したXMLパーサーを作成し、そのパーサーに対してXMLの開始タグ、終了タグ、文字データが検出された際の処理を登録しています。これにより、名前空間を持つ複雑なXML構造でも、その要素名や属性を正確に識別し、内容を取り出すことができます。