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

Copy
1<?php
2
3/**
4 * XML文書がRelaxNGスキーマに準拠しているかを検証します。
5 *
6 * この関数は、Dom\Document::relaxNgValidateSource メソッドを利用して、
7 * 指定されたXML文字列がRelaxNGスキーマに適合するかを確認します。
8 * 主にXMLベースのデータ構造の入力検証（バリデーション）に使用されます。
9 *
10 * @param string $xmlString 検証対象のXML文書を文字列として指定します。
11 * @param string $relaxNgSchemaString 検証に使用するRelaxNGスキーマを文字列として指定します。
12 * @return bool 検証に成功した場合は true、失敗した場合は false を返します。
13 */
14function validateXmlWithRelaxNg(string $xmlString, string $relaxNgSchemaString): bool
15{
16    // libxmlのエラーを内部的に処理するように設定します。
17    // これにより、DOM操作中に発生する警告やエラーがPHPの標準エラー出力に直接出ず、
18    // libxml_get_errors() で取得できるようになります。
19    libxml_use_internal_errors(true);
20
21    // Dom\Document クラスのインスタンスを作成します。
22    $dom = new Dom\Document();
23
24    // XML文字列をDOMドキュメントに読み込みます。
25    // loadXML() が失敗した場合（不正なXML形式など）、false を返します。
26    if (!$dom->loadXML($xmlString)) {
27        echo "エラー: XMLの読み込みに失敗しました。\n";
28        // 読み込みエラーの詳細を取得して表示します。
29        foreach (libxml_get_errors() as $error) {
30            echo "  - " . trim($error->message) . "\n";
31        }
32        // エラーをクリアして、後続の処理に影響がないようにします。
33        libxml_clear_errors();
34        // 内部エラー処理をデフォルトに戻します (必須ではありませんが、良い習慣です)。
35        libxml_use_internal_errors(false);
36        return false;
37    }
38
39    // Dom\Document::relaxNgValidateSource メソッドを使用して、
40    // 読み込んだXMLドキュメントを指定されたRelaxNGスキーマで検証します。
41    // 検証に成功すれば true、失敗すれば false が返されます。
42    $isValid = $dom->relaxNgValidateSource($relaxNgSchemaString);
43
44    if (!$isValid) {
45        echo "検証に失敗しました！\n";
46        // 検証失敗時に発生したエラーの詳細を取得して表示します。
47        foreach (libxml_get_errors() as $error) {
48            echo "  - " . trim($error->message) . "\n";
49        }
50    } else {
51        echo "検証に成功しました。\n";
52    }
53
54    // libxmlのエラー情報をクリアします。これにより、次回のlibxml操作に影響を与えません。
55    libxml_clear_errors();
56    // 内部エラー処理をデフォルトに戻します。
57    libxml_use_internal_errors(false);
58
59    return $isValid;
60}
61
62// --- 使用例 ---
63
64// 1. RelaxNGスキーマの定義 (XML形式)
65// このスキーマは、<root>要素の中に1つ以上の<item>要素を要求し、
66// 各<item>要素には 'id' 属性（文字列）、<name>要素（テキスト）、
67// および <price>要素（整数）が含まれることを定義します。
68$relaxNgSchema = <<<RNG
69<element name="root" xmlns="http://relaxng.org/ns/structure/1.0"
70         xmlns:xsd="http://www.w3.org/2001/XMLSchema-datatypes">
71    <oneOrMore>
72        <element name="item">
73            <attribute name="id">
74                <xsd:string/>
75            </attribute>
76            <element name="name">
77                <text/>
78            </element>
79            <element name="price">
80                <xsd:integer/>
81            </element>
82        </element>
83    </oneOrMore>
84</element>
85RNG;
86
87// 2. 検証が成功するXML文書の例
88$validXml = <<<XML
89<?xml version="1.0" encoding="UTF-8"?>
90<root>
91    <item id="A1">
92        <name>商品A</name>
93        <price>100</price>
94    </item>
95    <item id="B2">
96        <name>商品B</name>
97        <price>250</price>
98    </item>
99</root>
100XML;
101
102echo "--- 正常なXMLの検証 ---\n";
103validateXmlWithRelaxNg($validXml, $relaxNgSchema);
104echo "\n";
105
106
107// 3. 検証が失敗するXML文書の例
108// - 'price' 要素の値が整数ではない ('invalid_price')
109// - 'item' 要素の直後にスキーマで定義されていない 'another_element' がある (構造違反)
110$invalidXml = <<<XML
111<?xml version="1.0" encoding="UTF-8"?>
112<root>
113    <item id="C3">
114        <name>商品C</name>
115        <price>invalid_price</price> <!-- スキーマ違反: priceは整数であるべき -->
116    </item>
117    <another_element> <!-- スキーマ違反: rootの直下にanother_elementは許可されていない -->
118        <item id="D4">
119            <name>商品D</name>
120            <price>300</price>
121        </item>
122    </another_element>
123</root>
124XML;
125
126echo "--- 異常なXMLの検証 ---\n";
127validateXmlWithRelaxNg($invalidXml, $relaxNgSchema);

PHP 8のDom\Document::relaxNgValidateSourceメソッドは、XML文書が特定の構造やデータ型を定義するRelaxNGスキーマに適合しているかを検証するために使用されます。このメソッドは、検証に利用するRelaxNGスキーマを文字列として引数$sourceに指定し、検証に成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。これは、システムが受け取るXMLベースのデータが期待通りの形式であるかをチェックする、重要な入力検証（バリデーション）機能の一つです。

サンプルコードでは、まずDom\Documentクラスのオブジェクトを作成し、検証対象のXML文字列をloadXMLメソッドで読み込みます。この際、libxml_use_internal_errors(true)を設定することで、XMLの解析やスキーマ検証時に発生するエラーをPHPの内部で捕捉し、libxml_get_errors()で詳細なエラー情報を取得できるようにしています。XMLの読み込みが成功した後、relaxNgValidateSourceメソッドにRelaxNGスキーマ文字列を渡して検証を実行します。検証結果がfalseの場合、具体的なエラー内容を表示して問題点を把握できるようにしています。最後に、libxml_clear_errors()でエラー情報をクリアし、libxml_use_internal_errors(false)でエラーハンドリングを元の状態に戻すことで、リソースを適切に管理しています。この機能により、外部からの不正なXMLデータ入力がシステムに影響を与えるのを防ぎ、データの整合性を保つことができます。

Copy
1<?php
2
3/**
4 * 指定されたXML文字列を、指定されたRelax NGスキーマ文字列で検証します。
5 *
6 * @param string $xmlString 検証するXMLドキュメントの文字列。
7 * @param string $relaxNgSchemaSource 検証に使用するRelax NGスキーマの文字列。
8 * @return bool 検証が成功した場合はtrue、失敗した場合はfalse。
9 */
10function validateXmlWithRelaxNgSource(string $xmlString, string $relaxNgSchemaSource): bool
11{
12    // DOMDocumentのインスタンスを作成します。
13    // PHP 8ではDOM\Documentクラスを使用します。
14    $dom = new DOM\Document();
15
16    // XMLパースエラーが出力されるのを一時的に抑制します。
17    // これにより、loadXMLの戻り値のみでエラーを判断できます。
18    libxml_use_internal_errors(true);
19
20    // XML文字列をDOMDocumentにロードします。
21    // 不正なXMLの場合、loadXMLはfalseを返し、それ以上の検証はできません。
22    if (!$dom->loadXML($xmlString)) {
23        libxml_clear_errors(); // 蓄積されたエラー情報をクリアします。
24        libxml_use_internal_errors(false); // エラーハンドリング設定を元に戻します。
25        return false; // XMLのロードに失敗したため、検証を中止します。
26    }
27
28    // エラーハンドリング設定を元に戻します。
29    libxml_use_internal_errors(false);
30
31    // ロードされたXMLドキュメントをRelax NGスキーマ文字列で検証し、結果を返します。
32    // 検証が成功すればtrue、失敗すればfalseが返されます。
33    return $dom->relaxNgValidateSource($relaxNgSchemaSource);
34}
35
36// --- サンプル使用例 ---
37
38// 1. 検証に成功する正しいXML文字列
39$validXml = <<<XML
40<?xml version="1.0" encoding="UTF-8"?>
41<book>
42    <title>PHP Programming</title>
43    <author>Developer Expert</author>
44</book>
45XML;
46
47// 2. 検証に失敗する不正なXML文字列（スキーマ定義にない'publisher'要素がある）
48$invalidXml = <<<XML
49<?xml version="1.0" encoding="UTF-8"?>
50<book>
51    <title>Advanced PHP</title>
52    <author>Tech Guru</author>
53    <publisher>O'Reilly</publisher>
54</book>
55XML;
56
57// 3. XMLとしてそもそも構造が壊れている場合（閉じタグが不足）
58$malformedXml = "<item><name>Broken XML</name>";
59
60// 検証に使用するRelax NGスキーマ文字列
61// このスキーマは<book>要素が<title>と<author>要素を順に持つことを定義しています。
62$relaxNgSchema = <<<RNG
63<?xml version="1.0" encoding="UTF-8"?>
64<element name="book" xmlns="http://relaxng.org/ns/structure/1.0">
65    <element name="title">
66        <text/>
67    </element>
68    <element name="author">
69        <text/>
70    </element>
71</element>
72RNG;
73
74echo "--- 検証ケース1: 正しいXMLドキュメント --- \n";
75if (validateXmlWithRelaxNgSource($validXml, $relaxNgSchema)) {
76    echo "結果: 成功 - XMLはRelax NGスキーマに準拠しています。\n";
77} else {
78    echo "結果: 失敗 - XMLはRelax NGスキーマに準拠していません。\n";
79}
80
81echo "\n--- 検証ケース2: 不正なXMLドキュメント（スキーマ不適合） --- \n";
82if (validateXmlWithRelaxNgSource($invalidXml, $relaxNgSchema)) {
83    echo "結果: 成功 - XMLはRelax NGスキーマに準拠しています。（これは予期しない結果です）\n";
84} else {
85    echo "結果: 失敗 - XMLはRelax NGスキーマに準拠していません。（期待される結果です）\n";
86}
87
88echo "\n--- 検証ケース3: XMLとして構造が壊れているドキュメント --- \n";
89if (validateXmlWithRelaxNgSource($malformedXml, $relaxNgSchema)) {
90    echo "結果: 成功 - XMLはRelax NGスキーマに準拠しています。（これは予期しない結果です）\n";
91} else {
92    echo "結果: 失敗 - XMLはRelax NGスキーマに準拠していません。（期待される結果です）\n";
93}

PHP 8で提供されるDom\DocumentクラスのrelaxNgValidateSourceメソッドは、XMLドキュメントがRelax NGスキーマに準拠しているか検証する際に使用されます。このメソッドは、Dom\DocumentオブジェクトにロードされたXMLデータに対し、引数として渡されたRelax NGスキーマの文字列に基づいて検証を行い、その結果を真偽値で返します。

サンプルコードでは、まずDOM\Documentのインスタンスを作成し、検証したいXML文字列をloadXMLメソッドでロードします。XMLのパースエラーが直接出力されるのを防ぐため、libxml_use_internal_errors(true)を設定し、loadXMLの戻り値でXMLの形式が正しいか判断します。XMLが正しくロードできない場合、それ以上の検証は行わず、すぐにfalseを返します。

XMLのロードが成功した後、$dom->relaxNgValidateSource($relaxNgSchemaSource)を呼び出します。ここで$relaxNgSchemaSourceは、検証ルールを記述したRelax NGスキーマの文字列です。メソッドはXMLがスキーマに適合していればtrueを、適合していなければfalseを戻り値として返します。このメソッドは、外部から受け取ったXMLデータの構造が期待通りであるかをプログラムで確認したい場合に非常に役立ちます。