【PHP8.x】xml_parse関数の使い方

Copy
1<?php
2
3/**
4 * XMLデータをパースし、要素や文字データを処理する関数。
5 * システムエンジニアを目指す初心者向けに、XMLパーサーの基本的な使い方を示します。
6 *
7 * @param string $xmlString パースするXMLデータ
8 * @return void
9 */
10function parseXmlData(string $xmlString): void
11{
12    // 1. XMLパーサーリソースを作成します。
13    // xml_parser_create() は新しいXMLパーサーを初期化し、それを操作するためのリソースIDを返します。
14    $parser = xml_parser_create();
15
16    if (!$parser) {
17        echo "XMLパーサーの作成に失敗しました。\n";
18        return;
19    }
20
21    // 2. XML要素の開始タグと終了タグが検出されたときに呼び出されるハンドラ関数を設定します。
22    // 第2引数: 要素の開始時に呼び出されるコールバック関数。要素名と属性の配列を受け取ります。
23    // 第3引数: 要素の終了時に呼び出されるコールバック関数。要素名を受け取ります。
24    xml_set_element_handler(
25        $parser,
26        function (XMLParser $parser, string $name, array $attrs) {
27            echo "要素開始: <{$name}>\n";
28            foreach ($attrs as $attrName => $attrValue) {
29                echo "  属性: {$attrName}=\"{$attrValue}\"\n";
30            }
31        },
32        function (XMLParser $parser, string $name) {
33            echo "要素終了: </{$name}>\n";
34        }
35    );
36
37    // 3. XML要素間の文字データが検出されたときに呼び出されるハンドラ関数を設定します。
38    // コールバック関数は文字データ（CDATA）を受け取ります。
39    xml_set_character_data_handler(
40        $parser,
41        function (XMLParser $parser, string $data) {
42            // 前後の空白を削除し、データが空でない場合のみ表示
43            $trimmedData = trim($data);
44            if (!empty($trimmedData)) {
45                echo "  データ: \"{$trimmedData}\"\n";
46            }
47        }
48    );
49
50    // 4. 定義したXMLデータ ($xmlString) をパースします。
51    // xml_parse() はパース成功時に 1、失敗時に 0 を返します。
52    // 第3引数の true は、これがパースする最後のデータチャンクであることを示します。
53    $success = xml_parse($parser, $xmlString, true);
54
55    if (!$success) {
56        // パースが失敗した場合、エラー情報を取得して表示します。
57        $errorCode = xml_get_error_code($parser);
58        $errorString = xml_error_string($errorCode);
59        $errorLine = xml_get_current_line_number($parser);
60        $errorColumn = xml_get_current_column_number($parser);
61
62        echo "--- XMLパースエラー --- \n";
63        echo "エラー: {$errorString} (コード: {$errorCode})\n";
64        echo "場所: 行 {$errorLine}, 列 {$errorColumn}\n";
65        echo "-----------------------\n";
66    } else {
67        echo "XMLデータのパースが成功しました。\n";
68    }
69
70    // 5. 使用したXMLパーサーリソースを解放します。
71    // メモリリークを防ぐために重要です。
72    xml_parser_free($parser);
73}
74
75// パースするサンプルXMLデータを定義します。
76$sampleXml = <<<XML
77<?xml version="1.0" encoding="UTF-8"?>
78<library>
79    <book id="bk101">
80        <title lang="en">The Great Adventure</title>
81        <author>Jane Doe</author>
82        <year>2023</year>
83        <price>29.99</price>
84    </book>
85    <book id="bk102">
86        <title lang="jp">PHP入門</title>
87        <author>Taro Yamada</author>
88        <year>2022</year>
89        <price>35.50</price>
90    </book>
91</library>
92XML;
93
94// 定義したXMLデータをパースする関数を呼び出します。
95parseXmlData($sampleXml);
96
97// 不正なXMLデータを試す例（コメント解除して実行可）
98/*
99$invalidXml = <<<XML
100<items>
101    <item>Item 1</item
102    <item>Item 2</item>
103</items>
104XML;
105echo "\n--- 不正なXMLデータのパースを試行 ---\n";
106parseXmlData($invalidXml);
107*/
108
109?>

xml_parse関数は、PHPでXMLデータの内容を読み解き、特定の構造や情報を見つけるための中心的な役割を果たす関数です。この関数を使うことで、開発者はXMLドキュメントの各部分（要素の開始、終了、文字データなど）が検出された際に、あらかじめ定義した処理を実行させることができます。

まず、xml_parser_create()でXMLパーサーという道具を用意し、そのパーサーに対してxml_set_element_handler()やxml_set_character_data_handler()を使って、「この要素のタグが始まったらこの処理をする」「ここに文字データがあったらこの処理をする」といったルール（コールバック関数）を設定します。

その後、xml_parse()を呼び出すことで、実際にXMLデータの解析が始まります。第一引数には作成したXMLパーサーを、第二引数には解析したいXMLデータ文字列を渡します。第三引数の$is_finalは、渡すデータがXML全体の最後の部分である場合にtrueを設定し、パーサーに解析の終了を伝えます。

この関数は、XMLの解析が成功すれば1、失敗すれば0という整数値を返します。これにより、解析中に問題が発生したかどうかをプログラムで確認し、エラーを適切に処理することができます。解析が完了したら、xml_parser_free()を使ってパーサーが使用していたシステムリソースを解放することが大切です。この一連の作業で、XMLデータを効率的に処理し、必要な情報を取り出すことが可能になります。

Copy
1<?php
2
3/**
4 * XMLデータを解析し、要素の開始/終了タグと文字データを処理する例です。
5 * xml_parser_create() でパーサーを作成し、xml_parse() で解析を行います。
6 *
7 * @param string $xmlString 解析対象のXML文字列。
8 * @return void
9 */
10function parseXmlExample(string $xmlString): void
11{
12    // 1. XMLパーサーを作成します。
13    // このパーサーはXMLドキュメントを読み込み、構造をイベント駆動で報告します。
14    // xml_parser_create_ns() を使うことで名前空間をサポートすることも可能です。
15    $parser = xml_parser_create();
16
17    // 2. XML要素の開始タグと終了タグが検出されたときに呼び出されるハンドラ関数を設定します。
18    // PHP 8では、ハンドラ関数にXMLParserオブジェクトが自動的に渡されます。
19    xml_set_element_handler(
20        $parser,
21        // 開始タグハンドラ: 要素名と属性の配列を受け取ります。
22        function (XMLParser $parser, string $name, array $attrs) {
23            echo "開始タグ: <" . $name;
24            foreach ($attrs as $attrName => $attrValue) {
25                echo " {$attrName}=\"{$attrValue}\"";
26            }
27            echo ">\n";
28        },
29        // 終了タグハンドラ: 要素名を受け取ります。
30        function (XMLParser $parser, string $name) {
31            echo "終了タグ: </" . $name . ">\n";
32        }
33    );
34
35    // 3. XML要素内の文字データ（テキストコンテンツ）が検出されたときに呼び出されるハンドラ関数を設定します。
36    xml_set_character_data_handler(
37        $parser,
38        function (XMLParser $parser, string $data) {
39            // trim() で余分な空白（改行など）を削除し、内容が空でなければ表示します。
40            $trimmedData = trim($data);
41            if ($trimmedData !== '') {
42                echo "  データ: " . $trimmedData . "\n";
43            }
44        }
45    );
46
47    // 4. 定義されたXMLデータを解析します。
48    // xml_parse() は解析が成功した場合は1、失敗した場合は0を返します。
49    $parseResult = xml_parse($parser, $xmlString);
50
51    if (!$parseResult) {
52        // 5. 解析エラーが発生した場合、エラー情報を取得して表示します。
53        $errorCode = xml_get_error_code($parser);
54        $errorString = xml_error_string($errorCode);
55        $line = xml_get_current_line_number($parser);
56        $column = xml_get_current_column_number($parser);
57        echo "XML解析エラー: {$errorString} (コード: {$errorCode}) 場所: 行{$line}, 列{$column}\n";
58    } else {
59        echo "XML解析が正常に完了しました。\n";
60    }
61
62    // 6. 使用したXMLパーサーのリソースを解放します。
63    // メモリリークを防ぐために重要です。
64    xml_parser_free($parser);
65}
66
67// --- 使用例 ---
68
69// サンプルXMLデータ
70$xmlData = <<<XML
71<?xml version="1.0" encoding="UTF-8"?>
72<bookstore>
73    <book category="cooking">
74        <title lang="en">Everyday Italian</title>
75        <author>Giada De Laurentiis</author>
76        <year>2005</year>
77        <price>30.00</price>
78    </book>
79    <book category="children">
80        <title lang="en">Harry Potter</title>
81        <author>J.K. Rowling</author>
82        <year>2005</year>
83        <price>29.99</price>
84    </book>
85</bookstore>
86XML;
87
88echo "--- 正常なXMLの解析例 ---\n";
89parseXmlExample($xmlData);
90
91echo "\n--- エラーを含むXMLの解析例 ---\n";
92$malformedXmlData = <<<XML
93<root>
94    <item>Value 1</item
95    <item>Value 2</item>
96</root>
97XML;
98parseXmlExample($malformedXmlData);
99
100?>

xml_parse() 関数は、PHPでXMLデータをイベント駆動型で解析するための主要な関数です。この関数は、XMLドキュメントを読み込み、要素の開始・終了、文字データといった特定の「イベント」が発生するたびに、あらかじめ指定されたコールバック関数（ハンドラ）を呼び出します。

第一引数 XMLParser $parser には、xml_parser_create() で作成されたXMLパーサーオブジェクトを渡します。これは解析の現在の状態を管理する役割を持ちます。第二引数 string $data には、実際に解析したいXMLデータ文字列を指定します。第三引数 bool $is_final はオプションで、渡される $data がXMLドキュメント全体の最後の部分である場合に true を設定します。戻り値は int 型で、解析が成功した場合は 1 を、失敗した場合は 0 を返しますので、エラー処理の判断に利用できます。

サンプルコードでは、まず xml_parser_create() でXMLパーサーオブジェクトを作成します。次に、xml_set_element_handler() でXML要素の開始タグと終了タグが検出されたときの処理を、xml_set_character_data_handler() で要素内の文字データが検出されたときの処理を、それぞれ無名関数として設定しています。これらのハンドラ関数は、xml_parse() がXMLデータを読み進める中で、該当するイベントが発生した際に自動的に呼び出されます。xml_parse() の呼び出しにより、指定されたXML文字列が解析され、設定されたハンドラが順次実行されていきます。解析が完了した後、使用したリソースを解放するために xml_parser_free() を呼び出すことが重要です。万が一解析に失敗した場合は、xml_get_error_code() などを使ってエラーの詳細情報を取得し、適切な対応を行うことができます。この一連の処理によって、XMLドキュメントの構造を効率的に把握し、必要な情報を取り出すことが可能です。