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

Copy
1<?php
2
3/**
4 * 不正なXML文字列のパースを試み、エラーが発生した場合に
5 * xml_get_error_code 関数を使用してエラー情報を取得する方法を示すサンプルコードです。
6 * システムエンジニアを目指す初心者の方にも分かりやすいように、各ステップにコメントを追加しています。
7 */
8function handleXmlParsingError(): void
9{
10    echo "XMLパースエラー処理のデモンストレーションを開始します。\n\n";
11
12    // 1. XMLパーサーを作成します。
13    // xml_parser_create() は、XMLのパースに使用する新しいXMLパーサーリソースを作成します。
14    // もしパーサーの作成に失敗した場合は、false を返します。
15    $parser = xml_parser_create();
16
17    if ($parser === false) {
18        echo "エラー: XMLパーサーの作成に失敗しました。\n";
19        return;
20    }
21
22    echo "XMLパーサーが正常に作成されました。\n";
23
24    // 2. 意図的に不正なXML文字列を準備します。
25    // このXMLは最後の <item> タグの閉じタグが欠落しているため、パースエラーが発生します。
26    $malformedXml = <<<XML
27<root>
28    <item id="1">
29        <name>First Item</name>
30    </item>
31    <item id="2">
32        <name>Second Item</name>
33    <!-- ここで <item> の閉じタグ </item> が欠落しています -->
34</root>
35XML;
36
37    echo "パースを試みる不正なXML:\n" . $malformedXml . "\n\n";
38
39    // 3. XML文字列のパースを試みます。
40    // xml_parse() は、XMLデータをパースします。
41    // パース中にエラーが発生した場合、この関数は false を返します。
42    // 最後の引数 'true' は、これがパースする最後のXMLデータブロックであることを示します。
43    if (!xml_parse($parser, $malformedXml, true)) {
44        echo "XMLパース中にエラーが発生しました。\n";
45
46        // 4. xml_get_error_code() を使用してエラーコードを取得します。
47        // この関数は、指定されたXMLパーサーリソースで最後に発生したエラーのコードを返します。
48        $errorCode = xml_get_error_code($parser);
49
50        // 5. エラーコードに対応する人間が読めるメッセージを取得します。
51        // xml_error_string() は、指定されたエラーコードに対応する文字列メッセージを返します。
52        $errorMessage = xml_error_string($errorCode);
53
54        // xml_get_current_line_number() を使用して、エラーが発生した行番号を取得します。
55        $errorLine = xml_get_current_line_number($parser);
56
57        echo "取得されたエラー情報:\n";
58        echo "  エラーコード: " . $errorCode . " (XML_ERROR_TAG_MISMATCH)\n"; // 例えば XML_ERROR_TAG_MISMATCH = 7
59        echo "  エラーメッセージ: " . $errorMessage . "\n";
60        echo "  エラー発生行: " . $errorLine . "行目\n";
61    } else {
62        echo "XMLは正常にパースされました。（この例では発生しません）\n";
63    }
64
65    // 6. 使用済みXMLパーサーリソースを解放します。
66    // xml_parser_free() は、指定されたXMLパーサーを解放し、関連付けられたすべてのシステムリソースを解放します。
67    xml_parser_free($parser);
68
69    echo "\nXMLパースエラー処理のデモンストレーションが完了しました。\n";
70}
71
72// 関数を実行します。
73handleXmlParsingError();

このサンプルコードは、PHPでXMLデータをパースする際に発生したエラーの情報を取得する方法を、システムエンジニアを目指す初心者の方にも分かりやすく示しています。

プログラムはまずxml_parser_create()関数を使ってXMLパーサーリソースを作成します。次に、意図的に閉じタグが欠落した不正なXML文字列を準備し、xml_parse()関数でそのパースを試みます。

xml_parse()がXMLの構文エラーによりパースに失敗した場合、xml_get_error_code()関数が活躍します。この関数は、引数として指定されたXMLParserリソース（$parser）で最後に発生したXMLパースエラーの数値コードを返します。もしエラーが検出されなかった場合はfalseを戻り値として返します。このサンプルでは、例えばXML_ERROR_TAG_MISMATCHのようなタグの不一致を示すエラーコードが取得されます。

取得したエラーコードはint型であり、具体的なエラー内容を数値で表します。さらに、xml_error_string()関数を利用することで、そのエラーコードに対応する人間が読めるエラーメッセージを取得できます。また、xml_get_current_line_number()関数を使用すれば、エラーが発生した行番号も把握でき、問題箇所の特定に非常に役立ちます。

最後に、xml_parser_free()関数を使って、使用したXMLパーサーリソースを適切に解放し、システムリソースを節約しています。これにより、エラー発生時のXML処理のデバッグとリソース管理の基本的な流れを理解することができます。

Copy
1<?php
2
3/**
4 * XML文字列をパースし、エラーが発生した場合はそのコードと詳細を表示します。
5 * システムエンジニア初心者向けに、XMLパースのエラー処理の基本を示します。
6 */
7function parseXmlAndHandleError(string $xmlString): void
8{
9    // 1. XMLパーサーリソースを作成します。
10    // XMLParser オブジェクトを返すため、型ヒントも PHP 8 形式で記述します。
11    $parser = xml_parser_create();
12
13    // 2. XML文字列をパースします。
14    // xml_parse() は成功した場合に true を、失敗した場合に false を返します。
15    if (!xml_parse($parser, $xmlString)) {
16        // 3. パースが失敗した場合、xml_get_error_code() を使用してエラーコードを取得します。
17        // 取得に失敗することもあるため、null 合体演算子でデフォルト値を設定するか、厳密にチェックします。
18        $errorCode = xml_get_error_code($parser);
19
20        // 4. エラーコードが正常に取得できた場合、詳細なエラー情報を表示します。
21        // xml_error_string() でエラーコードに対応する文字列メッセージを取得できます。
22        // xml_get_current_line_number() と xml_get_current_column_number() でエラーの発生箇所も特定できます。
23        if ($errorCode !== false) {
24            $errorMessage = xml_error_string($errorCode);
25            $line = xml_get_current_line_number($parser);
26            $column = xml_get_current_column_number($parser);
27
28            echo "XMLパースエラーが発生しました:\n";
29            echo "  エラーコード: {$errorCode}\n";
30            echo "  エラーメッセージ: {$errorMessage}\n";
31            echo "  発生箇所: 行 {$line}, 列 {$column}\n";
32        } else {
33            // xml_get_error_code() 自体が false を返した場合の処理
34            echo "XMLパースエラーが発生しましたが、エラーコードの取得に失敗しました。\n";
35        }
36    } else {
37        echo "XMLは正常にパースされました。\n";
38        echo "パースされたXML:\n" . htmlspecialchars($xmlString) . "\n";
39    }
40
41    // 5. 使用したXMLパーサーリソースを解放します。
42    // メモリリークを防ぐために重要です。
43    xml_parser_free($parser);
44}
45
46// 正常なXMLの例
47echo "--- 正常なXMLのテスト ---\n";
48$validXml = "<data><item id=\"1\">Value 1</item><item id=\"2\">Value 2</item></data>";
49parseXmlAndHandleError($validXml);
50echo "\n";
51
52// 意図的に不正なXMLの例 (閉じタグ不足)
53echo "--- 不正なXMLのテスト (閉じタグ不足) ---\n";
54$invalidXmlMissingEndTag = "<data><item>Value 1</item><item>Value 2</item>";
55parseXmlAndHandleError($invalidXmlMissingEndTag);
56echo "\n";
57
58// 意図的に不正なXMLの例 (不正な文字)
59echo "--- 不正なXMLのテスト (不正な文字) ---\n";
60$invalidXmlBadChar = "<data><item>Value & 1</item></data>"; // '&' はエスケープされていないと不正
61parseXmlAndHandleError($invalidXmlBadChar);
62echo "\n";
63
64?>

このサンプルコードは、PHPでXML文字列を解析し、パース中にエラーが発生した場合にその詳細を特定する方法を示しています。最初にxml_parser_create()関数でXMLパーサーを作成し、xml_parse()関数を使ってXML文字列の解析を試みます。もしxml_parse()がfalseを返してパースに失敗した場合、xml_get_error_code()関数が使用されます。

xml_get_error_code()関数は、引数として渡されたXMLParserオブジェクト、すなわちXMLパーサーの状態から、最後に発生したエラーのコードを整数値で取得します。もしエラーコードの取得に失敗した場合はfalseを返します。取得したエラーコードを利用して、xml_error_string()関数で人間が読みやすいエラーメッセージに変換することができます。さらに、xml_get_current_line_number()とxml_get_current_column_number()関数を用いることで、エラーが発生したXML文字列内の具体的な行と列の情報を特定し、デバッグに役立てられます。解析が完了した後は、必ずxml_parser_free()関数でXMLパーサーリソースを解放し、メモリリークを防ぐことが重要です。このようにして、XMLの基本的なエラーハンドリングを実践的に学べます。