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

Copy
1<?php
2
3/**
4 * XMLパース処理を実行する関数
5 *
6 * この関数は、指定されたXML文字列をパースし、
7 * 開始タグ、終了タグ、文字データ（タグ間のテキスト）のハンドラを
8 * 設定して結果を出力します。
9 * xml_set_element_handler と xml_set_character_data_handler の両方の使用例を含みます。
10 *
11 * @param string $xmlString パース対象のXML文字列
12 * @return void
13 */
14function parseBookstoreXml(string $xmlString): void
15{
16    // XMLパーサーを作成します。PHP 8からはXMLParserオブジェクトが返されます。
17    $parser = xml_parser_create();
18
19    // パース結果を格納するための配列
20    $parsedData = [];
21    // 現在処理中のタグ名を追跡するための変数
22    $currentTag = '';
23    // 現在処理中の書籍データを一時的に保持するための配列
24    $currentBook = [];
25
26    // 要素の開始タグと終了タグを処理するハンドラを設定します。
27    // xml_set_element_handlerの第一引数はXMLParserオブジェクト、
28    // 第二引数は開始タグのハンドラ、第三引数は終了タグのハンドラです。
29    // 無名関数をコールバックとして利用しています。
30    xml_set_element_handler(
31        $parser,
32        // 開始タグのハンドラ
33        function (XMLParser $parser, string $name, array $attrs) use (&$currentTag, &$currentBook): void {
34            // タグ名を小文字に変換して扱います
35            $name = strtolower($name);
36
37            // 'book'タグが開始されたら、新しい書籍の準備をします
38            if ($name === 'book') {
39                // 属性からカテゴリを取得し、初期データとして設定
40                $currentBook = ['category' => $attrs['CATEGORY'] ?? ''];
41            }
42            // 現在のタグ名を更新
43            $currentTag = $name;
44        },
45        // 終了タグのハンドラ
46        function (XMLParser $parser, string $name) use (&$currentTag, &$parsedData, &$currentBook): void {
47            // タグ名を小文字に変換して扱います
48            $name = strtolower($name);
49
50            // 'book'タグが終了したら、現在の書籍データを結果配列に追加します
51            if ($name === 'book') {
52                $parsedData[] = $currentBook;
53                $currentBook = []; // 次の書籍のためにデータをリセット
54            }
55            // 現在のタグ名をクリア
56            $currentTag = '';
57        }
58    );
59
60    // 文字データ（タグ間のテキスト）を処理するハンドラを設定します。
61    // xml_set_character_data_handlerの第一引数はXMLParserオブジェクト、
62    // 第二引数は文字データのハンドラです。
63    // 無名関数をコールバックとして利用しています。
64    xml_set_character_data_handler(
65        $parser,
66        function (XMLParser $parser, string $data) use (&$currentTag, &$currentBook): void {
67            // 文字データの前後の空白を削除
68            $data = trim($data);
69
70            // 空白のみのデータは処理しない
71            if ($data !== '') {
72                // 現在のタグ名に応じて、書籍データに値を割り当てます
73                switch ($currentTag) {
74                    case 'title':
75                        $currentBook['title'] = $data;
76                        break;
77                    case 'author':
78                        $currentBook['author'] = $data;
79                        break;
80                    case 'year':
81                        $currentBook['year'] = (int)$data; // 数値としてキャスト
82                        break;
83                    case 'price':
84                        $currentBook['price'] = (float)$data; // 浮動小数点数としてキャスト
85                        break;
86                }
87            }
88        }
89    );
90
91    // XML文字列をパースします。
92    // 第3引数にtrueを渡すと、ファイル全体を一度にパースします。
93    if (!xml_parse($parser, $xmlString, true)) {
94        // パース中にエラーが発生した場合、エラー情報を出力します
95        $errorCode = xml_get_error_code($parser);
96        $errorString = xml_error_string($errorCode);
97        $line = xml_get_current_line_number($parser);
98        echo "XMLパースエラー: {$errorString} (Line: {$line})\n";
99    } else {
100        // パースが成功した場合、結果を出力します
101        echo "XMLパース成功。\n";
102        echo "パースされたデータ:\n";
103        print_r($parsedData);
104    }
105
106    // パース処理が完了したら、XMLパーサーを解放します。
107    xml_parser_free($parser);
108}
109
110// サンプルとなるXMLデータ
111$sampleXml = <<<XML
112<bookstore>
113    <book category="cooking">
114        <title lang="en">Everyday Italian</title>
115        <author>Giada De Laurentiis</author>
116        <year>2005</year>
117        <price>30.00</price>
118    </book>
119    <book category="children">
120        <title lang="en">Harry Potter</title>
121        <author>J.K. Rowling</author>
122        <year>2005</year>
123        <price>29.99</price>
124    </book>
125    <book category="web">
126        <title lang="en">Learning XML</title>
127        <author>Erik T. Ray</author>
128        <year>2003</year>
129        <price>39.95</price>
130    </book>
131</bookstore>
132XML;
133
134// 定義した関数を呼び出し、XMLパースを実行します
135parseBookstoreXml($sampleXml);
136
137?>

xml_set_character_data_handler関数は、PHPでXMLデータをパースする際に、タグとタグの間のテキスト情報（文字データ）を処理するためのハンドラを設定します。第一引数にはXMLパーサーオブジェクト、第二引数には文字データが見つかったときに実行される関数（コールバック）を指定します。このコールバック関数は、パースされた文字データを引数として受け取り処理します。戻り値はハンドラの設定が成功したかどうかを示す真偽値です。

サンプルコードでは、parseBookstoreXml関数が与えられたXML文字列をパースします。まずxml_set_element_handlerでXML要素（タグ）の開始と終了を処理するハンドラを設定し、現在のタグ名を追跡します。次に、xml_set_character_data_handlerで文字データハンドラを設定します。このハンドラは、<title>Everyday Italian</title>における「Everyday Italian」のようなタグ間のテキストが検出されたときに呼び出されます。ハンドラ内では、現在処理中のタグ名（要素ハンドラによって設定されたもの）に基づいて、文字データを書籍のタイトル、著者、年、価格などの情報として$currentBook配列に格納します。最終的にxml_parse関数でXML全体を処理し、エラーがなければ$parsedData変数に構造化された書籍情報が配列として出力されます。これにより、XMLの構造と内容を段階的に解析し、必要なデータを取り出す一連のプロセスを示しています。

Copy
1<?php
2
3/**
4 * XMLパーサーが文字データを検出したときに呼び出されるハンドラ関数。
5 * CDATAセクション内のコンテンツも通常の文字データとして処理されます。
6 *
7 * @param XMLParser $parser 現在のXMLパーサーリソース。
8 * @param string $data 検出された文字データ。
9 * @return void
10 */
11function handleCharacterData(XMLParser $parser, string $data): void
12{
13    // 空白のみのデータを除外して、意味のあるデータのみ表示する
14    // trim()で両端の空白を削除し、空でないことを確認
15    $trimmedData = trim($data);
16    if ($trimmedData !== '') {
17        echo "検出された文字データ: " . htmlspecialchars($trimmedData) . "\n";
18    }
19}
20
21/**
22 * XMLデータから文字データを解析するサンプル関数。
23 * `xml_set_character_data_handler` の使用方法を示します。
24 *
25 * @return void
26 */
27function parseXmlCharacterDataExample(): void
28{
29    // 1. XMLパーサーを作成します。
30    // PHP 8では、xml_parser_create() は XMLParser オブジェクトを返します。
31    $parser = xml_parser_create();
32    if ($parser === false) {
33        echo "XMLパーサーの作成に失敗しました。\n";
34        return;
35    }
36
37    // 2. 文字データハンドラを設定します。
38    // XML文書内のタグ間のテキストコンテンツ（CDATAセクションの内容も含む）が解析されたときに、
39    // 上で定義した 'handleCharacterData' 関数が呼び出されます。
40    xml_set_character_data_handler($parser, 'handleCharacterData');
41
42    // 3. 解析するXMLデータを用意します。
43    // 通常のテキストとCDATAセクションの両方を含めます。
44    $xmlString = <<<XML
45    <root>
46        <item1>
47            これは通常のテキストデータです。
48        </item1>
49        <item2>
50            <![CDATA[
51                このセクション内のテキストはマークアップとして解釈されません。
52                例えば、<b>HTMLタグ</b> や <script>alert("XSS!");</script>
53                などもそのまま文字データとして扱われます。
54            ]]>
55        </item2>
56        <item3>別のテキスト。</item3>
57    </root>
58    XML;
59
60    // 4. XMLデータを解析します。
61    // エラーが発生した場合は、エラーメッセージを表示します。
62    if (!xml_parse($parser, $xmlString)) {
63        $errorCode = xml_get_error_code($parser);
64        $errorString = xml_error_string($errorCode);
65        $currentLine = xml_get_current_line_number($parser);
66        echo "XML解析エラー: {$errorString} (行: {$currentLine})\n";
67    }
68
69    // 5. XMLパーサーリソースを解放します。
70    // これにより、パーサーが使用していたメモリが解放されます。
71    xml_parser_free($parser);
72}
73
74// サンプル関数を実行します。
75parseXmlCharacterDataExample();

xml_set_character_data_handler関数は、PHPでXML文書を解析する際に、XMLタグの間に含まれるテキストデータや、CDATAセクション内のコンテンツを処理するためのハンドラ関数を設定します。

この関数は、二つの引数を取ります。一つ目のXMLParser $parserには、xml_parser_create()関数で作成したXMLパーサーオブジェクトを指定します。このパーサーがXMLを読み進め、文字データを検出したときに、設定された処理が実行されます。二つ目のcallable|string $handlerには、文字データが検出された際に呼び出される関数を指定します。この関数は、第一引数にパーサーオブジェクト、第二引数に検出された文字データ（文字列）を受け取るように定義する必要があります。例えば、サンプルコードのhandleCharacterData関数のように実装します。関数が成功するとtrueが、失敗するとfalseが戻り値として返されます。

サンプルコードでは、xml_parser_create()でXMLパーサーを作成し、xml_set_character_data_handlerを使ってhandleCharacterData関数を文字データハンドラとして登録しています。これにより、xml_parse()でXML文字列を解析する際に、通常のテキストデータだけでなく、XMLの特殊なセクションであるCDATA（Character Data）セクション内のコンテンツも、すべて文字データとしてhandleCharacterData関数で処理できるようになります。CDATAセクション内の内容はXMLマークアップとして解釈されず、そのままの文字列として扱われるため、HTMLタグなどを含んだデータも安全に処理できるのが特徴です。最後に、解析が完了したらxml_parser_free()でパーサーのリソースを解放します。