【PHP8.x】DOMDocument::strictErrorCheckingプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMDocumentのstrictErrorCheckingプロパティの動作を示すサンプルコードです。
5 * このプロパティは、XMLパース時のエラーチェックの厳格さを制御します。
6 *
7 * 不正なXML文字列をパースし、strictErrorCheckingがtrueとfalseの場合の
8 * 挙動の違いを示します。特に「php strict standards」という文脈では、
9 * XMLの形式が厳密であるべきか、ある程度の許容範囲を持たせるかの選択になります。
10 */
11function demonstrateStrictErrorChecking(): void
12{
13    echo "--- DOMDocument::strictErrorCheckingのデモンストレーション ---\n\n";
14
15    // 意図的に不正なXML文字列を準備します（<item>タグの閉じが欠落し、<root>タグが早めに閉じられている）
16    // このXMLは「整形式」ではありません。
17    $invalidXml = '<root><item>Text</root>';
18
19    echo "対象XML:\n" . htmlspecialchars($invalidXml) . "\n\n";
20
21    // PHPのLibXMLエラー出力を内部にリダイレクトし、手動で取得できるようにします。
22    // これにより、PHPが直接警告を出力するのを防ぎ、エラーの内容を比較しやすくなります。
23    libxml_use_internal_errors(true);
24
25    // ----------------------------------------------------
26    // strictErrorChecking が true の場合 (厳格なチェック)
27    // ----------------------------------------------------
28    echo "1. strictErrorChecking が true の場合 (厳格なチェック):\n";
29    $domTrue = new DOMDocument();
30    $domTrue->strictErrorChecking = true; // 厳格なエラーチェックを有効にする
31
32    echo "  -> XMLのパースを試行中...\n";
33    $loadSuccessTrue = $domTrue->loadXML($invalidXml);
34
35    if (!$loadSuccessTrue) {
36        echo "  XMLのパースに失敗しました。検出されたエラー:\n";
37        foreach (libxml_get_errors() as $error) {
38            echo "    LIBXMLエラー: " . trim($error->message) . "\n";
39        }
40    } else {
41        echo "  XMLのパースに成功しました。\n";
42    }
43    libxml_clear_errors(); // エラーバッファをクリアします
44    echo "\n";
45
46    // ----------------------------------------------------
47    // strictErrorChecking が false の場合 (緩やかなチェック)
48    // ----------------------------------------------------
49    echo "2. strictErrorChecking が false の場合 (緩やかなチェック):\n";
50    $domFalse = new DOMDocument();
51    $domFalse->strictErrorChecking = false; // 緩やかなエラーチェックを有効にする
52
53    echo "  -> XMLのパースを試行中...\n";
54    $loadSuccessFalse = $domFalse->loadXML($invalidXml);
55
56    if (!$loadSuccessFalse) {
57        echo "  XMLのパースに失敗しました。検出されたエラー（一部が無視される場合があります）:\n";
58        foreach (libxml_get_errors() as $error) {
59            echo "    LIBXMLエラー: " . trim($error->message) . "\n";
60        }
61    } else {
62        echo "  XMLのパースに成功しました。（一部のエラーは無視されることがあります）\n";
63    }
64    libxml_clear_errors(); // エラーバッファをクリアします
65    echo "\n";
66
67    // 内部エラー機能を元の状態に戻します。
68    libxml_use_internal_errors(false);
69
70    echo "--- 結論 ---\n";
71    echo "strictErrorCheckingがtrueの場合、XMLの形式がわずかでも不正だと、\n";
72    echo "パースが失敗しやすくなります。検出されるエラーも多くなります。\n\n";
73    echo "strictErrorCheckingがfalseの場合、一部のエラーは無視され、\n";
74    echo "パースが試みられますが、この例のように深刻なエラーではそれでも失敗することがあります。\n";
75    echo "しかし、検出されるエラーの数は減ることが確認できます。\n\n";
76    echo "通常はtrueに設定し、厳格なXML標準に準拠することをお勧めします。\n";
77    echo "これは「php strict standards」という言葉が示すように、堅牢で予測可能なコードを書く上で重要です。\n";
78}
79
80// 関数の実行
81demonstrateStrictErrorChecking();
82

PHPのDOMDocumentクラスにあるstrictErrorCheckingプロパティは、XMLドキュメントを読み込む際に、XMLの形式が正しいかをどれくらい厳しくチェックするかを制御するブール値のプロパティです。このプロパティは引数を取らず、現在の設定状態をtrueまたはfalseとして示します。

trueに設定すると、XMLの記述にわずかな誤りがあっても厳格にチェックし、パースを失敗させることが多くなります。これにより、XMLがW3Cの標準に完全に準拠していることを保証し、予期せぬ動作を防ぎます。サンプルコードでは、閉じタグが不足した不正なXMLに対して、この設定がtrueだとパースが失敗し、詳細なエラーが報告される様子が確認できます。

一方、falseに設定すると、一部の軽微なXMLエラーは無視され、パースが試みられます。これにより、多少不完全なXMLでも処理を続行できる場合がありますが、データの整合性が損なわれるリスクも伴います。サンプルコードでは、falseの場合でも深刻なエラーではパースに失敗しますが、報告されるエラーの数が減ることを示しています。

「php strict standards」という文脈では、通常strictErrorCheckingをtrueに設定することが推奨されます。これは、堅牢で安定したシステムを構築するために、XMLの形式を厳密に保つことが重要であるためです。

Copy
1<?php
2
3declare(strict_types=1); // PHPスクリプト全体の厳密な型チェックを有効にします。
4
5/**
6 * DOMDocumentのstrictErrorCheckingプロパティの挙動をデモンストレーションします。
7 * このプロパティは、DOM操作におけるエラーチェックの厳密性を制御します。
8 * PHPの厳密な型チェック (strict_types=1) とは別の、DOM操作に特化したエラーチェックです。
9 */
10function demonstrateDomStrictErrorChecking(): void
11{
12    echo "--- DOMDocument::strictErrorChecking プロパティのデモンストレーション ---" . PHP_EOL;
13    echo "このプロパティは、DOMツリー操作時にエラーを厳しくチェックするかどうかを決定します。" . PHP_EOL;
14    echo "trueの場合、不正な操作は通常DOMExceptionをスローします。" . PHP_EOL . PHP_EOL;
15
16    // libxmlのエラーをPHP内部で処理するように設定します。
17    // これにより、DOMDocument::loadXML()などで発生したXMLパースエラーを
18    // libxml_get_errors()で捕捉できるようになります。
19    libxml_use_internal_errors(true);
20
21    // DOMDocumentのインスタンスを作成します。
22    $dom = new DOMDocument();
23
24    // 1. strictErrorChecking の現在の値 (デフォルト) を確認します。
25    // デフォルトでは true (厳密なエラーチェックが有効) です。
26    echo "1. デフォルトの strictErrorChecking の値: " . ($dom->strictErrorChecking ? 'true' : 'false') . PHP_EOL;
27
28    // 意図的に閉じタグが不足している不正なXMLを作成します。
29    $invalidXml = '<root><item>テストデータ</item><item>';
30
31    echo PHP_EOL . "--- strictErrorChecking が true の場合 (デフォルト) ---" . PHP_EOL;
32    // 明示的に true に設定 (通常はデフォルトでtrue)
33    $dom->strictErrorChecking = true;
34    libxml_clear_errors(); // 既存のlibxmlエラーをクリア
35
36    echo "不正なXMLをロードしようとします: " . htmlspecialchars($invalidXml) . PHP_EOL;
37    try {
38        // strictErrorChecking が true の場合、loadXML は不正なXMLに対してDOMExceptionをスローすることがあります。
39        // また、戻り値は false になります。
40        $result = $dom->loadXML($invalidXml);
41        if (!$result) {
42            echo "  結果: XMLのロードに失敗しました (loadXML() の戻り値が false)。" . PHP_EOL;
43            // libxml_get_errors() で詳細なエラー情報を取得できます。
44            foreach (libxml_get_errors() as $error) {
45                echo "    LIBXMLエラー: " . trim($error->message) . PHP_EOL;
46            }
47        } else {
48            echo "  結果: XMLがロードされました (予期せぬ成功)。" . PHP_EOL;
49        }
50    } catch (DOMException $e) {
51        // PHP 8では、strictErrorChecking が true の場合、不正なXMLロードでDOMExceptionが発生します。
52        echo "  結果: DOMException が発生しました: " . $e->getMessage() . PHP_EOL;
53    }
54
55    echo PHP_EOL . "--- strictErrorChecking を false に設定した場合 ---" . PHP_EOL;
56    // strictErrorChecking を false に設定し、エラーチェックを緩和します。
57    $dom->strictErrorChecking = false;
58    libxml_clear_errors(); // 既存のlibxmlエラーをクリア
59
60    echo "不正なXMLをロードしようとします: " . htmlspecialchars($invalidXml) . PHP_EOL;
61    try {
62        // strictErrorChecking が false の場合、loadXML はDOMExceptionをスローせず、
63        // 戻り値で失敗を示す (false) ことが期待されます。
64        $result = $dom->loadXML($invalidXml);
65        if (!$result) {
66            echo "  結果: XMLのロードに失敗しました (loadXML() の戻り値が false)。" . PHP_EOL;
67            // DOMExceptionは発生しませんが、libxmlエラーは発生します。
68            foreach (libxml_get_errors() as $error) {
69                echo "    LIBXMLエラー: " . trim($error->message) . PHP_EOL;
70            }
71        } else {
72            echo "  結果: XMLがロードされました (予期せぬ成功)。" . PHP_EOL;
73        }
74    } catch (DOMException $e) {
75        // strictErrorChecking が false の場合は、DOMExceptionは通常発生しません。
76        echo "  結果: DOMException が発生しました (予期せぬ例外): " . $e->getMessage() . PHP_EOL;
77    }
78
79    // 最後に strictErrorChecking の現在の値を確認します。
80    echo PHP_EOL . "2. 現在の strictErrorChecking の値: " . ($dom->strictErrorChecking ? 'true' : 'false') . PHP_EOL;
81
82    // libxmlのエラーハンドリングをデフォルトに戻します (オプション)。
83    libxml_use_internal_errors(false);
84    libxml_clear_errors();
85}
86
87// 関数を実行します。
88demonstrateDomStrictErrorChecking();

PHPのDOMDocument::strictErrorCheckingは、XMLドキュメントを操作する際にエラーチェックをどの程度厳密に行うかを設定するプロパティです。このプロパティはブール値（trueまたはfalse）を保持し、デフォルトではtrueに設定されています。

trueに設定されている場合、DOM操作中に不正なXML構造などが検出されると、通常はDOMExceptionがスローされたり、関連するメソッドがfalseを返すことで処理の失敗を厳しく通知します。これにより、開発者はXMLデータの問題点を早期に特定し、適切なエラーハンドリングを実装できます。

falseに設定するとエラーチェックが緩和され、一部の不正な操作でもDOMExceptionがスローされることなく、可能な限りDOMツリーの構築を試みます。この場合、メソッドの戻り値がfalseとなることで操作の失敗が示されることが多いですが、例外は発生しないため、より柔軟なエラー処理が必要な場合に利用されます。

サンプルコードでは、閉じタグが不足している不正なXMLをDOMDocument::loadXML()メソッドで読み込む際の挙動を、strictErrorCheckingがtrueの場合とfalseの場合で比較しています。trueではDOMExceptionの発生や明確な失敗が示され、falseでは例外なしで失敗が通知される様子が確認できます。なお、declare(strict_types=1)はPHP全体の型チェックを厳密にするもので、本プロパティによるDOMのエラーチェックとは異なる点にご留意ください。libxml_use_internal_errors(true)と組み合わせることで、XML解析に関する詳細なエラーメッセージも捕捉できるようになります。