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

Copy
1<?php
2
3/**
4 * DOMDocument::validateOnParse プロパティのデモンストレーションを行います。
5 * このプロパティは、XMLをパースする際にDTD検証を行うかどうかを制御します。
6 * validateOnParseがtrueの場合、DTDに準拠しないXMLはパース時にエラーとなります。
7 */
8function demonstrateDomValidationOnParse(): void
9{
10    // libxml の内部エラーハンドリングを有効にし、XMLパース時の警告やエラーを捕捉できるようにします。
11    libxml_use_internal_errors(true);
12
13    $dom = new DOMDocument();
14    // 整形されたXML出力を有効にします。これはデモンストレーションの表示を分かりやすくするためです。
15    $dom->formatOutput = true;
16
17    echo "--- DOMDocument::validateOnParse プロパティのデモンストレーション ---\n\n";
18
19    // 1. DOMDocument::validateOnParse のデフォルト値を確認します。
20    echo "1. DOMDocument::validateOnParse のデフォルト値: "
21        . ($dom->validateOnParse ? 'true' : 'false') . "\n\n";
22
23    // 2. DOMDocument::validateOnParse を true に設定します。
24    // これにより、loadXML() や load() メソッドでXMLを読み込む際にDTD検証が有効になります。
25    $dom->validateOnParse = true;
26    echo "2. DOMDocument::validateOnParse を true に設定しました。\n"
27        . "   現在の値: " . ($dom->validateOnParse ? 'true' : 'false') . "\n\n";
28
29    // 3. DTD に準拠する有効な XML を定義し、読み込みます。
30    // ここでは、data URI を使って DTD をインラインで指定しています。
31    // このDTDは、ルート要素 'root' の中に、ゼロ個以上の 'item' 要素のみを許可します。
32    $validXmlWithDtd = <<<XML
33<!DOCTYPE root SYSTEM "data:text/plain,<!ELEMENT root (item*)><!ELEMENT item (#PCDATA)>">
34<root>
35    <item>Valid Item 1</item>
36    <item>Valid Item 2</item>
37</root>
38XML;
39
40    echo "3. DTD に準拠する有効な XML を読み込みます。\n";
41    echo "   [XML]\n{$validXmlWithDtd}\n";
42    libxml_clear_errors(); // 前回までのエラーをクリア
43    if ($dom->loadXML($validXmlWithDtd)) {
44        echo "   -> 成功: XML は DTD 検証に合格し、正常に読み込まれました。\n";
45    } else {
46        echo "   -> 失敗: XML の読み込みに失敗しました。\n";
47    }
48    displayLibxmlErrors(); // エラーがないことを確認
49    echo "\n";
50
51    // 4. DTD に準拠しない不正な XML を定義し、読み込みます。
52    // ルート要素 'root' の中に、DTDで許可されていない 'invalid-tag' 要素を含めます。
53    $invalidXmlWithDtd = <<<XML
54<!DOCTYPE root SYSTEM "data:text/plain,<!ELEMENT root (item*)><!ELEMENT item (#PCDATA)>">
55<root>
56    <item>Valid Item</item>
57    <invalid-tag>このタグはDTDで許可されていません</invalid-tag>
58</root>
59XML;
60
61    echo "4. DTD に準拠しない不正な XML を読み込みます。\n";
62    echo "   [XML]\n{$invalidXmlWithDtd}\n";
63    libxml_clear_errors(); // 前回までのエラーをクリア
64    if ($dom->loadXML($invalidXmlWithDtd)) {
65        echo "   -> 成功: XML は DTD 検証に合格し、正常に読み込まれました。(これはvalidateOnParseがtrueの場合には予想外です)\n";
66    } else {
67        echo "   -> 失敗: XML の読み込みに失敗しました。(DTD 検証エラーが予想されます)\n";
68    }
69    displayLibxmlErrors(); // エラーがあることを確認
70    echo "\n";
71
72    // 5. validateOnParse が false の場合と比較します。
73    // validateOnParse を false に戻します。
74    $dom->validateOnParse = false;
75    echo "5. DOMDocument::validateOnParse を false に設定しました。\n"
76        . "   現在の値: " . ($dom->validateOnParse ? 'true' : 'false') . "\n\n";
77
78    echo "   validateOnParse が false の場合、上記不正な XML を再度読み込みます。\n";
79    echo "   [XML]\n{$invalidXmlWithDtd}\n";
80    libxml_clear_errors(); // エラーをクリア
81    if ($dom->loadXML($invalidXmlWithDtd)) {
82        echo "   -> 成功: XML は正常に読み込まれました。(DTD 検証はスキップされました)\n";
83    } else {
84        echo "   -> 失敗: XML の読み込みに失敗しました。\n";
85    }
86    displayLibxmlErrors(); // エラーがないことを確認
87    echo "\n";
88
89    // libxml の内部エラーハンドリングを元の状態に戻します。（スクリプトのクリーンアップ）
90    libxml_use_internal_errors(false);
91}
92
93/**
94 * libxml_get_errors() で取得したエラーを表示し、クリアするヘルパー関数です。
95 */
96function displayLibxmlErrors(): void
97{
98    $errors = libxml_get_errors();
99    if (!empty($errors)) {
100        echo "   --- libxml エラー詳細 ---\n";
101        foreach ($errors as $error) {
102            echo "   [レベル: {$error->level}] [コード: {$error->code}] " . rtrim($error->message) . "\n";
103            if ($error->file) {
104                echo "     ファイル: {$error->file}";
105            }
106            if ($error->line) {
107                echo " 行: {$error->line}";
108            }
109            if ($error->column) {
110                echo " 列: {$error->column}";
111            }
112            echo "\n";
113        }
114        echo "   --------------------------\n";
115        libxml_clear_errors(); // 取得したエラーをクリア
116    } else {
117        echo "   libxml エラーはありません。\n";
118    }
119}
120
121// デモンストレーション関数の実行
122demonstrateDomValidationOnParse();
123

DOMDocument::validateOnParseは、PHPのDOM拡張機能に属するDOMDocumentクラスのプロパティです。このプロパティは、XMLドキュメントを読み込む際に、そのドキュメント型定義（DTD）に準拠しているかを検証するかどうかを制御します。

このプロパティの型はブール値（bool）で、引数はありません。trueに設定すると、DOMDocument::loadXML()やDOMDocument::load()メソッドでXMLを解析する際にDTDによる厳格な検証が有効になります。これにより、DTDの規則に合致しないXMLデータはパース時にエラーとして扱われ、XMLの読み込みが失敗します。一方、falseに設定した場合、DTD検証はスキップされ、XMLの構造が適切であればDTDに準拠していなくても読み込みが成功します。

提供されたサンプルコードでは、まずDOMDocument::validateOnParseプロパティのデフォルト値を確認し、その後trueに設定してDTDに準拠する有効なXMLと、準拠しない不正なXMLをそれぞれ読み込む挙動をデモンストレーションしています。trueの場合、不正なXMLはエラーとなり読み込みが失敗することを確認できます。続いて、プロパティをfalseに戻して再度不正なXMLを読み込むことで、DTD検証がスキップされ、エラーなしでXMLの読み込みが成功する様子が示されています。これにより、XMLの厳格な検証が必要な場合に、このプロパティがどのように役立つかが具体的に理解できます。

Copy
1<?php
2
3/**
4 * DOMDocument::validateOnParse を使用してXMLのDTDバリデーションを行うサンプル関数
5 *
6 * この関数は、指定されたXML文字列をパースする際にDTDバリデーションを有効にし、
7 * 発生したバリデーションエラーを表示します。
8 *
9 * @param string $xmlString バリデートするXML文字列
10 * @return void
11 */
12function performXmlValidationWithValidateOnParse(string $xmlString): void
13{
14    // libxmlのエラーをPHPの内部で処理するように設定します。
15    // これにより、XMLパースやDTDバリデーション中にエラーが発生してもスクリプトが停止せず、
16    // libxml_get_errors() を使ってエラー情報を後から取得できるようになります。
17    libxml_use_internal_errors(true);
18
19    $dom = new DOMDocument();
20
21    // DOMDocument::validateOnParse プロパティを true に設定することで、
22    // XMLドキュメントが持つDTD（文書型定義）に基づいて、
23    // ドキュメントをロードする（パースする）際に自動的にバリデーションが実行されます。
24    // これは、XMLの構造がDTDに適合しているかを確認するために使用されます。
25    $dom->validateOnParse = true;
26
27    echo "--- XML DTDバリデーションを開始します ---\n\n";
28    echo "処理中のXMLの冒頭部分:\n" . substr($xmlString, 0, 150) . "...\n\n";
29
30    // XML文字列をDOMDocumentにロードします。
31    // validateOnParse が true なので、このロード処理中にDTDバリデーションも行われます。
32    if ($dom->loadXML($xmlString)) {
33        echo "XMLは正常にロードされました。\n";
34        // ロードが成功しても、バリデーションエラーは libxml_get_errors() で確認する必要があります。
35    } else {
36        echo "XMLのロードに失敗しました。\n";
37    }
38
39    // libxmlの内部エラーキューから、ロード処理中やバリデーション中に発生したエラー情報を取得します。
40    $errors = libxml_get_errors();
41
42    if (!empty($errors)) {
43        echo "\n--- バリデーションエラーが検出されました ---\n";
44        foreach ($errors as $error) {
45            // エラーの種類、メッセージ、発生した行番号や列番号を表示します。
46            echo "エラー (Line: {$error->line}, Col: {$error->column}): " . trim($error->message) . "\n";
47        }
48    } else {
49        echo "\nDTDバリデーションエラーは検出されませんでした。\n";
50    }
51
52    // libxmlのエラーキューをクリアします。
53    // これを行わないと、この関数呼び出しより後に libxml 関連の処理があった場合、
54    // 以前のエラーが影響を与えたり、重複して報告されたりする可能性があります。
55    libxml_clear_errors();
56
57    echo "\n--- XML DTDバリデーションを終了します ---\n";
58}
59
60// DTDに違反するXML文字列の例
61// このXMLは、`root`要素の子として`item`要素のみを許可するDTDを内部に持っていますが、
62// `<invalid_item>` というDTDで定義されていない要素を含んでいるため、
63// `validateOnParse` が有効な場合、バリデーションエラーが発生します。
64$invalidXmlExample = <<<XML
65<?xml version="1.0" encoding="UTF-8"?>
66<!DOCTYPE root [
67    <!ELEMENT root (item*)>
68    <!ELEMENT item (#PCDATA)>
69]>
70<root>
71    <item>これはDTDで定義された有効なアイテムです。</item>
72    <invalid_item>これはDTDで定義されていない不正なアイテムです。</invalid_item>
73</root>
74XML;
75
76// 定義した関数を呼び出し、不正なXML文字列を渡してバリデーションを実行します。
77performXmlValidationWithValidateOnParse($invalidXmlExample);
78
79?>

PHPのDOMDocument::validateOnParseは、XMLドキュメントをパースする際にDTD（文書型定義）に定義されたルールに基づいたバリデーションを自動的に有効にするためのブール型プロパティです。このプロパティをtrueに設定することで、XMLの構造がDTDに適合しているかを、ドキュメントの読み込みと同時に確認できるようになります。

提供されたサンプルコードでは、libxml_use_internal_errors(true)によりXMLパース中のエラーをPHP内部で処理するよう設定し、スクリプトの停止を防いでいます。次に、DOMDocumentオブジェクトを生成し、$dom->validateOnParse = true;と設定することでDTDバリデーションを有効化しています。

関数は引数としてバリデートするXML文字列（$xmlString）を受け取ります。このXMLを$dom->loadXML()でロードする際に、有効化されたバリデーションが実行されます。エラーが発生した場合でも、libxml_get_errors()関数を使ってエラーの詳細情報を取得し、表示します。これにより、XMLデータがDTDの仕様に準拠しているかプログラムで確認でき、不正な構造のXMLが処理されることを防ぐことができます。この関数自体は直接の戻り値を持たず（void）、結果は標準出力に表示されます。