【PHP8.x】DOMDocument::relaxNGValidate()メソッドの使い方

Copy
1<?php
2
3// libxml_use_internal_errors を有効にして、XML関連のエラーを内部で捕捉し、
4// PHPの警告として表示されないようにします。これにより、エラー情報をプログラムで処理できます。
5libxml_use_internal_errors(true);
6
7/**
8 * 指定されたXMLファイルがRelaxNGスキーマに準拠しているかを検証します。
9 *
10 * この関数は、システムエンジニアがXMLデータ構造の整合性を確認する際によく利用されます。
11 * 例えば、外部システムから受け取ったXMLデータが想定通りの形式であるかを確認する、
12 * あるいは自システムが出力するXMLデータが仕様に適合しているかをテストするといった用途です。
13 *
14 * @param string $xmlFilePath 検証するXMLファイルのパス。
15 * @param string $rngSchemaPath 使用するRelaxNGスキーマファイルのパス。
16 * @return bool XMLがスキーマに準拠している場合は true、それ以外は false。
17 */
18function validateXmlWithRelaxNG(string $xmlFilePath, string $rngSchemaPath): bool
19{
20    $dom = new DOMDocument();
21
22    // XMLファイルをロードします。
23    // ファイルが存在しないか、XMLが不正な形式の場合、ロードに失敗し false を返します。
24    if (!$dom->load($xmlFilePath)) {
25        echo "エラー: XMLファイル '{$xmlFilePath}' のロードに失敗しました。\n";
26        // libxml_get_errors() でロード時の具体的なエラーメッセージを取得します。
27        foreach (libxml_get_errors() as $error) {
28            echo "  - " . trim($error->message) . " (行: {$error->line})\n";
29        }
30        libxml_clear_errors(); // 取得したエラーをクリアします。
31        return false;
32    }
33
34    // DOMDocument::relaxNGValidate() メソッドを使って、
35    // ロードしたXML文書をRelaxNGスキーマに対して検証します。
36    // スキーマに準拠していれば true、そうでなければ false を返します。
37    $isValid = $dom->relaxNGValidate($rngSchemaPath);
38
39    // 検証結果が false の場合、RelaxNGスキーマとの不一致によるエラー情報を出力します。
40    $errors = libxml_get_errors();
41    if (!$isValid && !empty($errors)) {
42        echo "検証エラーが発生しました:\n";
43        foreach ($errors as $error) {
44            echo "  - " . trim($error->message) . " (行: {$error->line})\n";
45        }
46    }
47    libxml_clear_errors(); // 検証後に発生した可能性のあるエラーもクリアします。
48
49    return $isValid;
50}
51
52// --- サンプルXMLファイルとRelaxNGスキーマの準備 ---
53// 単体で動作可能なように、検証対象のXMLとスキーマを一時ファイルとして作成します。
54
55// 検証対象のXMLコンテンツ（書籍の情報）
56$xmlContent = <<<XML
57<?xml version="1.0" encoding="UTF-8"?>
58<book>
59    <title>PHP入門</title>
60    <author>佐藤 健太</author>
61    <year>2024</year>
62</book>
63XML;
64
65// RelaxNGスキーマコンテンツ（書籍情報の構造を定義）
66// このスキーマは、<book>要素が<title>、<author>、<year>要素をこの順で持ち、
67// <year>要素は整数型である必要があると定義しています。
68$rngSchemaContent = <<<RNG
69<?xml version="1.0" encoding="UTF-8"?>
70<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
71    <start>
72        <element name="book">
73            <element name="title">
74                <text/>
75            </element>
76            <element name="author">
77                <text/>
78            </element>
79            <element name="year">
80                <data type="integer"/>
81            </element>
82        </element>
83    </start>
84</grammar>
85RNG;
86
87// 一時ファイル名を定義します。
88$tempXmlFile = 'temp_book_data.xml';
89$tempRngFile = 'temp_book_schema.rng';
90
91// XMLコンテンツを一時XMLファイルに書き込みます。
92if (file_put_contents($tempXmlFile, $xmlContent) === false) {
93    exit("エラー: XMLファイルを '{$tempXmlFile}' に書き込めませんでした。\n");
94}
95
96// RelaxNGスキーマコンテンツを一時スキーマファイルに書き込みます。
97if (file_put_contents($tempRngFile, $rngSchemaContent) === false) {
98    // スキーマファイルの書き込み失敗時は、作成済みのXMLファイルも削除して終了します。
99    if (file_exists($tempXmlFile)) {
100        unlink($tempXmlFile);
101    }
102    exit("エラー: RelaxNGスキーマファイルを '{$tempRngFile}' に書き込めませんでした。\n");
103}
104
105echo "XMLファイル '{$tempXmlFile}' を RelaxNGスキーマ '{$tempRngFile}' で検証します...\n";
106
107// 作成した検証関数を実行し、結果に基づいてメッセージを出力します。
108if (validateXmlWithRelaxNG($tempXmlFile, $tempRngFile)) {
109    echo "検証成功: XMLファイルはRelaxNGスキーマに準拠しています。\n";
110} else {
111    echo "検証失敗: XMLファイルはRelaxNGスキーマに準拠していません。\n";
112}
113
114// --- 使用した一時ファイルをクリーンアップ ---
115// スクリプトの実行後、生成した一時ファイルを削除してディスクをきれいに保ちます。
116if (file_exists($tempXmlFile)) {
117    unlink($tempXmlFile);
118}
119if (file_exists($tempRngFile)) {
120    unlink($tempRngFile);
121}
122
123// libxml_use_internal_errors を元の設定に戻します（任意ですが、良い習慣です）。
124// これにより、他のXML処理がデフォルトのエラーハンドリングに戻ります。
125libxml_use_internal_errors(false);
126
127?>

PHPのDOMDocument::relaxNGValidateメソッドは、XML文書が特定のRelaxNGスキーマに準拠しているかを検証するために使用されます。このメソッドを利用するには、まずDOMDocumentクラスのインスタンスを作成し、検証したいXMLファイルをload()メソッドでロードする必要があります。

relaxNGValidateメソッドは、引数として検証に用いるRelaxNGスキーマファイルのパス（string $filename）を受け取ります。そして、ロード済みのXML文書がこのスキーマの定義通りであるかを厳密にチェックし、準拠していればtrue、そうでなければfalseを戻り値（bool）として返します。

システムエンジニアは、外部システムから受け取ったXMLデータの形式が仕様に沿っているかを確認したり、自システムが出力するXMLデータが正しい構造を保っているかを自動的に検証したりする際に、この機能を利用します。検証に失敗した際には、libxml_use_internal_errorsを有効にしてlibxml_get_errors()関数を使用することで、具体的なエラー情報を取得し、原因を特定することが可能です。これにより、データ品質の向上とシステムの安定稼働に貢献します。

Copy
1<?php
2
3/**
4 * Relax NG スキーマを使用して XML ドキュメントを検証します。
5 *
6 * @param string $xmlContent 検証する XML ドキュメントの文字列。
7 * @param string $relaxNgSchemaContent 使用する Relax NG スキーマの文字列。
8 * @return bool XML がスキーマに対して有効な場合は true、そうでない場合は false。
9 * @throws RuntimeException 一時ファイルの作成や XML のロードに失敗した場合。
10 */
11function validateXmlWithRelaxNG(string $xmlContent, string $relaxNgSchemaContent): bool
12{
13    // 1. Relax NG スキーマの内容を一時ファイルに保存
14    // relaxNGValidate メソッドはファイルパスを引数に取るため、文字列をファイルとして保存する必要があります。
15    $relaxNgFilePath = tempnam(sys_get_temp_dir(), 'relaxng_');
16    if ($relaxNgFilePath === false) {
17        throw new RuntimeException("一時 Relax NG スキーマファイルの作成に失敗しました。ディレクトリの書き込み権限を確認してください。");
18    }
19    if (file_put_contents($relaxNgFilePath, $relaxNgSchemaContent) === false) {
20        // ファイル書き込み失敗時も、作成された一時ファイルを削除します。
21        unlink($relaxNgFilePath);
22        throw new RuntimeException("一時 Relax NG スキーマファイルへの書き込みに失敗しました。");
23    }
24
25    $dom = new DOMDocument();
26    
27    // 2. XML ドキュメントのロード中に発生する警告やエラーを内部で処理する設定
28    // これにより、loadXML 関数が標準出力にエラーを出す代わりに、libxml_get_errors() で取得できるようになります。
29    $oldUseInternalErrors = libxml_use_internal_errors(true);
30
31    // 3. XML を DOMDocument オブジェクトにロード
32    // 成功した場合は true、失敗した場合は false を返します。
33    $loadSuccess = $dom->loadXML($xmlContent);
34
35    if (!$loadSuccess) {
36        // XML ロード失敗時のエラー情報を取得し、例外としてスローします。
37        $errors = libxml_get_errors();
38        $errorMessages = [];
39        foreach ($errors as $error) {
40            $errorMessages[] = sprintf(
41                "XMLロードエラー: %s (行: %d, カラム: %d)",
42                trim($error->message),
43                $error->line,
44                $error->column
45            );
46        }
47        libxml_clear_errors(); // エラーバッファをクリア
48        libxml_use_internal_errors($oldUseInternalErrors); // 元の設定に戻す
49        unlink($relaxNgFilePath); // 必ず一時ファイルを削除
50        throw new RuntimeException("XML ドキュメントのロードに失敗しました。無効な XML フォーマットの可能性があります。\n" . implode("\n", $errorMessages));
51    }
52
53    // 4. DOMDocument::relaxNGValidate メソッドを使用して XML を Relax NG スキーマに対して検証
54    // このメソッドは、XML の構造が提供されたスキーマに準拠しているかをチェックし、結果を bool で返します。
55    $isValid = $dom->relaxNGValidate($relaxNgFilePath);
56
57    // 5. XML 処理関連のエラーバッファをクリアし、元の設定に戻す
58    libxml_clear_errors();
59    libxml_use_internal_errors($oldUseInternalErrors);
60
61    // 6. 作成した一時ファイルを削除
62    unlink($relaxNgFilePath);
63
64    return $isValid;
65}
66
67// --- サンプルコードの利用例 ---
68
69// 検証する有効な XML ドキュメントの例
70$validXml = <<<XML
71<bookstore>
72    <book category="fiction">
73        <title lang="en">The Great Gatsby</title>
74        <author>F. Scott Fitzgerald</author>
75        <year>1925</year>
76        <price>12.99</price>
77    </book>
78    <book category="science">
79        <title lang="en">Cosmos</title>
80        <author>Carl Sagan</author>
81        <year>1980</year>
82        <price>15.50</price>
83    </book>
84</bookstore>
85XML;
86
87// 検証する無効な XML ドキュメントの例 (スキーマで必須の 'price' 要素が欠落)
88$invalidXml = <<<XML
89<bookstore>
90    <book category="fiction">
91        <title lang="en">1984</title>
92        <author>George Orwell</author>
93        <year>1949</year>
94    </book>
95</bookstore>
96XML;
97
98// 不正なXMLフォーマットの例（閉じタグが不足している）
99$malformedXml = <<<XML
100<bookstore>
101    <book>
102        <title>Malformed XML</title>
103    </book
104</bookstore>
105XML;
106
107// Relax NG スキーマの定義 (このスキーマは、'book' 要素には 'title', 'author', 'year', 'price' が必須であることを定義)
108$relaxNgSchema = <<<RNG
109<element name="bookstore">
110    <oneOrMore>
111        <element name="book">
112            <attribute name="category">
113                <text/>
114            </attribute>
115            <element name="title">
116                <attribute name="lang">
117                    <text/>
118                </attribute>
119                <text/>
120            </element>
121            <element name="author">
122                <text/>
123            </element>
124            <element name="year">
125                <text/>
126            </element>
127            <element name="price">
128                <text/>
129            </element>
130        </element>
131    </oneOrMore>
132</element>
133RNG;
134
135// --- 各種 XML の検証を実行し、結果を表示 ---
136
137echo "--- 有効な XML の検証 ---\n";
138try {
139    if (validateXmlWithRelaxNG($validXml, $relaxNgSchema)) {
140        echo "結果: 有効な XML は Relax NG スキーマに準拠しています。\n";
141    } else {
142        echo "結果: 有効な XML は Relax NG スキーマに準拠していません。\n";
143        // 注意: relaxNGValidate が false を返した場合、より詳細なエラー情報は libxml_get_errors() で取得できますが、
144        // このサンプルではシンプルにするため省略しています。
145    }
146} catch (RuntimeException $e) {
147    echo "エラー: " . $e->getMessage() . "\n";
148}
149
150echo "\n";
151
152echo "--- 無効な XML (必須要素 'price' が欠落) の検証 ---\n";
153try {
154    if (validateXmlWithRelaxNG($invalidXml, $relaxNgSchema)) {
155        echo "結果: 無効な XML は Relax NG スキーマに準拠しています。\n";
156    } else {
157        echo "結果: 無効な XML は Relax NG スキーマに準拠していません。\n";
158    }
159} catch (RuntimeException $e) {
160    echo "エラー: " . $e->getMessage() . "\n";
161}
162
163echo "\n";
164
165echo "--- 不正な XML フォーマットの検証 ---\n";
166try {
167    if (validateXmlWithRelaxNG($malformedXml, $relaxNgSchema)) {
168        echo "結果: 不正な XML フォーマットは Relax NG スキーマに準拠しています。\n";
169    } else {
170        echo "結果: 不正な XML フォーマットは Relax NG スキーマに準拠していません。\n";
171    }
172} catch (RuntimeException $e) {
173    echo "エラー (不正な XML フォーマット): " . $e->getMessage() . "\n";
174}
175
176?>

DOMDocument::relaxNGValidateは、PHPでXMLドキュメントの内容が、事前に定義された構造ルール（Relax NGスキーマ）に正確に準拠しているかを検証するためのメソッドです。このメソッドは、XMLを扱うDOMDocumentオブジェクトにロードされたXMLデータに対して使用されます。

引数として、Relax NGスキーマの定義が書かれたファイルへのパスを文字列（string $filename）で指定します。メソッドは、XMLドキュメントが指定されたスキーマのルールに合致しているかをチェックし、その結果をブール値（bool）で返します。XMLがスキーマに準拠していればtrue、そうでなければfalseが戻り値となります。

提示されたサンプルコードでは、validateXmlWithRelaxNGという関数が、このrelaxNGValidateメソッドを効果的に利用しています。具体的には、引数として受け取ったRelax NGスキーマの文字列を一時ファイルとして保存し、その一時ファイルのパスをrelaxNGValidateメソッドに渡して検証を行っています。さらに、XMLドキュメントのロード処理や、一時ファイルの作成・削除、検証中のエラーハンドリングといった実用的な側面も考慮されており、データが期待通りの形式であることを確認し、システムの信頼性を向上させるために役立ちます。