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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * libxml_get_errors() を使用してXMLパース時のエラーを取得するサンプル関数
7 *
8 * この関数は、意図的に不正な形式のXML文字列をパースし、
9 * libxmlが生成したエラー情報を取得してコンソールに表示します。
10 */
11function demonstrateLibxmlGetErrors(): void
12{
13    // わざと構文エラーを含むXML文字列を用意します。
14    // (</user> が </usr> になっている)
15    $invalidXml = <<<XML
16    <?xml version="1.0" encoding="UTF-8"?>
17    <document>
18        <user>
19            <name>Taro Yamada</name>
20        </usr>
21    </document>
22    XML;
23
24    // libxmlのエラーをPHPの警告として出力せず、内部的に保持するように設定します。
25    // これにより、後で libxml_get_errors() を使ってエラーを取得できます。
26    libxml_use_internal_errors(true);
27
28    // DOMDocumentオブジェクトを使ってXML文字列のパースを試みます。
29    // 不正なXMLのため、パースは失敗し、内部にエラーが記録されます。
30    // @演算子は、loadXML() が失敗時に発生させる警告を抑制します。
31    $dom = new DOMDocument();
32    @$dom->loadXML($invalidXml);
33
34    // libxml_get_errors() を呼び出して、保持されているエラー情報の配列を取得します。
35    // 戻り値は LibXMLError オブジェクトの配列です。
36    $errors = libxml_get_errors();
37
38    if (!empty($errors)) {
39        echo "XMLのパース中にエラーが検出されました。\n\n";
40
41        // 取得したエラーを一つずつループして詳細を表示します。
42        foreach ($errors as $error) {
43            // trim() はメッセージ前後の空白や改行を削除して見やすくするためです。
44            $message = trim($error->message);
45
46            echo "----------------------------------------\n";
47            echo "エラーレベル: {$error->level}\n";
48            echo "エラーコード: {$error->code}\n";
49            echo "エラーメッセージ: {$message}\n";
50            echo "発生行: {$error->line}\n";
51            echo "発生カラム: {$error->column}\n";
52        }
53        echo "----------------------------------------\n";
54    } else {
55        echo "XMLは正常にパースされました。\n";
56    }
57
58    // 次のXML処理に影響を与えないように、エラーバッファをクリアします。
59    libxml_clear_errors();
60
61    // エラーハンドリングの設定をデフォルトに戻します（推奨）。
62    libxml_use_internal_errors(false);
63}
64
65// サンプル関数を実行します。
66demonstrateLibxmlGetErrors();
67
68?>

libxml_get_errors関数は、PHPのlibxmlライブラリがXMLやHTMLデータを処理する際に発生したエラーの詳細情報を取得するために使用します。この関数は引数を取らず、エラー情報が格納された配列を返します。

この関数を正しく機能させるには、事前にlibxml_use_internal_errors(true)を呼び出し、エラーをPHPの警告として表示するのではなく、内部的に保持するように設定しておく必要があります。

サンプルコードでは、まず意図的に終了タグが間違っているXML文字列を用意しています。次に、この不正なXMLをDOMDocumentで読み込みます。この処理は失敗し、エラー情報が内部に記録されます。その後、libxml_get_errors関数を呼び出すことで、記録されたエラー情報の配列を取得します。戻り値の配列には、エラーメッセージ、エラーコード、発生箇所（行番号や列番号）といった詳細情報を含むLibXMLErrorオブジェクトが格納されています。コードでは、この配列をループ処理し、エラーの詳細を一つずつ画面に表示しています。

処理の最後には、libxml_clear_errorsでエラー情報をクリアし、libxml_use_internal_errors(false)で設定を元に戻すことが推奨されます。