【PHP8.x】Dom\Document::relaxNgValidate()メソッドの使い方

Copy
1<?php
2
3/**
4 * RELAX NGスキーマファイルを使ってXML文字列を検証する関数です。
5 * システムエンジニアを目指す初心者の方でも、XMLの構造が定義されたスキーマに
6 * 沿っているかを確認する基本的な方法を理解できます。
7 *
8 * @param string $xmlString 検証するXMLコンテンツ。
9 * @param string $relaxNgSchemaPath RELAX NGスキーマファイルへのパス。
10 * @return bool XMLが有効な場合はtrue、そうでない場合はfalse。
11 */
12function validateXmlWithRelaxNg(string $xmlString, string $relaxNgSchemaPath): bool
13{
14    // libxmlのエラーハンドリングを有効にして、検証エラーを捕捉できるようにします。
15    // これにより、検証が失敗した際に具体的なエラーメッセージを確認できます。
16    libxml_use_internal_errors(true);
17
18    // Dom\Documentオブジェクトを新しく作成します。
19    // これはXMLドキュメントをメモリ内で表現するためのクラスです。
20    $dom = new Dom\Document();
21
22    // XML文字列をDom\Documentオブジェクトに読み込みます。
23    // 読み込みに失敗した場合（例えば、XML形式が不正な場合）はエラーを出力して終了します。
24    if (!$dom->loadXML($xmlString)) {
25        echo "エラー: XMLの読み込みに失敗しました。\n";
26        foreach (libxml_get_errors() as $error) {
27            echo " - " . trim($error->message) . "\n";
28        }
29        libxml_clear_errors(); // エラーバッファをクリアします。
30        return false;
31    }
32
33    // Dom\Document::relaxNgValidate()メソッドを呼び出して、
34    // ロードされたXMLドキュメントを指定されたRELAX NGスキーマに対して検証します。
35    // 成功すればtrue、失敗すればfalseを返します。
36    $isValid = $dom->relaxNgValidate($relaxNgSchemaPath);
37
38    // 検証が失敗した場合、発生したエラーメッセージを表示します。
39    if (!$isValid) {
40        echo "エラー: RELAX NGスキーマに対するXML検証に失敗しました。\n";
41        foreach (libxml_get_errors() as $error) {
42            echo " - " . trim($error->message) . "\n";
43        }
44    }
45
46    // 後続のXML操作に影響を与えないように、libxmlのエラーバッファをクリアします。
47    libxml_clear_errors();
48
49    return $isValid;
50}
51
52// --- サンプルコードの使用例 ---
53
54// 1. 検証対象となるXMLコンテンツを定義します。
55// これはシンプルな書籍情報を表すXMLです。
56$xmlContent = <<<XML
57<?xml version="1.0" encoding="UTF-8"?>
58<book>
59    <title>PHP入門</title>
60    <author>山田 太郎</author>
61    <year>2023</year>
62</book>
63XML;
64
65// 2. XMLを検証するためのRELAX NGスキーマコンテンツを定義します。
66// このスキーマは、<book>要素が<title>、<author>、<year>要素をこの順で持ち、
67// それぞれがテキストコンテンツを含むことを定義しています。<year>は日付型であることも指定しています。
68$relaxNgSchemaContent = <<<RNG
69<?xml version="1.0" encoding="UTF-8"?>
70<rng:grammar xmlns:rng="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
71  <rng:start>
72    <rng:element name="book">
73      <rng:element name="title">
74        <rng:text/>
75      </rng:element>
76      <rng:element name="author">
77        <rng:text/>
78      </rng:element>
79      <rng:element name="year">
80        <rng:data type="gYear"/>
81      </rng:element>
82    </rng:element>
83  </rng:start>
84</rng:grammar>
85RNG;
86
87// 3. relaxNgValidateメソッドはファイルパスを引数に取るため、
88// 定義したスキーマコンテンツを一時ファイルとして保存します。
89$schemaFilename = tempnam(sys_get_temp_dir(), 'rng_schema_') . '.rng';
90if (file_put_contents($schemaFilename, $relaxNgSchemaContent) === false) {
91    die("エラー: 一時RELAX NGスキーマファイルの書き込みに失敗しました。\n");
92}
93
94echo "XMLの検証を開始します...\n";
95
96// 4. 定義したXMLコンテンツと一時スキーマファイルパスを使って検証関数を呼び出します。
97$isValid = validateXmlWithRelaxNg($xmlContent, $schemaFilename);
98
99// 5. 検証結果を出力します。
100if ($isValid) {
101    echo "検証成功: XMLはRELAX NGスキーマに対して有効です。\n";
102} else {
103    echo "検証失敗: XMLはRELAX NGスキーマに対して無効です。\n";
104}
105
106echo "\n--- 無効なXMLの検証例 ---\n";
107
108// 6. スキーマに適合しない無効なXMLコンテンツを定義します。
109// このXMLは<author>要素が欠けており、スキーマの定義に違反しています。
110$invalidXmlContent = <<<XML
111<?xml version="1.0" encoding="UTF-8"?>
112<book>
113    <title>不正な書籍</title>
114    <!-- <author>要素が欠けています -->
115    <year>2024</year>
116</book>
117XML;
118
119// 7. 無効なXMLで検証関数を呼び出します。
120$isInvalid = validateXmlWithRelaxNg($invalidXmlContent, $schemaFilename);
121
122// 8. 無効なXMLが正しく検証失敗するかを確認します。
123if (!$isInvalid) {
124    echo "検証成功: 無効なXMLは正しく検証失敗しました。\n";
125} else {
126    echo "エラー: 無効なXMLが有効と判断されてしまいました。\n";
127}
128
129// 9. 使用した一時スキーマファイルを削除し、システムをクリーンアップします。
130unlink($schemaFilename);
131echo "\n一時スキーマファイルをクリーンアップしました: " . $schemaFilename . "\n";
132
133?>

このサンプルコードは、PHPのDom\Document::relaxNgValidateメソッドを利用し、XMLコンテンツがRELAX NGスキーマに準拠しているかを検証する方法を示しています。relaxNgValidateメソッドは、XML文書の構造やデータ型を定義するRELAX NGスキーマファイルのパス（string $filename）を引数として受け取ります。検証が成功し、XMLがスキーマに適合していればtrueを、適合しない場合はfalse（bool）を戻り値として返します。

コードではまずXML文字列をDom\Documentオブジェクトにロードし、その後でrelaxNgValidateメソッドを呼び出して検証を実行します。libxml_use_internal_errorsを有効にすることで、XMLの読み込みエラーやスキーマ検証時のエラーメッセージを捕捉し、表示します。RELAX NGスキーマは一時ファイルとして保存され、そのファイルパスがメソッドに渡されます。この一連のプロセスにより、システムが扱うXMLデータが期待通りの形式であることを確認でき、データの整合性を保つための基本的な検証手順を理解することができます。

Copy
1<?php
2
3use Dom\Document; // PHP 8からDom\DocumentクラスはDom名前空間に移動しました。
4
5/**
6 * 指定されたXMLファイルをRELAX NGスキーマに対して検証します。
7 *
8 * この関数は、XMLドキュメントが指定されたRELAX NGスキーマに準拠しているかを確認します。
9 * これは、XMLデータの整合性を検証するための一般的な「バリデーション関数」として機能します。
10 *
11 * @param string $xmlFilePath 検証するXMLファイルのパス。
12 * @param string $relaxNgSchemaPath RELAX NGスキーマファイルのパス。
13 * @return bool XMLがスキーマに対して妥当であれば true、そうでなければ false を返します。
14 */
15function validateXmlWithRelaxNg(string $xmlFilePath, string $relaxNgSchemaPath): bool
16{
17    // XMLパーサーのエラーを捕捉するため、内部エラーハンドリングを一時的に有効化します。
18    // これにより、XMLのロードや検証中に発生したエラーがPHPの標準エラー出力に
19    // 直接表示されるのを防ぎ、プログラム内で制御できるようになります。
20    libxml_use_internal_errors(true);
21
22    $dom = new Document();
23
24    // XMLファイルをロードします。
25    // ファイルが見つからない、またはXML形式が不正な場合、ロードに失敗し false が返されます。
26    if (!$dom->load($xmlFilePath)) {
27        libxml_clear_errors(); // 内部エラーバッファをクリアします。
28        libxml_use_internal_errors(false); // エラーハンドリングを元の設定に戻します。
29        return false;
30    }
31
32    // RELAX NGスキーマファイルに対してXMLドキュメントを検証します。
33    // このメソッドは、XMLドキュメントが指定されたスキーマのルールに従っているかをチェックします。
34    // 検証が成功すれば true、失敗すれば false を返します。
35    $isValid = $dom->relaxNgValidate($relaxNgSchemaPath);
36
37    libxml_clear_errors(); // 内部エラーバッファをクリアします。
38    libxml_use_internal_errors(false); // エラーハンドリングを元の設定に戻します。
39
40    return $isValid;
41}
42
43// --- サンプルコードの実行部分 ---
44
45// 1. RELAX NGスキーマの定義 (文字列)
46// root要素の中に、id属性を持つitem要素が1つ以上存在するというスキーマです。
47$relaxNgSchemaContent = <<<RNG
48<element name="root">
49  <oneOrMore>
50    <element name="item">
51      <attribute name="id">
52        <text/>
53      </attribute>
54      <text/>
55    </element>
56  </oneOrMore>
57</element>
58RNG;
59
60// 2. 妥当なXMLデータの定義 (文字列)
61// 上記スキーマに準拠したXMLデータです。
62$validXmlContent = <<<XML
63<root>
64  <item id="1">First item</item>
65  <item id="2">Second item</item>
66</root>
67XML;
68
69// 3. 妥当でないXMLデータの定義 (文字列)
70// スキーマに定義されていない 'another_item' 要素が含まれており、妥当ではありません。
71$invalidXmlContent = <<<XML
72<root>
73  <item id="1">Only one item</item>
74  <another_item>This is invalid</another_item>
75</root>
76XML;
77
78// 一時ファイルを作成し、上記の内容を書き込みます。
79// これらのファイルはスクリプトの実行後に削除されます。
80$relaxNgFile = tempnam(sys_get_temp_dir(), 'relaxng_');
81$validXmlFile = tempnam(sys_get_temp_dir(), 'valid_xml_');
82$invalidXmlFile = tempnam(sys_get_temp_dir(), 'invalid_xml_');
83
84if ($relaxNgFile && $validXmlFile && $invalidXmlFile) {
85    file_put_contents($relaxNgFile, $relaxNgSchemaContent);
86    file_put_contents($validXmlFile, $validXmlContent);
87    file_put_contents($invalidXmlFile, $invalidXmlContent);
88
89    // --- 妥当なXMLデータの検証例 ---
90    echo "--- 妥当なXMLの検証 ---\n";
91    if (validateXmlWithRelaxNg($validXmlFile, $relaxNgFile)) {
92        echo "結果: 検証に成功しました。XMLはRELAX NGスキーマに準拠しています。\n\n";
93    } else {
94        echo "結果: 検証に失敗しました。XMLはRELAX NGスキーマに準拠していません。\n\n";
95    }
96
97    // --- 妥当でないXMLデータの検証例 ---
98    echo "--- 妥当でないXMLの検証 ---\n";
99    if (validateXmlWithRelaxNg($invalidXmlFile, $relaxNgFile)) {
100        echo "結果: 検証に成功しました。XMLはRELAX NGスキーマに準拠しています。\n\n";
101    } else {
102        echo "結果: 検証に失敗しました。XMLはRELAX NGスキーマに準拠していません。\n\n";
103    }
104
105    // 使用後、不要になった一時ファイルを削除します。
106    unlink($relaxNgFile);
107    unlink($validXmlFile);
108    unlink($invalidXmlFile);
109} else {
110    echo "エラー: 一時ファイルの作成に失敗しました。\n";
111}

PHP 8のDom\Document::relaxNgValidateメソッドは、XMLドキュメントが特定のRELAX NGスキーマに準拠しているかを検証するための重要な「バリデーション関数」です。このメソッドを使用することで、XMLデータの整合性をプログラム的に確認し、不正なデータを早期に検出できます。

引数にはstring $filenameを指定し、これはXMLドキュメントを検証するために使用するRELAX NGスキーマファイルのパスを指します。戻り値はbool型で、XMLドキュメントが指定されたスキーマのルールに完全に準拠していればtrueを、準拠していなければfalseを返します。

サンプルコードでは、validateXmlWithRelaxNgという関数が定義されており、この関数内でDom\Documentクラスのインスタンスを生成し、XMLファイルをロードしています。その後、relaxNgValidateメソッドにRELAX NGスキーマファイルのパスを渡すことで、XMLがスキーマに適合するかを検証しています。これにより、XMLの構造や内容が期待通りであるかを自動的にチェックでき、システム間のデータ連携や設定ファイルの検証などで信頼性を高める際に非常に役立ちます。