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

Copy
1<?php
2
3/**
4 * LIBXML_PEDANTIC 定数の使用例を示します。
5 *
6 * この定数は libxml の厳密なエラー報告を有効にするために使用されます。
7 * XML ドキュメントの解析時に、通常は無視されるような軽微な警告もエラーとして報告させることで、
8 * より厳格なXMLの検証が可能になります。
9 * 主に DOMDocument::loadXML() や DOMDocument::load() メソッドのオプションとして使用されます。
10 */
11function demonstrateLibxmlPedantic(): void
12{
13    // libxml のエラーをPHPが内部的に収集するように設定します。
14    // これにより、libxml_get_errors() 関数でエラー情報を取得できるようになります。
15    libxml_use_internal_errors(true);
16
17    // 意図的に well-formed (整形式) ではないXML文字列を作成します。
18    // この例では、<item> タグの閉じタグが不足しています。
19    $invalidXmlString = <<<XML
20<root>
21    <item>この要素には閉じタグがありません。
22</root>
23XML;
24
25    echo "--- LIBXML_PEDANTIC を使用してXMLをロードする例 ---\n";
26    echo "ロードしようとしているXML:\n";
27    echo $invalidXmlString . "\n\n";
28
29    $dom = new DOMDocument();
30
31    // DOMDocument::loadXML() メソッドのオプションとして LIBXML_PEDANTIC を渡します。
32    // この定数により、libxml は厳密なエラーチェックを行い、パースエラーをより詳細に報告します。
33    // '@' 演算子は、PHPが通常発生させる警告メッセージを抑制しますが、
34    // libxml_use_internal_errors(true) の設定により、libxml のエラーは捕捉されます。
35    if (@$dom->loadXML($invalidXmlString, LIBXML_PEDANTIC)) {
36        echo "LIBXML_PEDANTIC を使用してXMLのロードに成功しました。\n";
37        // 成功した場合でも、警告レベルのエラーが発生している可能性があるため、確認します。
38        $errors = libxml_get_errors();
39        if (!empty($errors)) {
40            echo "しかし、以下の警告/エラーが検出されました:\n";
41            foreach ($errors as $error) {
42                // libXMLError オブジェクトの各プロパティを出力
43                echo "  - [レベル: " . $error->level . ", コード: " . $error->code . "] " . trim($error->message) . " (行: " . $error->line . ", カラム: " . $error->column . ")\n";
44            }
45        }
46    } else {
47        echo "LIBXML_PEDANTIC を使用してXMLのロードに失敗しました。\n";
48        $errors = libxml_get_errors();
49        if (!empty($errors)) {
50            echo "検出されたエラー:\n";
51            foreach ($errors as $error) {
52                // libXMLError オブジェクトの各プロパティを出力
53                echo "  - [レベル: " . $error->level . ", コード: " . $error->code . "] " . trim($error->message) . " (行: " . $error->line . ", カラム: " . $error->column . ")\n";
54            }
55        } else {
56            echo "エラーが検出されましたが、libxml_get_errors() からは詳細を取得できませんでした。\n";
57        }
58    }
59
60    // libxml の内部エラーバッファをクリアします。
61    // これをしないと、次の libxml 処理で以前のエラーが残ってしまう可能性があります。
62    libxml_clear_errors();
63}
64
65// 関数を実行して LIBXML_PEDANTIC の動作を確認します。
66demonstrateLibxmlPedantic();

PHPのLIBXML_PEDANTIC定数は、XML文書を解析する際に、通常は無視される軽微な警告もエラーとして厳密に報告させるためのオプションです。この定数はlibxml拡張機能の一部で、引数はなく、内部的には整数値（int）として扱われます。

主にDOMDocument::loadXML()やDOMDocument::load()などのメソッドにオプションとして渡すことで、XMLの構文や構造における潜在的な不備を詳細に検出できます。これにより、XMLデータの品質を向上させ、堅牢なシステム構築に役立ちます。

サンプルコードでは、閉じタグのない不正なXMLをLIBXML_PEDANTICオプション付きでロードする例を示しています。libxml_use_internal_errors(true)を設定することで、PHPがlibxmlのエラーを内部的に収集し、libxml_get_errors()関数でエラーレベルやメッセージ、行、カラムといった具体的な情報を取得しています。この定数を利用することで、XMLの不整合箇所がより明確に報告され、問題特定が容易になります。

Copy
1<?php
2
3/**
4 * LIBXML_PEDANTIC 定数の使用例。
5 *
6 * LIBXML_PEDANTIC は、XMLパース時にW3C XML勧告に厳密に準拠するよう、
7 * より厳格なエラーチェックを有効にするためのフラグです。
8 * これは、libxml2ライブラリのパース挙動を調整するために使用されます。
9 *
10 * この関数は、XML文字列を厳格モード (LIBXML_PEDANTIC 有効) と非厳格モードで
11 * ロードし、その動作の違い (またはその欠如) を示します。
12 *
13 * @param string $xmlString パースするXML文字列
14 */
15function demonstrateLibxmlPedantic(string $xmlString): void
16{
17    echo "--- XML文字列のパース例 ---" . PHP_EOL;
18    echo "XML:\n" . $xmlString . PHP_EOL . PHP_EOL;
19
20    // libxmlのエラーハンドリングを有効にする
21    // これにより、パース中に発生した警告やエラーをPHP内で捕捉できるようになります。
22    libxml_use_internal_errors(true);
23
24    // 1. 非厳格モードでのXMLパース
25    echo "=== 非厳格モード (LIBXML_PEDANTIC なし) ===" . PHP_EOL;
26    $dom = new DOMDocument();
27    // オプションなしでXMLをロード
28    $loaded = $dom->loadXML($xmlString);
29
30    if ($loaded) {
31        echo "XMLのパースに成功しました。\n";
32    } else {
33        echo "XMLのパースに失敗しました。\n";
34    }
35
36    // エラー情報を取得して表示
37    $errors = libxml_get_errors();
38    if (!empty($errors)) {
39        echo "捕捉されたエラー／警告:\n";
40        foreach ($errors as $error) {
41            // エラーレベル: LIBXML_ERR_WARNING (1), LIBXML_ERR_ERROR (2), LIBXML_ERR_FATAL (3)
42            $levelName = match ($error->level) {
43                LIBXML_ERR_WARNING => 'Warning',
44                LIBXML_ERR_ERROR   => 'Error',
45                LIBXML_ERR_FATAL   => 'Fatal Error',
46                default            => 'Unknown',
47            };
48            echo "  - Level: {$levelName} (Code: {$error->code}), Message: " . trim($error->message) . "\n";
49        }
50    } else {
51        echo "エラーや警告は発生しませんでした。\n";
52    }
53    // エラー情報をクリアする (次のパースのために重要)
54    libxml_clear_errors();
55    echo PHP_EOL;
56
57    // 2. 厳格モードでのXMLパース (LIBXML_PEDANTIC を使用)
58    echo "=== 厳格モード (LIBXML_PEDANTIC 有効) ===" . PHP_EOL;
59    $dom = new DOMDocument();
60    // LIBXML_PEDANTIC オプションを付けてXMLをロード
61    $loaded = $dom->loadXML($xmlString, LIBXML_PEDANTIC);
62
63    if ($loaded) {
64        echo "XMLのパースに成功しました。\n";
65    } else {
66        echo "XMLのパースに失敗しました。\n";
67    }
68
69    // エラー情報を取得して表示
70    $errors = libxml_get_errors();
71    if (!empty($errors)) {
72        echo "捕捉されたエラー／警告:\n";
73        foreach ($errors as $error) {
74            $levelName = match ($error->level) {
75                LIBXML_ERR_WARNING => 'Warning',
76                LIBXML_ERR_ERROR   => 'Error',
77                LIBXML_ERR_FATAL   => 'Fatal Error',
78                default            => 'Unknown',
79            };
80            echo "  - Level: {$levelName} (Code: {$error->code}), Message: " . trim($error->message) . "\n";
81        }
82    } else {
83        echo "エラーや警告は発生しませんでした。\n";
84    }
85    libxml_clear_errors();
86    echo PHP_EOL;
87
88    // libxmlのエラーハンドリングを元の状態に戻す（オプション）
89    libxml_use_internal_errors(false);
90}
91
92// -----------------------------------------------------------------------------
93// サンプルXMLの定義と実行
94// -----------------------------------------------------------------------------
95
96// 例1: 存在しない外部DTDを参照するXML
97// LIBXML_PEDANTIC の有無にかかわらず、libxml2は通常、外部DTDの読み込み失敗に対して
98// 警告を発します。厳格モードでは、これらの警告のレベルが上がったり、より詳細な情報が
99// 提供されたりする場合がありますが、この例では大きな違いが見られないこともあります。
100$xml1 = <<<'EOT'
101<?xml version="1.0" encoding="UTF-8"?>
102<!DOCTYPE root SYSTEM "nonexistent.dtd">
103<root>
104    <item>データ</item>
105</root>
106EOT;
107demonstrateLibxmlPedantic($xml1);
108
109echo str_repeat("=", 60) . PHP_EOL . PHP_EOL;
110
111// 例2: 整形式で、一般的なXML勧告に準拠しているXML
112// このようなXMLでは、LIBXML_PEDANTIC を有効にしても、通常は追加のエラーや警告は発生しません。
113// LIBXML_PEDANTIC は、より微妙な勧告違反を見つけるために使用されることが多いため、
114// 厳密な規約違反がない場合は挙動に変化はありません。
115$xml2 = <<<'EOT'
116<?xml version="1.0" encoding="UTF-8"?>
117<bookstore>
118  <book category="cooking">
119    <title lang="en">Everyday Italian</title>
120    <author>Giada De Laurentiis</author>
121    <year>2005</year>
122    <price>30.00</price>
123  </book>
124  <book category="children">
125    <title lang="en">Harry Potter</title>
126    <author>J.K. Rowling</author>
127    <year>2005</year>
128    <price>29.99</price>
129  </book>
130</bookstore>
131EOT;
132demonstrateLibxmlPedantic($xml2);

LIBXML_PEDANTICは、PHPでXMLをパースする際に、W3C XML勧告に厳密に準拠したエラーチェックを有効にするための定数です。この定数は内部的に整数値を持ち、DOMDocument::loadXML()などのXML読み込み関数のオプション引数として使用されます。

サンプルコードでは、同じXML文字列をLIBXML_PEDANTICを「指定しないモード（非厳格）」と「指定するモード（厳格）」の二通りでパースしています。各モードでパース後にlibxml_get_errors()関数を使い、XMLパース中に発生した警告やエラーを捕捉し、その検出の違いを比較しています。

厳格モードを有効にすると、XMLの形式が勧告にわずかに違反している場合でも、それを詳細な警告やエラーとして検出できるようになります。これにより、XMLの品質と整合性を向上させ、通常は見過ごされがちな構文上の問題を特定するのに役立ちます。