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

relaxNgValidateメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月07日

基本的な使い方

relaxNgValidateメソッドは、Dom\HTMLDocumentクラスに属し、指定されたRelax NGスキーマに基づいてHTMLドキュメントの妥当性を検証するメソッドです。このメソッドは、Webアプリケーション開発において、HTMLドキュメントが特定の構造や規則に従っているかを確認する際に非常に重要な役割を果たします。具体的には、外部から受け取ったHTMLデータや、プログラムによって生成されたHTMLコンテンツが、あらかじめ定義されたRelax NGスキーマに準拠しているかをチェックするために使用されます。

relaxNgValidateメソッドを実行する際には、検証に利用するRelax NGスキーマファイルのパスを引数として渡します。メソッドは、現在Dom\HTMLDocumentオブジェクトにロードされているHTMLの内容を、そのスキーマと比較し、構造が適合しているかどうかを判断します。検証が正常に完了し、ドキュメントがスキーマに準拠している場合はブール値のtrueを返します。一方、ドキュメントの構造がスキーマの定義と異なる、あるいは不適切な箇所がある場合にはfalseを返します。

この機能を利用することで、システムエンジニアはHTMLドキュメントの整合性を確保し、期待される形式と異なるデータが処理されることによる潜在的なエラーやセキュリティ上の脆弱性を未然に防ぐことができます。検証が失敗した場合、より詳細なエラー情報を知りたい場合は、PHPのLibXML拡張機能が提供するlibxml_get_errors()関数などを用いることで、具体的な不適合箇所を特定し、デバッグに役立てることが可能です。このように、relaxNgValidateメソッドは、堅牢で信頼性の高いHTML処理を実現するための強力なツールです。

構文(syntax)


1<?php
2
3$htmlDocument = new Dom\HTMLDocument();
4$htmlDocument->loadHTML('<!DOCTYPE html><html><body><p>Hello</p></body></html>');
5
6$relaxNgSchemaPath = 'path/to/your/schema.rng';
7
8$validationResult = $htmlDocument->relaxNgValidate($relaxNgSchemaPath);
9
10?>

引数(parameters)

string $filename

string $filename: RELAX NGスキーマファイルへのパスを指定する文字列

戻り値(return)

bool

このメソッドは、Relax NG スキーマによる HTML ドキュメントの検証が成功したかどうかを示す真偽値（true または false）を返します。

サンプルコード

PHP 8 Relax NG HTML検証する


1<?php
2
3/**
4 * 指定されたHTMLコンテンツがRelax NGスキーマに準拠しているかを検証します。
5 *
6 * @param string $htmlContent 検証するHTML文字列。
7 * @param string $relaxNgSchema 検証に使用するRelax NGスキーマ文字列。
8 * @return bool HTMLがスキーマに準拠していれば true、そうでなければ false を返します。
9 */
10function validateHtmlWithRelaxNg(string $htmlContent, string $relaxNgSchema): bool
11{
12    // 1. Relax NGスキーマを一時ファイルに保存します。
13    // Dom\HTMLDocument::relaxNgValidate() メソッドはファイルパスを引数に取るため、
14    // スキーマ文字列を一時ファイルとして保存する必要があります。
15    $schemaFilePath = tempnam(sys_get_temp_dir(), 'rng_schema_');
16    if ($schemaFilePath === false) {
17        echo "エラー: Relax NGスキーマファイルの一時ファイル作成に失敗しました。\n";
18        return false;
19    }
20    file_put_contents($schemaFilePath, $relaxNgSchema);
21
22    // 2. Dom\HTMLDocument オブジェクトを作成します。
23    // PHP 8以降で推奨されるHTML専用のDOM操作クラスです。
24    $dom = new Dom\HTMLDocument();
25
26    // 3. HTMLコンテンツをDom\HTMLDocumentに読み込みます。
27    // @ を付けることで、HTMLのパースエラー（例えば、閉じていないタグなど）に関する警告を抑制します。
28    // 本来はエラーハンドリングを適切に行うべきですが、ここでは検証機能の動作に焦点を当てます。
29    @$dom->loadHTML($htmlContent);
30
31    // 4. Relax NGスキーマを使ってHTML文書を検証します。
32    // relaxNgValidate() メソッドは、HTMLがスキーマに準拠しているかをチェックし、
33    // 結果を boolean で返します。
34    $isValid = $dom->relaxNgValidate($schemaFilePath);
35
36    // 5. 使用した一時ファイルを削除します。
37    // リソースをクリーンアップすることは重要です。
38    unlink($schemaFilePath);
39
40    return $isValid;
41}
42
43// --- 使用例 ---
44
45// 検証に使用するRelax NGスキーマの定義例
46// このスキーマは、基本的なHTML構造 (html > head > title, html > body > p) を定義しています。
47// 他の要素や属性は許可されません。
48$relaxNgSchema = <<<RNG
49<grammar xmlns="http://relaxng.org/ns/structure/1.0"
50         datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
51  <start>
52    <element name="html">
53      <element name="head">
54        <element name="title">
55          <text/>
56        </element>
57      </element>
58      <element name="body">
59        <element name="p">
60          <text/>
61        </element>
62      </element>
63    </element>
64  </start>
65</grammar>
66RNG;
67
68// 検証するHTMLコンテンツの例1: スキーマに適合するHTML
69$validHtmlContent = <<<HTML
70<!DOCTYPE html>
71<html>
72<head>
73    <title>検証成功のタイトル</title>
74</head>
75<body>
76    <p>このHTMLはRelax NGスキーマに準拠しています。</p>
77</body>
78</html>
79HTML;
80
81// 検証するHTMLコンテンツの例2: スキーマに適合しないHTML
82// 'body'要素直下の'p'要素が欠けており、代わりに'div'要素があるためスキーマ違反となります。
83$invalidHtmlContent = <<<HTML
84<!DOCTYPE html>
85<html>
86<head>
87    <title>検証失敗のタイトル</title>
88</head>
89<body>
90    <div>このHTMLはスキーマに準拠していません。</div>
91</body>
92</html>
93HTML;
94
95echo "--- Relax NG スキーマ検証のサンプル ---\n\n";
96
97// 1. 適合するHTMLコンテンツの検証
98echo "■ 適合するHTMLコンテンツを検証中...\n";
99if (validateHtmlWithRelaxNg($validHtmlContent, $relaxNgSchema)) {
100    echo "  結果: 成功！ HTMLは定義されたスキーマに準拠しています。\n\n";
101} else {
102    echo "  結果: 失敗。 HTMLは定義されたスキーマに準拠していません。\n\n";
103}
104
105// 2. 適合しないHTMLコンテンツの検証
106echo "■ 適合しないHTMLコンテンツを検証中...\n";
107if (validateHtmlWithRelaxNg($invalidHtmlContent, $relaxNgSchema)) {
108    echo "  結果: 成功！ HTMLは定義されたスキーマに準拠しています。\n\n";
109} else {
110    echo "  結果: 失敗。 HTMLは定義されたスキーマに準拠していません。\n\n";
111}
112
113?>

Dom\HTMLDocument::relaxNgValidateメソッドは、PHP 8で導入されたHTML専用のDOM操作クラスであるDom\HTMLDocumentが提供する機能の一つです。このメソッドの目的は、読み込まれたHTML文書が、指定されたRelax NGスキーマ（HTMLの構造や内容に関するルールを定義したXMLベースの言語）に準拠しているかを検証することです。

引数にはstring $filenameを受け取ります。これは、検証に用いるRelax NGスキーマが記述されたファイルのパスを指定します。サンプルコードのように、スキーマ定義が文字列としてある場合は、一時ファイルとして保存してからそのパスを渡す必要があります。

メソッドの戻り値はbool型です。検証の結果、HTML文書がRelax NGスキーマに完全に準拠していればtrueを返し、準拠していなければfalseを返します。これにより、外部からの入力やシステム内で生成されたHTMLコンテンツが、事前に定めた構造ルールに従っているかをプログラムで確認できます。WebアプリケーションにおけるHTMLの品質保証やセキュリティ確保のため、PHPでHTMLのバリデーションを行う際に非常に有用な機能です。

このコードは、Relax NGスキーマを使ったHTML検証の基本的な流れを示しています。特に注意すべき点は、relaxNgValidateメソッドがスキーマファイルパスを引数に取るため、スキーマ文字列を一度一時ファイルに保存し、処理後に必ず削除する点です。一時ファイルの作成失敗や削除忘れは、ディスク容量の消費や潜在的なセキュリティリスクにつながる可能性があります。また、Dom\HTMLDocument::loadHTMLで@を使って警告を抑制していますが、実運用ではHTMLパース時のエラーを適切にハンドリングし、問題の原因を特定できるようにすることが重要です。この方法は、外部から提供されるHTMLコンテンツの構造が、あらかじめ定義されたルールに準拠しているかを確認する際に役立ちます。

PHPでHTMLをRelax NGで検証する


1<?php
2
3/**
4 * 指定されたHTML文字列がRelax NGスキーマに準拠しているかを検証する関数。
5 * システムエンジニアを目指す初心者の方にも、PHPでHTMLの構造検証を行う具体的な方法を理解してもらうためのサンプルです。
6 *
7 * @param string $htmlString 検証するHTMLコンテンツ。
8 * @param string $relaxNgSchemaString 使用するRelax NGスキーマのXML文字列。
9 * @return bool HTMLがスキーマに準拠していればtrue、そうでなければfalseを返します。
10 */
11function validateHtmlWithRelaxNg(string $htmlString, string $relaxNgSchemaString): bool
12{
13    // Relax NGスキーマを一時ファイルに保存します。
14    // Dom\HTMLDocument::relaxNgValidate はファイルパスを引数に取るため、スキーマを一時ファイルとして用意します。
15    $schemaFilename = tempnam(sys_get_temp_dir(), 'rng_schema_');
16    if ($schemaFilename === false) {
17        // 一時ファイルの作成に失敗した場合
18        error_log("エラー: Relax NGスキーマ用の一時ファイルを作成できませんでした。");
19        return false;
20    }
21    file_put_contents($schemaFilename, $relaxNgSchemaString);
22
23    try {
24        // Dom\HTMLDocument クラスのインスタンスを作成します。
25        // これはHTMLドキュメントを扱うためのクラスです。
26        $dom = new Dom\HTMLDocument();
27
28        // 検証対象のHTML文字列をドキュメントに読み込みます。
29        // HTMLが正しくない形式の場合でも、エラーを抑制せず進めることができます。
30        $dom->loadHTML($htmlString);
31
32        // ドキュメントがRelax NGスキーマに準拠しているかを検証します。
33        // 戻り値はbool型で、準拠していれば true、していなければ false です。
34        $isValid = $dom->relaxNgValidate($schemaFilename);
35
36        return $isValid;
37    } catch (Throwable $e) {
38        // 検証中に何らかのエラーが発生した場合の処理
39        error_log("HTML検証中にエラーが発生しました: " . $e->getMessage());
40        return false;
41    } finally {
42        // 処理の終了後、作成した一時ファイルを必ず削除します。
43        if (file_exists($schemaFilename)) {
44            unlink($schemaFilename);
45        }
46    }
47}
48
49// --------------------------------------------------------------------
50// サンプル使用例
51// --------------------------------------------------------------------
52
53// 1. スキーマに準拠する正しいHTMLコンテンツの例
54$validHtml = '<!DOCTYPE html><html><head><title>My Valid Page</title></head><body><h1>Hello</h1></body></html>';
55
56// 2. スキーマに準拠しない（h1タグがない）不正なHTMLコンテンツの例
57$invalidHtml = '<!DOCTYPE html><html><head><title>My Invalid Page</title></head><body><p>Welcome</p></body></html>';
58
59// 3. Relax NGスキーマの定義
60// このスキーマは、HTMLドキュメントが <html> -> <head> -> <title> と <html> -> <body> -> <h1>
61// の構造を持つことを必須としています。
62$relaxNgSchema = <<<RNG
63<element name="html">
64  <ref name="head"/>
65  <ref name="body"/>
66
67  <define name="head">
68    <element name="head">
69      <element name="title">
70        <text/>
71      </element>
72    </element>
73  </define>
74
75  <define name="body">
76    <element name="body">
77      <element name="h1">
78        <text/>
79      </element>
80    </element>
81  </define>
82</element>
83RNG;
84
85// 正しいHTMLを検証する
86echo "--- 正しいHTMLの検証 ---\n";
87if (validateHtmlWithRelaxNg($validHtml, $relaxNgSchema)) {
88    echo "結果: ✅ HTMLはRelax NGスキーマに準拠しています。\n";
89} else {
90    echo "結果: ❌ HTMLはRelax NGスキーマに準拠していません。\n";
91}
92
93echo "\n"; // 区切り
94
95// 不正なHTMLを検証する
96echo "--- 不正なHTMLの検証 ---\n";
97if (validateHtmlWithRelaxNg($invalidHtml, $relaxNgSchema)) {
98    echo "結果: ✅ HTMLはRelax NGスキーマに準拠しています。\n";
99} else {
100    echo "結果: ❌ HTMLはRelax NGスキーマに準拠していません。\n";
101}

PHPのDom\HTMLDocument::relaxNgValidateメソッドは、HTMLドキュメントがRelax NGスキーマと呼ばれる定義に準拠しているかを確認するための重要な機能です。この機能を利用すると、外部から受け取ったHTMLコンテンツの構造が期待通りであるか検証したり、システムが生成したHTMLが特定の仕様に沿っているか検査したりする際に大変役立ちます。

メソッドはstring $filenameという引数を取り、検証に使用するRelax NGスキーマが記述されたファイルのパスを指定します。検証の結果、HTMLがスキーマに準拠していればtrueを、準拠していなければfalseを戻り値として返します。

サンプルコードでは、まず検証したいHTML文字列をDom\HTMLDocumentオブジェクトにloadHTMLメソッドで読み込みます。その後、Relax NGスキーマのXML文字列を一時ファイルとして保存し、そのファイルパスをrelaxNgValidateメソッドに渡して検証を実行しています。これは、relaxNgValidateメソッドがスキーマのファイルパスを引数に取るため、文字列形式のスキーマをファイルとして用意する必要があるためです。一時ファイルの作成失敗や検証中のエラー発生に備えた処理、そして検証終了後に一時ファイルを確実に削除するfinallyブロックの利用も示されており、堅牢なプログラムの書き方を学ぶことができます。

このサンプルコードは、Relax NGスキーマを一時ファイルとして保存し、そのファイルパスを用いてHTMLの検証を行います。relaxNgValidateメソッドがスキーマ文字列ではなくファイルパスを引数に取るため、この一時ファイル作成が必須です。作成した一時ファイルは、処理の成功・失敗にかかわらず、finallyブロックで必ず削除するよう徹底してください。これを怠ると、システム上に不要なファイルが蓄積される原因となります。また、一時ファイルの作成失敗や検証処理中の例外発生に備え、適切なエラーハンドリングを行うことが安全なコード利用の鍵となります。