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

Copy
1<?php
2
3/**
4 * XMLデータをパースし、要素とデフォルトのXMLデータを処理するハンドラを設定する関数。
5 * システムエンジニアを目指す初心者向けに、XMLパーサーの基本的な使い方と
6 * xml_set_element_handler() および xml_set_default_handler() の動作を示します。
7 *
8 * @param string $xmlString パースするXMLデータ。
9 */
10function parseXmlWithHandlers(string $xmlString): void
11{
12    // XMLパーサーを作成します。
13    // このパーサーオブジェクトを使用して、XMLデータの解析を制御します。
14    $parser = xml_parser_create();
15
16    // デフォルトハンドラを設定します。
17    // このハンドラは、特定の開始/終了要素ハンドラ、文字データハンドラ、
18    // 処理命令ハンドラなどで処理されないすべてのXMLデータを捕捉します。
19    // 例：XML宣言、コメント、CDATAセクション、要素間の空白、要素内の文字データ（文字データハンドラが設定されていない場合）
20    xml_set_default_handler($parser, function (XMLParser $parser, string $data) {
21        // 空白のみのデータは多く発生するため、表示を簡潔にするためにtrim()で確認します。
22        // ただし、XMLにおける空白は意味を持つことがあるため、実際のアプリケーションでは注意が必要です。
23        if (trim($data) !== '') {
24            echo "DEFAULT HANDLER (Unhandled Data): " . htmlspecialchars($data) . "\n";
25        }
26    });
27
28    // 開始要素ハンドラと終了要素ハンドラを設定します。
29    // xml_set_element_handler() は2つのハンドラを受け取ります。
30    // 1つ目は開始タグが見つかったときに、2つ目は終了タグが見つかったときに呼び出されます。
31    xml_set_element_handler(
32        $parser,
33        // 開始タグハンドラ: 要素名と属性を出力します。
34        function (XMLParser $parser, string $name, array $attributes) {
35            echo "START TAG: " . $name;
36            if (!empty($attributes)) {
37                echo " ATTRIBUTES: " . http_build_query($attributes, '', ', ');
38            }
39            echo "\n";
40        },
41        // 終了タグハンドラ: 要素名を出力します。
42        function (XMLParser $parser, string $name) {
43            echo "END TAG: " . $name . "\n";
44        }
45    );
46
47    // XMLデータをパースします。
48    // xml_parse() が false を返した場合、エラーが発生しています。
49    if (!xml_parse($parser, $xmlString, true)) {
50        // エラー情報を取得し、表示します。
51        $errorCode = xml_get_error_code($parser);
52        $errorString = xml_error_string($errorCode);
53        $line = xml_get_current_line_number($parser);
54        $col = xml_get_current_column_number($parser);
55        echo "XML PARSE ERROR: [{$errorCode}] {$errorString} at line {$line}, column {$col}\n";
56    }
57
58    // パースが完了したら、パーサーリソースを解放します。
59    xml_parser_free($parser);
60}
61
62// サンプルXMLデータ。書籍情報を含みます。
63// コメントや要素間の改行など、様々な種類のXMLデータが含まれています。
64$sampleXml = <<<XML
65<?xml version="1.0" encoding="UTF-8"?>
66<bookstore>
67    <!-- これは図書館に関するコメントです -->
68    <book category="cooking">
69        <title lang="en">Everyday Italian</title>
70        <author>Giada De Laurentiis</author>
71        <year>2005</year>
72        <price>30.00</price>
73    </book>
74    <book category="children">
75        <title lang="en">Harry Potter</title>
76        <author>J.K. Rowling</author>
77        <year>2005</year>
78        <price>29.99</price>
79    </book>
80</bookstore>
81XML;
82
83// 関数を呼び出してXMLデータをパースし、結果を出力します。
84parseXmlWithHandlers($sampleXml);

PHPのxml_set_default_handler関数は、XMLデータを解析する際に、特定の要素ハンドラなどで処理されない全てのXMLデータを捕捉するためのデフォルトハンドラを設定します。この機能は、XML宣言、コメント、CDATAセクション、要素間の空白、または文字データハンドラが設定されていない場合の要素内の文字データなどを処理したい場合に特に有用です。

この関数は二つの引数を取ります。一つ目のXMLParser $parserは、xml_parser_create()で作成したXMLパーサーオブジェクトを指定します。二つ目のcallable|string $handlerは、XMLパーサーが未処理のデータを見つけたときに呼び出される関数またはメソッドの名前を指定します。このハンドラ関数は、XMLパーサーオブジェクトと未処理のデータ文字列を引数として受け取ります。関数が成功するとtrueを返します。

サンプルコードでは、まずxml_parser_create()でXMLパーサーを作成し、その後xml_set_default_handler()を使って匿名関数をデフォルトハンドラとして設定しています。これにより、xml_set_element_handlerで設定される開始タグや終了タグのハンドラでは処理されない、XMLデータ内のコメントや要素間の改行といった部分も捕捉し、出力します。例えば、<bookstore>タグ内のコメントや<book>要素と<title>要素の間の改行などがこのデフォルトハンドラによって処理されます。このように、xml_set_default_handlerはXMLデータの全体を網羅的に検査し、きめ細かな制御を行いたい場合に役立つ関数です。

Copy
1<?php
2
3/**
4 * XMLパーサーが通常の要素や属性として解釈しないデータを処理するデフォルトハンドラの設定例。
5 *
6 * この関数は、XMLデータ内のタグ間のテキストコンテンツや、パーサーが特別に定義されていない
7 * その他のデータを捕捉するために `xml_set_default_handler` を使用する方法を示します。
8 * これはPHP全体のエラーハンドリング（`set_error_handler`）とは異なりますが、
9 * XMLパースにおける「未処理データ」に対するフォールバック処理と見なせます。
10 *
11 * @param string $xmlString パースするXML文字列。
12 * @return void
13 */
14function demonstrateXmlDefaultHandler(string $xmlString): void
15{
16    // 1. XMLパーサーを作成します。
17    // xml_parser_create() は、XMLパーサーのリソース（PHP 8ではXMLParserオブジェクト）を返します。
18    $parser = xml_parser_create();
19
20    if ($parser === false) {
21        echo "エラー: XMLパーサーの作成に失敗しました。\n";
22        return;
23    }
24
25    // 2. デフォルトハンドラとして機能するコールバック関数を定義します。
26    // このハンドラは、XMLパーサーが特定の要素やエンティティとして処理しない
27    // 生のデータ（主にタグ間のテキストやCDATAセクションなど）を検出したときに呼び出されます。
28    // 引数はXMLParserオブジェクトと、検出されたデータの文字列です。
29    $defaultHandler = function (XMLParser $parser, string $data) {
30        $trimmedData = trim($data); // 前後の空白を削除
31        if (!empty($trimmedData)) {
32            // デフォルトハンドラが捕捉したデータを表示します。
33            // HTMLエンティティに変換することで、XML内の特殊文字も安全に表示できます。
34            echo "[DEFAULT HANDLER] 検出されたデータ: '" . htmlspecialchars($trimmedData) . "'\n";
35        }
36    };
37
38    // 3. xml_set_default_handler() を使用して、定義したコールバック関数をパーサーに設定します。
39    // これにより、パーサーが通常のルールで処理できないデータに遭遇した際に $defaultHandler が実行されます。
40    // この関数は常に true を返します。
41    $handlerSetResult = xml_set_default_handler($parser, $defaultHandler);
42
43    if ($handlerSetResult) {
44        echo "デフォルトハンドラが正常に設定されました。\n";
45    } else {
46        // xml_set_default_handler は基本的に失敗しないため、このブロックは通常実行されません。
47        echo "警告: デフォルトハンドラの設定に失敗しました。\n";
48    }
49
50    echo "\n--- XMLパースを開始します ---\n";
51
52    // 4. XML文字列をパースします。
53    // xml_parse() の第3引数 (is_final) を true に設定することで、
54    // これがパースするデータの最後のチャンクであることを示します。
55    $parseSuccess = xml_parse($parser, $xmlString, true);
56
57    if (!$parseSuccess) {
58        // パースエラーが発生した場合、エラー情報を取得して表示します。
59        $errorCode = xml_get_error_code($parser);
60        $errorString = xml_error_string($errorCode);
61        $line = xml_get_current_line_number($parser);
62        echo "エラー: XMLパース失敗 - {$errorString} (コード: {$errorCode}) at line {$line}\n";
63    } else {
64        echo "--- XMLパースが完了しました ---\n";
65    }
66
67    // 5. 使用したXMLパーサーのリソースを解放します。
68    xml_parser_free($parser);
69}
70
71// --------------------------------------------------------------------------------
72// サンプルコードの実行部分
73// --------------------------------------------------------------------------------
74
75echo "== サンプルXML 1: タグ間にテキストデータを含むXML ==";
76$sampleXml1 = <<<XML
77<root>
78    これはルート要素内のテキストデータです。
79    <item>アイテムの内容</item>
80    さらなるテキストデータです。
81</root>
82XML;
83demonstrateXmlDefaultHandler($sampleXml1);
84
85echo "\n== サンプルXML 2: ルート要素内の直接テキスト ==";
86$sampleXml2 = "<message> Hello PHP XML! </message>";
87demonstrateXmlDefaultHandler($sampleXml2);
88
89echo "\n== サンプルXML 3: ネストされた要素のみ (デフォルトハンドラは呼ばれないはず) ==";
90$sampleXml3 = "<data><child>value</child></data>";
91demonstrateXmlDefaultHandler($sampleXml3);
92
93?>

xml_set_default_handler関数は、XMLパーサーが通常の要素や属性として解釈しないデータ、例えばタグ間のテキストコンテンツやCDATAセクションなどを処理するためのデフォルトハンドラを設定します。この関数はXMLデータパースに特化しており、PHP全体のエラーハンドリングを行うset_error_handlerとは役割が異なります。

第一引数$parserには、対象となるXMLParserオブジェクトを指定します。第二引数$handlerには、デフォルトデータが検出された際に呼び出されるコールバック関数またはメソッド名を文字列で指定します。このコールバック関数は、第一引数にXMLParserオブジェクト、第二引数に検出されたデータ文字列を受け取る必要があります。

サンプルコードでは、xml_parser_create()で作成したパーサーに対し、匿名関数で定義したデフォルトハンドラを設定しています。このハンドラは、XML文字列内の<root>と<item>の間のテキストデータや、<item>の後のテキストデータなどを捕捉し、表示しています。xml_set_default_handlerはハンドラが正常に設定されると常にtrueを返します。これにより、パーサーが予測しない形式のデータにも柔軟に対応できるフォールバック処理を実装できます。