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

Copy
1<?php
2
3/**
4 * XMLReader を使用して RelaxNG スキーマで XML 文字列を検証します。
5 *
6 * @param string $xmlString 検証対象の XML データ文字列。
7 * @param string $schemaString 使用する RelaxNG スキーマの文字列。
8 * @return bool XML がスキーマに準拠している場合は true、そうでない場合は false。
9 */
10function validateXmlWithRelaxNg(string $xmlString, string $schemaString): bool
11{
12    // libxml のエラーを PHP 内部で処理するように設定します。
13    // これにより、XML 検証エラーを捕捉できるようになります。
14    libxml_use_internal_errors(true);
15
16    $reader = new XMLReader();
17
18    // XMLReader に XML データを読み込ませます。
19    // open() の代わりに xml() を使うことで、ファイルではなく文字列を直接扱えます。
20    if (!$reader->xml($xmlString)) {
21        echo "エラー: XML データの読み込みに失敗しました。\n";
22        libxml_clear_errors(); // エラーをクリア
23        return false;
24    }
25
26    // RelaxNG スキーマソースを設定します。
27    // これにより、XMLReader は XML データの読み込み中にスキーマ検証を行います。
28    if (!$reader->setRelaxNGSchemaSource($schemaString)) {
29        echo "エラー: RelaxNG スキーマソースの設定に失敗しました。\n";
30        libxml_clear_errors(); // エラーをクリア
31        return false;
32    }
33
34    // XML ドキュメントを読み込み、スキーマ検証を実行します。
35    // read() メソッドは、XML の次のノードに進むたびに検証を続けます。
36    // エラーがあった場合でも read() 自体は true を返すことがあります。
37    // 最終的な検証結果は libxml_get_errors() で確認します。
38    while ($reader->read()) {
39        // ここでは個々のノードに対する特別な処理は行いません。
40        // スキーマ検証自体は読み込み中にバックグラウンドで行われます。
41    }
42
43    // リーダーを閉じ、リソースを解放します。
44    $reader->close();
45
46    // 検証中に発生したエラーを取得します。
47    $errors = libxml_get_errors();
48    libxml_clear_errors(); // エラーをクリア
49
50    if (empty($errors)) {
51        echo "情報: XML は RelaxNG スキーマに準拠しています。\n";
52        return true;
53    } else {
54        echo "警告: XML は RelaxNG スキーマに準拠していません。以下のエラーが見つかりました:\n";
55        foreach ($errors as $error) {
56            echo "  - " . trim($error->message) . " (行: {$error->line}, 列: {$error->column})\n";
57        }
58        return false;
59    }
60}
61
62// --- サンプル使用例 ---
63
64// 1. 正しい RelaxNG スキーマの定義
65$correctSchema = '<?xml version="1.0" encoding="UTF-8"?>
66<grammar xmlns="http://relaxng.org/ns/structure/1.0">
67  <start>
68    <element name="root">
69      <element name="item">
70        <text/>
71      </element>
72    </element>
73  </start>
74</grammar>';
75
76// 2. スキーマに準拠する XML データの定義
77$correctXml = '<?xml version="1.0" encoding="UTF-8"?>
78<root>
79  <item>サンプルデータ</item>
80</root>';
81
82echo "--- 正しい XML の検証 ---\n";
83validateXmlWithRelaxNg($correctXml, $correctSchema);
84echo "\n";
85
86// 3. スキーマに準拠しない XML データの定義（<item> 要素が欠けている）
87$invalidXml = '<?xml version="1.0" encoding="UTF-8"?>
88<root>
89  <anotherElement>これはスキーマ違反です</anotherElement>
90</root>';
91
92echo "--- 不正な XML の検証 ---\n";
93validateXmlWithRelaxNg($invalidXml, $correctSchema);
94echo "\n";
95
96// libxml のエラーハンドリング設定を元に戻す必要がある場合 (オプション)
97// libxml_use_internal_errors(false);
98
99?>

PHPのXMLReader::setRelaxNGSchemaSourceメソッドは、XMLデータをRelaxNGスキーマというルールに基づいて検証する際に利用されます。このメソッドは、指定されたXMLの構造や内容が、あらかじめ定義されたスキーマの仕様に合致しているかを確認する機能を提供します。

引数$sourceには、検証に用いるRelaxNGスキーマの定義内容を文字列として直接渡します。これにより、XMLReaderオブジェクトは読み込むXMLデータに対して、このスキーマを適用して検証を行います。メソッドが正常にスキーマを設定できた場合はtrueを返し、設定に失敗した場合はfalseを返します。

サンプルコードでは、まずlibxml_use_internal_errors(true)でXML処理中のエラーをPHPで捕捉できるように設定しています。次にXMLReaderインスタンスに検証対象のXML文字列を読み込ませた後、setRelaxNGSchemaSource()でRelaxNGスキーマを適用します。その後、read()メソッドでXMLを読み進めると、設定されたスキーマに基づいた検証がバックグラウンドで実行されます。最終的な検証結果は、libxml_get_errors()で取得できるエラー情報の有無によって判断され、エラーがなければXMLはスキーマに準拠していると判断される仕組みです。このメソッドは、XMLデータの整合性を保証するために非常に役立ちます。

Copy
1<?php
2
3/**
4 * XMLReader::setRelaxNGSchemaSource メソッドの使用例。
5 *
6 * このスクリプトは、XMLドキュメントがRelaxNGスキーマに準拠しているか検証します。
7 * 古いPHPバージョンでデータ処理の安全性確保に使われた set_magic_quotes_runtime
8 * のような機能とは異なり、setRelaxNGSchemaSource は現代のPHP (PHP 8) において
9 * 構造化されたデータ（XML）の整合性を検証するための堅牢な方法を提供します。
10 * データが予期せぬ形式や構造ではないことを保証することで、アプリケーションの
11 * 安定性とセキュリティを高めることができます。
12 */
13
14// 検証対象のXMLコンテンツを定義 (正常な例)
15$validXmlContent = <<<XML
16<root>
17    <item id="1">
18        <name>Sample Item One</name>
19        <value>100</value>
20    </item>
21    <item id="2">
22        <name>Sample Item Two</name>
23        <value>200</value>
24    </item>
25</root>
26XML;
27
28// RelaxNGスキーマを定義
29// root要素の下に、id (整数属性)、name (テキスト要素)、value (整数要素) を持つ
30// item要素が1つ以上存在することを定義しています。
31$relaxNgSchema = <<<RNG
32<element name="root">
33    <oneOrMore>
34        <element name="item">
35            <attribute name="id">
36                <data type="integer"/>
37            </attribute>
38            <element name="name">
39                <text/>
40            </element>
41            <element name="value">
42                <data type="integer"/>
43            </element>
44        </element>
45    </oneOrMore>
46</element>
47RNG;
48
49/**
50 * XMLコンテンツをRelaxNGスキーマで検証する関数。
51 *
52 * @param string $xmlContent 検証するXML文字列。
53 * @param string $schemaSource RelaxNGスキーマの文字列。
54 * @param string $testName テストの名前（出力用）。
55 * @return void
56 */
57function validateXmlWithRelaxNg(string $xmlContent, string $schemaSource, string $testName): void
58{
59    echo "--- " . $testName . " ---\n";
60
61    // libxmlのエラーを内部バッファに蓄積するよう設定します。
62    // これにより、XMLReaderが検出したバリデーションエラーを捕捉できます。
63    libxml_use_internal_errors(true);
64    libxml_clear_errors(); // 以前に発生したエラーをクリアします。
65
66    $reader = new XMLReader();
67
68    // XMLコンテンツをXMLReaderにロードします。
69    if (!$reader->XML($xmlContent)) {
70        echo "エラー: XMLコンテンツのロードに失敗しました。\n";
71        $reader->close();
72        return;
73    }
74
75    // XMLReader::setRelaxNGSchemaSource メソッドを使用してRelaxNGスキーマを設定します。
76    // このメソッドは、スキーマ定義の文字列を直接引数として受け取ります。
77    if (!$reader->setRelaxNGSchemaSource($schemaSource)) {
78        echo "エラー: RelaxNGスキーマの設定に失敗しました。\n";
79        $reader->close();
80        return;
81    }
82
83    // XMLドキュメントを読み込みながらバリデーションを実行します。
84    // setRelaxNGSchemaSource が設定されている場合、読み込み中に自動的に検証が行われます。
85    while ($reader->read()) {
86        // 各ノードの読み込みが成功すれば処理を続行します。
87        // エラーが発生した場合は、libxmlの内部エラーバッファに記録されます。
88    }
89
90    // 読み込みとバリデーションが完了した後、発生したエラーを収集します。
91    $errors = libxml_get_errors();
92    $reader->close();
93
94    if (empty($errors)) {
95        echo "検証結果: XMLはRelaxNGスキーマに準拠しています。\n";
96    } else {
97        echo "検証結果: XMLはRelaxNGスキーマに準拠していません。\n";
98        echo "以下のエラーが検出されました:\n";
99        foreach ($errors as $error) {
100            echo sprintf(
101                "  - [レベル: %s] %s (行: %d, カラム: %d)\n",
102                match ($error->level) { // PHP 8のmatch式でエラーレベルを判別
103                    LIBXML_ERR_WARNING => '警告',
104                    LIBXML_ERR_ERROR   => 'エラー',
105                    LIBXML_ERR_FATAL   => '致命的エラー',
106                    default            => '不明',
107                },
108                trim($error->message),
109                $error->line,
110                $error->column
111            );
112        }
113    }
114    echo "\n";
115}
116
117// 正常なXMLコンテンツで検証を実行
118validateXmlWithRelaxNg($validXmlContent, $relaxNgSchema, "正常なXMLの検証");
119
120// 不正なXMLコンテンツを定義 (スキーマの 'value' 要素は整数を期待するが、文字列が含まれている例)
121$invalidXmlContentValue = <<<XML
122<root>
123    <item id="1">
124        <name>Sample Item One</name>
125        <value>not-an-integer</value> <!-- スキーマでは整数が期待される -->
126    </item>
127</root>
128XML;
129
130// 不正なXMLコンテンツで検証を実行 (データ型不一致)
131validateXmlWithRelaxNg($invalidXmlContentValue, $relaxNgSchema, "不正なXMLの検証 (valueが文字列)");
132
133// 不正なXMLコンテンツを定義 (スキーマに定義されていない要素が含まれている例)
134$invalidXmlContentStructure = <<<XML
135<root>
136    <unknownElement>
137        <name>Wrong Element</name>
138    </unknownElement>
139</root>
140XML;
141
142// 不正なXMLコンテンツで検証を実行 (構造不一致)
143validateXmlWithRelaxNg($invalidXmlContentStructure, $relaxNgSchema, "不正なXMLの検証 (構造不一致)");

XMLReader::setRelaxNGSchemaSourceメソッドは、PHP 8でXMLドキュメントが特定のRelaxNGスキーマに準拠しているかを検証するために使用されます。このメソッドは、引数$sourceとして検証に用いるRelaxNGスキーマの定義を文字列形式で受け取ります。メソッドが成功した場合はtrue、失敗した場合はfalseを戻り値として返します。

この機能は、古いPHPで文字列のエスケープに用いられたset_magic_quotes_runtimeのような単純な処理とは異なり、XMLのような構造化されたデータの厳密な整合性を保証する現代的な検証方法です。XMLの構造やデータ型が事前に定義されたルールに従っているかを詳細にチェックすることで、予期せぬデータによるアプリケーションの不具合やセキュリティリスクを防ぎ、システムの安定性を高めます。

サンプルコードでは、まずXMLコンテンツとRelaxNGスキーマを文字列として定義しています。次に、XMLReaderクラスのインスタンスを生成してXMLコンテンツをロードし、setRelaxNGSchemaSourceメソッドでRelaxNGスキーマを設定しています。その後、XMLドキュメントを読み込みながら、その構造やデータ型がスキーマに準拠しているかをリアルタイムで検証します。最終的に、正常なXML、データ型が異なるXML、構造が異なるXMLのそれぞれに対して検証を実行し、エラーの検出を通じて本メソッドの動作を具体的に示しています。