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

Copy
1<?php
2
3/**
4 * LIBXML_RECOVER 定数を使用して、エラーのあるHTMLをパースする例。
5 *
6 * LIBXML_RECOVER は、XML/HTMLパース時に構文エラーが発生した場合でも、
7 * 可能な限り回復を試み、パースを続行させるためのオプションです。
8 * これにより、一部に問題があるドキュメントからでも情報を抽出できるようになります。
9 */
10function parseHtmlWithRecovery(): void
11{
12    // 意図的に閉じタグが不正なHTML文字列を用意
13    $htmlString = <<<HTML
14<!DOCTYPE html>
15<html>
16<head>
17    <title>不正なHTMLの例</title>
18</head>
19<body>
20    <h1>サンプルタイトル</h1>
21    <p>この段落は正しく閉じられていません。<p>
22    <div>
23        <ul>
24            <li>リストアイテム1</li>
25            <li>リストアイテム2</li>
26        </ul>
27    </div>
28    <span>これは<span>閉じタグが二重です。</span>
29</body>
30</html>
31HTML;
32
33    echo "--- LIBXML_RECOVER オプションを使ってHTMLをパース ---" . PHP_EOL;
34
35    // libxmlのエラーをPHPの警告として表示せず、内部で処理するように設定します。
36    // これにより、libxml_get_errors() でエラー情報を取得できます。
37    libxml_use_internal_errors(true);
38
39    $dom = new DOMDocument();
40    // DOMDocument::loadHTML() メソッドでHTMLを読み込みます。
41    // 第二引数に LIBXML_RECOVER を渡すことで、パースエラーからの回復を試みます。
42    if ($dom->loadHTML($htmlString, LIBXML_RECOVER)) {
43        echo "HTMLのパースに成功しました（エラーからの回復を試行）。" . PHP_EOL;
44
45        // パースされたDOMツリーからタイトルタグの内容を取得して表示
46        $titleElements = $dom->getElementsByTagName('title');
47        if ($titleElements->length > 0) {
48            echo "ページのタイトル: " . $titleElements->item(0)->textContent . PHP_EOL;
49        }
50
51        // パースされたDOMツリーからボディタグの内容を抽出し、整形して表示
52        // 不正な部分があっても、可能な限り構造を復元しようとします。
53        $body = $dom->getElementsByTagName('body')->item(0);
54        if ($body) {
55            echo PHP_EOL . "--- パースされたボディコンテンツの抜粋 ---" . PHP_EOL;
56            // saveHTML() は、特定のノード以下のHTMLを文字列として返します
57            echo $dom->saveHTML($body) . PHP_EOL;
58            echo "--- 抜粋ここまで ---" . PHP_EOL;
59        }
60
61    } else {
62        echo "HTMLのパースに失敗しました。" . PHP_EOL;
63    }
64
65    // libxml_get_errors() で、パース中に発生したエラー情報を取得して表示します。
66    // LIBXML_RECOVER を使用しても、エラー自体は報告されますが、パースは継続されます。
67    $errors = libxml_get_errors();
68    if (!empty($errors)) {
69        echo PHP_EOL . "--- 検出されたパースエラー (LIBXML_RECOVER使用時) ---" . PHP_EOL;
70        foreach ($errors as $error) {
71            echo sprintf(
72                "エラー %s (レベル: %s): %s (行: %d, 列: %d)",
73                $error->code,
74                $error->level === LIBXML_ERR_WARNING ? '警告' : ($error->level === LIBXML_ERR_ERROR ? 'エラー' : '致命的'),
75                trim($error->message),
76                $error->line,
77                $error->column
78            ) . PHP_EOL;
79        }
80    } else {
81        echo "エラーは検出されませんでした。" . PHP_EOL;
82    }
83
84    // libxmlのエラーハンドリングをデフォルトの状態に戻します。
85    libxml_clear_errors();
86    libxml_use_internal_errors(false);
87}
88
89// 関数を実行して、LIBXML_RECOVER の動作を確認します。
90parseHtmlWithRecovery();

LIBXML_RECOVERは、PHP 8で利用できるlibxml拡張機能に属する定数です。これは、XMLやHTMLのパース（解析）時に、構文エラーが発生した場合でも、プログラムがエラーで停止せず、可能な限り回復を試みてパースを続行させるためのオプションとして利用されます。この定数自体に引数はなく、内部的には整数の値を持ちます。

サンプルコードでは、意図的に閉じタグが不正なHTML文字列を用意し、DOMDocumentクラスのloadHTML()メソッドにLIBXML_RECOVERを第二引数として渡しています。これにより、通常であればパースエラーで処理が中断されがちな不正なHTMLでも、LIBXML_RECOVERがエラー箇所を修正または無視して解析を続行し、DOMツリーを構築しようとします。その結果、一部に問題があるドキュメントからでも、タイトルやボディの内容などの情報を抽出できるようになります。

また、libxml_use_internal_errors(true)を設定することで、パース中に発生したエラーをPHPの警告として直接表示せず、libxml_get_errors()関数で後から詳細なエラー情報を取得することが可能になります。LIBXML_RECOVERを使用してもエラー自体は記録されますが、パースは中断されずに継続されるため、不完全なドキュメントから最大限の情報を引き出す場面で非常に有効な定数です。

Copy
1<?php
2
3/**
4 * LIBXML_RECOVER 定数を使用して、エラーのあるXMLをパースし、回復を試みるサンプルコードです。
5 *
6 * LIBXML_RECOVER は、XMLドキュメントのパース中に構文エラーが発生した場合でも、
7 * libxml2ライブラリが可能な限りエラーを無視し、処理を継続するためのオプション（定数）です。
8 * これは主に、DOMDocument::loadXML() や simplexml_load_string() などの関数で、
9 * オプションとして渡すことで利用されます。
10 */
11function demonstrateLibxmlRecover(): void
12{
13    // 意図的に構造に誤りがあるXML文字列を定義
14    // - <item id=2> の id 属性値が引用符で囲まれていない (XMLの構文エラー)
15    // - <item id="3"> の閉じタグ </item> が不足している (XMLの構文エラー)
16    $brokenXml = <<<XML
17<?xml version="1.0" encoding="UTF-8"?>
18<root>
19    <item id="1">
20        <name>First Item</name>
21    </item>
22    <item id=2> 
23        <name>Second Item</name>
24    </item>
25    <item id="3">
26        <name>Third Item</name> 
27</root>
28XML;
29
30    echo "--- LIBXML_RECOVER を使用してエラーのあるXMLをパースし、回復を試みます --- \n\n";
31
32    // libxml2 が発生させるエラーをPHPのWarningとして出力せず、内部でキャッチするように設定します。
33    // これにより、libxml_get_errors() でエラーの詳細を取得できるようになります。
34    libxml_use_internal_errors(true);
35
36    // DOMDocument オブジェクトを初期化
37    $dom = new DOMDocument();
38
39    // DOMDocument::loadXML() の第二引数に LIBXML_RECOVER 定数を渡すことで、
40    // XMLの構文エラーを無視して可能な限りパースを試みます。
41    // @演算子は、loadXML が内部的に発生させる可能性のあるPHP Warningを抑制します。
42    if (@$dom->loadXML($brokenXml, LIBXML_RECOVER)) {
43        echo "XMLのパースと回復が成功しました。検出されたエラーを無視して処理を継続しました。\n";
44        echo "回復後のXMLの内容（一部）:\n";
45
46        // パースされたXMLから 'item' タグの要素を取得し、表示
47        $items = $dom->getElementsByTagName('item');
48        foreach ($items as $item) {
49            $id = $item->getAttribute('id');
50            // PHP 8.0 以降で利用可能なNullsafe operator (?) を使用
51            $name = $item->getElementsByTagName('name')->item(0)?->textContent;
52            echo "  - Item ID: " . ($id ?: 'N/A') . ", Name: " . ($name ?: 'N/A') . "\n";
53        }
54    } else {
55        echo "LIBXML_RECOVER を使用しましたが、XMLのパースと回復に失敗しました。\n";
56    }
57
58    // パース中に libxml2 が内部で記録したエラーメッセージを取得
59    $errors = libxml_get_errors();
60    if (!empty($errors)) {
61        echo "\nパース中に検出されたLIBXMLエラーの詳細:\n";
62        foreach ($errors as $error) {
63            // エラーレベル(LIBXML_ERR_WARNING, LIBXML_ERR_ERRORなど)、コード、メッセージなどを表示
64            echo "  - レベル: {$error->level}, コード: {$error->code}, メッセージ: {$error->message}";
65        }
66    }
67
68    // libxml2 のエラー情報をクリアし、内部エラーモードを元の状態に戻します。
69    libxml_clear_errors();
70    libxml_use_internal_errors(false);
71}
72
73// サンプル関数を実行して、LIBXML_RECOVER の動作を確認します。
74demonstrateLibxmlRecover();
75
76?>

PHPのLIBXML_RECOVERは、libxml2拡張機能が提供する定数で、XMLドキュメントのパース中に発生した構文エラーを無視し、可能な限り処理を継続することを目的としています。主にDOMDocument::loadXML()やsimplexml_load_string()などの関数にオプションとして渡して利用されます。この定数を使用すると、厳密なXML構文に従っていないドキュメントであっても、部分的に有効なデータを抽出できる可能性が高まります。

サンプルコードでは、閉じタグの不足や属性値の引用符忘れといった意図的な構文エラーを含むXML文字列を定義しています。libxml_use_internal_errors(true)を設定することで、XMLパース中に発生するエラーがPHPのWarningとして表示されるのを防ぎ、内部で捕捉します。その後、DOMDocument::loadXML()の第二引数にLIBXML_RECOVER定数を指定してXMLの解析を試みます。

これにより、通常であればパース失敗となるようなXMLでも、LIBXML_RECOVERオプションがエラーを無視して処理を継続するため、エラーのあるXMLを成功裏にパースし、有効なitem要素からIDや名前などのデータを取得できます。パース中に無視されたエラーの詳細は、libxml_get_errors()関数で後から確認することが可能です。この定数自体は引数を取らず、その値は整数型です。システムが不完全なXMLデータを扱う際に、堅牢性を向上させるのに役立ちます。