【PHP8.x】XML_ERROR_NONE定数の使い方

Copy
1<?php
2
3/**
4 * XML_ERROR_NONE 定数を使用してXMLパースのエラー状態を確認するサンプルコード。
5 *
6 * XML_ERROR_NONE は、XMLパーサーがエラーを検出していないことを示す整数定数です。
7 * xml_parser_create() で作成したパーサーでXMLをパースした後、
8 * xml_get_error_code() 関数が返す値と比較することでエラーの有無を判定します。
9 */
10function parseAndCheckXmlError(): void
11{
12    // 有効なXML文字列
13    $validXmlString = '<data><item id="1">Hello</item><item id="2">World</item></data>';
14
15    // 無効なXML文字列（閉じタグが異なる）
16    $invalidXmlString = '<data><item>Hello</item></items></data>';
17
18    // --- 有効なXMLのパース ---
19    echo "--- 有効なXMLのパース ---" . PHP_EOL;
20
21    // 1. XMLパーサーを作成
22    $parser = xml_parser_create();
23
24    // 2. XML文字列をパース
25    // xml_parse() は成功した場合に true を、失敗した場合に false を返します。
26    $parseSuccess = xml_parse($parser, $validXmlString);
27
28    if ($parseSuccess) {
29        echo "XMLパースは成功しました。" . PHP_EOL;
30        // 3. エラーコードを取得
31        $errorCode = xml_get_error_code($parser);
32
33        // 4. XML_ERROR_NONE 定数と比較してエラーがないことを確認
34        if ($errorCode === XML_ERROR_NONE) {
35            echo "エラーコードは XML_ERROR_NONE (" . XML_ERROR_NONE . ") で、エラーは検出されませんでした。" . PHP_EOL;
36        } else {
37            // このケースでは通常到達しないが、もしエラーがあれば出力
38            echo "エラーコード: " . $errorCode . " (" . xml_error_string($errorCode) . ") が検出されました。" . PHP_EOL;
39        }
40    } else {
41        // このケースでは通常到達しない
42        $errorCode = xml_get_error_code($parser);
43        echo "XMLパースに失敗しました。" . PHP_EOL;
44        echo "エラーコード: " . $errorCode . " (" . xml_error_string($errorCode) . ")" . PHP_EOL;
45    }
46
47    // 5. 使用したパーサーを解放
48    xml_parser_free($parser);
49
50    echo PHP_EOL;
51
52    // --- 無効なXMLのパース ---
53    echo "--- 無効なXMLのパース ---" . PHP_EOL;
54
55    // 新しいパーサーを作成
56    $parser = xml_parser_create();
57
58    // 無効なXML文字列をパース
59    $parseSuccess = xml_parse($parser, $invalidXmlString);
60
61    if ($parseSuccess) {
62        // このケースでは通常到達しない
63        echo "XMLパースは成功しました（無効なXMLなのに成功？）。" . PHP_EOL;
64    } else {
65        echo "XMLパースに失敗しました。" . PHP_EOL;
66        $errorCode = xml_get_error_code($parser);
67
68        // XML_ERROR_NONE 以外のエラーコードが返されることを確認
69        if ($errorCode !== XML_ERROR_NONE) {
70            echo "エラーコードは XML_ERROR_NONE ではありません。" . PHP_EOL;
71            echo "検出されたエラーコード: " . $errorCode . " (" . xml_error_string($errorCode) . ")" . PHP_EOL;
72        } else {
73            echo "エラーコードが XML_ERROR_NONE ですが、パースは失敗しました（矛盾？）。" . PHP_EOL;
74        }
75    }
76
77    // パーサーを解放
78    xml_parser_free($parser);
79}
80
81// 関数を実行
82parseAndCheckXmlError();

XML_ERROR_NONEは、PHP 8で提供されるXMLパーサー拡張機能の定数です。この定数は、XMLパーサーがXMLデータ処理中にエラーを一切検出していない「エラーなし」の状態を示す整数値（int）です。

この定数は、主にxml_parser_create()関数で作成したXMLパーサーを用いてXML文字列を処理した後に、その処理が成功したかどうか、またはエラーが発生していないかを確認する際に利用されます。具体的な使用例として、xml_parse()関数でXMLのパースを試みた後、xml_get_error_code()関数を呼び出すことで現在のパーサーのエラーコードを取得します。取得されたエラーコードがXML_ERROR_NONEと一致する場合、XMLデータは正常に処理され、エラーは発生していないと判断できます。

サンプルコードでは、まず有効なXML文字列をパースする例を示しています。この場合、xml_parse()が成功し、xml_get_error_code()はXML_ERROR_NONEを返します。これにより、エラーなくXMLが処理されたことが確認できます。次に、閉じタグが間違っている無効なXML文字列をパースする例では、xml_parse()が失敗し、xml_get_error_code()はXML_ERROR_NONEとは異なる具体的なエラーコードを返します。これにより、XMLパース中にエラーが発生したことと、その種類を特定できます。XML_ERROR_NONE定数自体には引数はなく、常にエラーがないことを示す整数値として機能します。

Copy
1<?php
2
3/**
4 * XML文字列をパースし、要素の開始/終了タグを処理します。
5 * パース中にエラーが発生した場合は、エラー情報を出力します。
6 *
7 * @param string $xmlString パースするXMLデータ
8 * @return void
9 */
10function parseXmlWithElementHandler(string $xmlString): void
11{
12    // XMLパーサを作成します。
13    $parser = xml_parser_create();
14
15    // 要素の開始タグを検出した際に呼び出されるハンドラを設定します。
16    // 無名関数 (クロージャ) を使用して、シンプルに要素名と属性を出力します。
17    xml_set_element_handler(
18        $parser,
19        function ($parser, string $name, array $attribs) {
20            echo "要素開始: " . $name . "\n";
21            if (!empty($attribs)) {
22                echo "  属性: " . print_r($attribs, true);
23            }
24        },
25        function ($parser, string $name) {
26            echo "要素終了: " . $name . "\n";
27        }
28    );
29
30    // XML文字列をパースします。
31    // xml_parse() は成功した場合に true を、失敗した場合に false を返します。
32    if (!xml_parse($parser, $xmlString)) {
33        // パースエラーが発生した場合、エラー情報を取得します。
34        $errorCode = xml_get_error_code($parser);
35
36        // XML_ERROR_NONE はエラーがないことを示す定数です。
37        // ここではエラーがあった場合（XML_ERROR_NONE ではない場合）に処理を行います。
38        if ($errorCode !== XML_ERROR_NONE) {
39            $errorString = xml_error_string($errorCode);
40            $line = xml_get_current_line_number($parser);
41            $column = xml_get_current_column_number($parser);
42            echo "XMLパースエラー: {$errorString} (コード: {$errorCode}) at line {$line}, column {$column}\n";
43        }
44    } else {
45        echo "XMLパースが成功しました。\n";
46    }
47
48    // XMLパーサが使用していたリソースを解放します。
49    xml_parser_free($parser);
50}
51
52// --- 使用例 ---
53
54// 正しいXMLデータ
55$validXml = <<<XML
56<bookstore>
57    <book category="cooking">
58        <title lang="en">Everyday Italian</title>
59        <author>Giada De Laurentiis</author>
60        <year>2005</year>
61        <price>30.00</price>
62    </book>
63    <book category="children">
64        <title lang="en">Harry Potter</title>
65        <author>J. K. Rowling</author>
66        <year>2005</year>
67        <price>29.99</price>
68    </book>
69</bookstore>
70XML;
71
72echo "--- 有効なXMLのパース例 ---\n";
73parseXmlWithElementHandler($validXml);
74
75echo "\n--- エラーを含むXMLのパース例 ---\n";
76
77// 不完全なXMLデータ（閉じタグがない）
78$invalidXml = <<<XML
79<root>
80    <item>
81        <name>Test</name>
82    <!-- <item> の閉じタグがないためエラー -->
83</root>
84XML;
85
86parseXmlWithElementHandler($invalidXml);

このPHPコードは、XML文字列を解析（パース）し、その構造に基づいて特定の処理を実行する方法と、エラーが発生した場合の対応を示しています。

まず、xml_parser_create()でXMLを解析するためのパーサを作成します。次に、xml_set_element_handler()関数を用いて、XMLの開始タグと終了タグがそれぞれ見つかったときに自動的に呼び出される「ハンドラ」（処理関数）を設定します。ここでは無名関数として定義されており、開始タグでは要素名と属性を、終了タグでは要素名を出力するようになっています。

設定後、xml_parse()関数にXML文字列を渡して解析を開始します。この関数は、パースが成功すればtrueを、失敗すればfalseという真偽値を返します。パースに失敗した場合、xml_get_error_code()関数で、どのようなエラーが発生したかを示す整数値のエラーコードを取得します。

ここで重要なのは、PHPに定義されている定数XML_ERROR_NONEです。この定数は「エラーが何も発生していない状態」を意味する整数値を持っています。コードでは、取得したエラーコードがXML_ERROR_NONEと異なる場合に、エラーが発生したと判断し、xml_error_string()などでエラーの詳細情報を取得・表示しています。

引数として受け取る$xmlStringは、解析するXMLデータそのものです。この関数は画面に出力するのみで、具体的な値を戻り値としては返しません（void）。最後に、xml_parser_free()を使って、解析器が使用していたシステムリソースを解放し、処理を終えます。このように、XMLの要素をイベントとして捉え、柔軟な処理と堅牢なエラーハンドリングを実現しています。