【PHP8.x】XMLReader::VALIDATE定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたXMLファイルをXMLReader::VALIDATEオプションを使って検証します。
5 * システムエンジニアを目指す初心者向けに、ファイルパスの存在確認と
6 * XMLコンテンツの妥当性検証の基本を示します。
7 *
8 * @param string $xmlFilePath 検証するXMLファイルのパス
9 * @return bool XMLファイルが存在し、かつXMLコンテンツがDTD/Schemaに準拠していればtrue、それ以外はfalse
10 */
11function validateXmlFile(string $xmlFilePath): bool
12{
13    // libxmlエラーをPHPが内部で処理するように設定し、エラーが自動的に出力されないようにします。
14    libxml_use_internal_errors(true);
15    // 以前に発生した可能性のあるlibxmlエラーをクリアします。
16    libxml_clear_errors();
17
18    // 1. ファイルパスの検証: 指定されたパスにXMLファイルが存在し、読み取り可能かを確認します。
19    // これはキーワード「executablepath」に対応し、ファイルシステム上のパスの妥当性を示します。
20    if (!file_exists($xmlFilePath) || !is_readable($xmlFilePath)) {
21        echo "エラー: 指定されたXMLファイル '{$xmlFilePath}' が見つからないか、読み取れません。\n";
22        return false;
23    }
24
25    $reader = new XMLReader();
26
27    // 2. XMLファイルをXMLReaderで開きます。ファイルを開くのに失敗した場合、エラーを出力します。
28    if (!$reader->open($xmlFilePath)) {
29        echo "エラー: XMLファイル '{$xmlFilePath}' のオープンに失敗しました。\n";
30        $reader->close();
31        return false;
32    }
33
34    // 3. XMLReader::VALIDATE オプションを設定し、XMLコンテンツの妥当性検証を有効にします。
35    // これがリファレンス情報で指定された XMLReader::VALIDATE 定数の使用例です。
36    // true に設定することで、XMLドキュメントがDTDやXML Schemaに準拠しているかどうかの検証が行われます。
37    $reader->setParserProperty(XMLReader::VALIDATE, true);
38
39    // 4. XMLドキュメント全体を読み込み、検証プロセスをトリガーします。
40    // read() メソッドはXMLドキュメントの各ノードを順次読み進めます。
41    // この過程でXMLの妥当性がチェックされ、不整合があればlibxmlエラーとして記録されます。
42    while ($reader->read()) {
43        // 通常はここでXMLノードの処理を行いますが、検証のみが目的の場合はループを回すだけで十分です。
44    }
45
46    // 5. 検証結果と発生したlibxmlエラーを確認します。
47    $isValid = $reader->isValid(); // ドキュメントがDTD/Schemaに準拠しているかを示します。
48    $errors = libxml_get_errors(); // 読み込み中に発生したlibxmlエラー（警告やエラー）を取得します。
49
50    $reader->close(); // XMLReaderのリソースを解放します。
51
52    if (!$isValid || !empty($errors)) {
53        echo "XMLファイル '{$xmlFilePath}' は検証エラーを含んでいます。\n";
54        foreach ($errors as $error) {
55            // エラーの種類や詳細情報を表示します。
56            echo "  エラー: {$error->message} (行: {$error->line}, カラム: {$error->column})\n";
57        }
58        return false;
59    }
60
61    echo "XMLファイル '{$xmlFilePath}' は正常に検証されました。\n";
62    return true;
63}
64
65// --- サンプルコードの実行例 ---
66// このコードが単体で動作可能であることを示すため、一時的なXMLファイルを作成し、検証を実行します。
67
68// DTDに準拠した有効なXMLファイルの内容
69$validXmlContent = <<<'XML'
70<?xml version="1.0" encoding="UTF-8"?>
71<!DOCTYPE root [
72  <!ELEMENT root (item*)>
73  <!ELEMENT item EMPTY>
74]>
75<root>
76  <item/>
77  <item/>
78</root>
79XML;
80
81// DTDに定義されていないタグを含む無効なXMLファイルの内容
82$invalidXmlContent = <<<'XML'
83<?xml version="1.0" encoding="UTF-8"?>
84<!DOCTYPE root [
85  <!ELEMENT root (item*)>
86  <!ELEMENT item EMPTY>
87]>
88<root>
89  <item/>
90  <unknown_tag/> <!-- このタグはDTDに定義されていないため、検証エラーが発生します -->
91</root>
92XML;
93
94// 一時的なファイルパスを定義
95$validXmlPath = 'temp_valid_example.xml';
96$invalidXmlPath = 'temp_invalid_example.xml';
97$nonExistentPath = 'non_existent_example.xml';
98
99// 各XMLファイルを作成
100file_put_contents($validXmlPath, $validXmlContent);
101file_put_contents($invalidXmlPath, $invalidXmlContent);
102
103echo "--- 有効なXMLファイルの検証 ---\n";
104validateXmlFile($validXmlPath);
105
106echo "\n--- 無効なXMLファイルの検証 ---\n";
107validateXmlFile($invalidXmlPath);
108
109echo "\n--- 存在しないファイルの検証 ---\n";
110validateXmlFile($nonExistentPath);
111
112// サンプルコードの実行後、作成した一時ファイルを削除してクリーンアップします。
113unlink($validXmlPath);
114unlink($invalidXmlPath);
115
116?>

このPHPサンプルコードは、指定されたXMLファイルが「存在し、読み取り可能であるか」という基本的なパスの確認と、「XMLのルール（DTDやXML Schema）に準拠しているか」というコンテンツの妥当性検証を行う方法を、システムエンジニアを目指す初心者向けに示しています。

validateXmlFile関数は、検証したいXMLファイルのパスを$xmlFilePathという文字列で受け取ります。この関数の戻り値は、ファイルが存在し、XMLコンテンツが妥当であればtrueを、そうでなければfalseを返します。

処理の開始では、file_exists()やis_readable()といった関数を使用し、指定された$xmlFilePathが実際にファイルシステム上に存在し、プログラムから読み取り可能かを確認します。これは「executablepath」というキーワードで示される、ファイルパスの基本的な検証に該当します。 続いて、XMLReaderオブジェクトを生成し、open()メソッドでXMLファイルを開きます。ここで、リファレンス情報にあるXMLReader::VALIDATE定数を活用します。setParserProperty(XMLReader::VALIDATE, true)と設定することで、XMLドキュメントがDTDやXML Schemaに沿っているかを厳密に検証するようXMLReaderに指示します。

その後、while ($reader->read())ループを使ってXMLドキュメント全体を読み進めることで、この設定に基づいた妥当性検証が実行されます。読み込み中にXMLルールに違反する箇所があれば、エラーとして内部的に記録されます。 最終的に、$reader->isValid()でドキュメント全体の妥当性を確認し、libxml_get_errors()で発生した具体的なエラーメッセージを取得して表示します。検証が完了したら$reader->close()でリソースを解放します。この一連のプロセスにより、XMLデータの信頼性を確認できます。