【PHP8.x】LibXMLError::levelプロパティの使い方

Copy
1<?php
2
3/**
4 * XML文字列を解析し、エラーの深刻度に応じて異なる処理を行う関数。
5 *
6 * この関数は、libxml拡張機能を使用してXMLのエラーを捕捉します。
7 * LibXMLErrorオブジェクトの 'level' プロパティを調べることで、
8 * エラーの深刻度（警告、エラー、致命的エラー）を判別し、
9 * それぞれの「ケアのレベル（level of care）」に応じた対応を行います。
10 *
11 * @param string $xmlString 解析するXML文字列
12 * @return void
13 */
14function checkXmlErrorLevel(string $xmlString): void
15{
16    // libxmlのエラーを内部で保持するように設定し、通常の警告・エラー出力を抑制します。
17    libxml_use_internal_errors(true);
18
19    // DOMDocumentオブジェクトを作成し、XML文字列を読み込みます。
20    $doc = new DOMDocument();
21    // @演算子で、loadXMLが出すデフォルトの警告を抑制します。
22    @$doc->loadXML($xmlString);
23
24    // libxml_get_errors() で、発生したすべてのエラーをLibXMLErrorオブジェクトの配列として取得します。
25    $errors = libxml_get_errors();
26
27    if (empty($errors)) {
28        echo "XMLは正常に解析されました。エラーはありません。" . PHP_EOL;
29    } else {
30        echo "XML解析中にエラーが検出されました。エラーのレベルに応じた対応を開始します。" . PHP_EOL;
31        echo "---" . PHP_EOL;
32
33        // 取得したエラーを一つずつ処理します。
34        foreach ($errors as $error) {
35            // $error->level プロパティにはエラーの深刻度が整数で格納されています。
36            // これを定数と比較して、エラーのレベルを判別します。
37            switch ($error->level) {
38                // LIBXML_ERR_WARNING: 警告レベル。致命的ではない問題。
39                case LIBXML_ERR_WARNING:
40                    echo "[ケアレベル: 警告]" . PHP_EOL;
41                    echo "  内容: 軽微な問題が検出されましたが、処理は続行可能です。" . PHP_EOL;
42                    echo "  詳細 (L{$error->line}): " . trim($error->message) . PHP_EOL;
43                    break;
44
45                // LIBXML_ERR_ERROR: エラーレベル。構文違反など、処理に影響する問題。
46                case LIBXML_ERR_ERROR:
47                    echo "[ケアレベル: エラー]" . PHP_EOL;
48                    echo "  内容: 文書構造に問題があります。修正が必要です。" . PHP_EOL;
49                    echo "  詳細 (L{$error->line}): " . trim($error->message) . PHP_EOL;
50                    break;
51
52                // LIBXML_ERR_FATAL: 致命的エラーレベル。解析を続行できない深刻な問題。
53                case LIBXML_ERR_FATAL:
54                    echo "[ケアレベル: 致命的]" . PHP_EOL;
55                    echo "  内容: 解析を中断せざるを得ない深刻なエラーです。即時対応してください。" . PHP_EOL;
56                    echo "  詳細 (L{$error->line}): " . trim($error->message) . PHP_EOL;
57                    break;
58            }
59            echo "---" . PHP_EOL;
60        }
61    }
62
63    // 最後に、libxmlのエラーバッファをクリアします。
64    libxml_clear_errors();
65}
66
67// 意図的に複数のエラーを含む不正なXML文字列を定義します。
68$invalidXml = <<<XML
69<?xml version="1.0" encoding="UTF-8"?>
70<document>
71    <item id=1>Item 1</item> <!-- 属性値が引用符で囲まれていない (Warning) -->
72    <user>Taro
73    <message>Hello!</message> <!-- <user>タグが閉じられていない (Error/Fatal) -->
74</document>
75XML;
76
77// 関数を実行して、エラーレベルに応じた処理を確認します。
78checkXmlErrorLevel($invalidXml);

LibXMLErrorクラスのlevelプロパティは、XMLの解析中に発生したエラーの深刻度を取得するために使用します。このプロパティは引数を取らず、エラーのレベルを示す整数（int）を返します。

このサンプルコードは、意図的にエラーを含んだXML文字列を解析し、libxml_get_errors()関数でエラー情報の配列を取得します。そして、foreachループで取得した各エラー情報を処理します。ループの中では、$error->levelという形でlevelプロパティにアクセスし、エラーの深刻度を取得しています。

取得したlevelプロパティの値は、switch文を使ってPHPの定義済み定数と比較されます。例えば、LIBXML_ERR_WARNINGは「警告」、LIBXML_ERR_ERRORは「エラー」、LIBXML_ERR_FATALは「致命的なエラー」といった具体的な深刻度に対応します。このようにlevelプロパティの値に基づいて処理を分岐させることで、エラーの重要度に応じた適切な対応、すなわち「ケアのレベル（level of care）」を分けることが可能になります。これにより、軽微な警告はログに記録し、致命的なエラーの場合は処理を中断して管理者に通知するといった制御が実現できます。

Copy
1<?php
2
3/**
4 * XMLエラーレベルを、人間が理解しやすい「ケアレベル」として解釈し、説明を返します。
5 *
6 * この関数は、ASAM (American Society of Addiction Medicine) 基準の「level of care」を
7 * 直接実装するものではなく、XMLエラーの深刻度を比喩的に表現することで、キーワード
8 * 「level of care」との関連性を持たせています。
9 *
10 * @param LibXMLError $error XMLのエラー情報を含むオブジェクト
11 * @return string エラーの深刻度に応じた説明文字列
12 */
13function getXmlErrorCareLevel(LibXMLError $error): string
14{
15    // LibXMLError::level プロパティの値に基づいて、適切なケアレベルの説明を返します。
16    // PHP 8では、int型としてこれらの定数が使用されます。
17    switch ($error->level) {
18        case LIBXML_ERR_WARNING:
19            // 警告レベル: XMLの構造に軽微な問題があるが、パースは継続できる場合。
20            return "Level 1: 軽度な懸念（例: 情報提供、自己観察を推奨）";
21        case LIBXML_ERR_ERROR:
22            // エラーレベル: XMLの構造に問題があり、パースに支障がある場合。
23            return "Level 2: 中程度の介入（例: 具体的な問題解決の支援が必要）";
24        case LIBXML_ERR_FATAL:
25            // 致命的なエラーレベル: XMLが不正で、これ以上パースを継続できない場合。
26            return "Level 3: 緊急の対応（例: 即座の介入と抜本的な修正が必須）";
27        default:
28            // 未知のエラーレベルの場合。
29            return "Level 0: 未知のエラーレベル（情報不足）";
30    }
31}
32
33// LibXMLのエラーを内部で捕捉するように設定します。
34// これにより、XMLパースエラーが発生してもPHPスクリプトの実行が中断されず、
35// libxml_get_errors() でエラー情報を取得できるようになります。
36libxml_use_internal_errors(true);
37
38// 不正なXML文字列を準備します。閉じタグが不足しているため、パースエラーが発生します。
39$malformedXml = <<<XML
40<data>
41    <item>値1</item>
42    <item>値2
43</data>
44XML;
45
46// simplexml_load_string() を使用してXML文字列をパースしようとします。
47// 不正なXMLであるため、エラーが libxml に記録されます。
48simplexml_load_string($malformedXml);
49
50// 記録されたLibXMLエラーの配列を取得します。
51$errors = libxml_get_errors();
52
53if (!empty($errors)) {
54    echo "XMLパースエラーが検出されました。\n";
55    foreach ($errors as $error) {
56        // LibXMLErrorオブジェクトの level プロパティにアクセスし、
57        // その値を getXmlErrorCareLevel 関数に渡して、人間が理解しやすい
58        // 「ケアレベル」の説明を取得・表示します。
59        echo "----------------------------------------\n";
60        echo "エラーレベル (int): " . $error->level . "\n";
61        echo "推奨ケアレベル: " . getXmlErrorCareLevel($error) . "\n";
62        echo "エラーメッセージ: " . trim($error->message) . "\n";
63        echo "発生箇所 (行:カラム): " . $error->line . ":" . $error->column . "\n";
64    }
65    echo "----------------------------------------\n";
66} else {
67    echo "XMLは正常にパースされました。エラーはありません。\n";
68}
69
70// 内部エラーハンドリングを無効に戻します（オプション）。
71// これを行わないと、以降のXML処理でもエラーが内部で捕捉され続ける可能性があります。
72libxml_use_internal_errors(false);

PHP 8で提供されるLibXMLErrorクラスのlevelプロパティは、XMLドキュメントのパース中に発生したエラーの深刻度を示す整数値（int）を返します。このプロパティは引数を取らず、XMLエラーの種類に応じて異なる整数値を持ちます。具体的には、LIBXML_ERR_WARNINGは軽微な警告、LIBXML_ERR_ERRORはパースに支障をきたす一般的なエラー、LIBXML_ERR_FATALはパースを継続できない致命的なエラーを示します。

サンプルコードでは、このlevelプロパティの値を活用し、XMLエラーの深刻度を「推奨ケアレベル」という形で人間が理解しやすいように表現するgetXmlErrorCareLevel関数が定義されています。この関数はLibXMLErrorオブジェクトを引数として受け取り、そのlevelプロパティの値に基づいて、エラーの種類に応じた説明文字列を返します。

具体的な利用例として、不正なXMLをパースする際にlibxml_use_internal_errors(true)でエラーを内部で捕捉し、libxml_get_errors()関数で取得したLibXMLErrorオブジェクトの配列を処理します。各エラーオブジェクトからlevelプロパティの値を取り出し、getXmlErrorCareLevel関数に渡すことで、どの程度の対応が必要かを示す「ケアレベル」のメッセージと、元のエラーレベル（整数値）、具体的なエラーメッセージや発生箇所が表示されます。これにより、XML処理におけるエラーの迅速な特定と適切な対応を支援します。