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

Copy
1<?php
2
3/**
4 * Dom\Document::schemaValidateSource メソッドの使用例。
5 * XML ドキュメントが XSD スキーマ文字列に対して有効であるかを検証します。
6 *
7 * @return void
8 */
9function validateXmlWithInlineSchema(): void
10{
11    // 検証対象となる XML ドキュメントの文字列
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<book>
15    <title>PHP for Beginners</title>
16    <author>John Doe</author>
17</book>
18XML;
19
20    // XML ドキュメントを検証するための XSD スキーマ文字列
21    // このスキーマは 'book' 要素とその子要素 'title' および 'author' を定義しています。
22    $xsdSchemaString = <<<XSD
23<?xml version="1.0" encoding="UTF-8"?>
24<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
25    <xs:element name="book">
26        <xs:complexType>
27            <xs:sequence>
28                <xs:element name="title" type="xs:string"/>
29                <xs:element name="author" type="xs:string"/>
30            </xs:sequence>
31        </xs:complexType>
32    </xs:element>
33</xs:schema>
34XSD;
35
36    // Dom\Document クラスの新しいインスタンスを作成します。
37    // PHP 8以降は Dom\Document 名前空間を使用します。
38    $dom = new Dom\Document();
39
40    // XML ドキュメントをロードします。
41    // ロードに失敗した場合、false が返されます。
42    if (!$dom->loadXML($xmlString)) {
43        echo "エラー: XML ドキュメントのロードに失敗しました。\n";
44        return;
45    }
46
47    // Dom\Document::schemaValidateSource メソッドを使用して、
48    // ロードされた XML が提供されたスキーマ文字列に対して有効であるかを検証します。
49    // 引数1: string $source - 検証に使用する XSD スキーマの文字列。
50    // 引数2: int $flags - オプションのフラグ (通常は0)。
51    // 戻り値: bool - スキーマに対して有効な場合は true、そうでない場合は false。
52    if ($dom->schemaValidateSource($xsdSchemaString)) {
53        echo "成功: XML ドキュメントはスキーマに対して有効です。\n";
54    } else {
55        echo "エラー: XML ドキュメントはスキーマに対して無効です。\n";
56        // スキーマ検証エラーの詳細は、libxml_get_errors() 関数で取得できますが、
57        // ここでは簡潔にするため省略します。
58    }
59}
60
61// 定義した関数を実行します。
62validateXmlWithInlineSchema();

このサンプルコードは、PHP 8で利用できるDom\Document::schemaValidateSourceメソッドを用いて、XMLドキュメントがXSDスキーマの定義に適合しているかをプログラム内で検証する方法を示しています。

まず、検証対象となるXMLドキュメントの文字列と、そのXMLの構造やデータ型を定義するXSDスキーマの文字列を準備します。XSDスキーマは、XML要素の名前、属性、順序、データ型などのルールを記述したものです。

次に、XMLドキュメントを扱うためのDom\Documentクラスのインスタンスを生成し、loadXMLメソッドを使って準備したXML文字列をこのインスタンスに読み込みます。この段階でXMLの形式が正しいかどうかの基本的なチェックも行われます。

その後、schemaValidateSourceメソッドを実行して、本格的なスキーマ検証を行います。このメソッドの最初の引数には、検証に使用するXSDスキーマの文字列を渡します。二番目の引数$flagsはオプションのフラグで、通常は0を指定します。メソッドは、XMLドキュメントが提供されたXSDスキーマに準拠していればブール値のtrueを、準拠していなければfalseを返します。

最終的に、この戻り値を確認し、XMLドキュメントがスキーマに対して有効であるか無効であるかの結果を出力します。この機能は、外部システムから受け取ったXMLデータの整合性を自動的にチェックする際などに非常に有用です。

Copy
1<?php
2
3/**
4 * Dom\Document::schemaValidateSource メソッドの使用例を示します。
5 * この関数は、XML文字列が指定されたスキーマ文字列に準拠しているかを検証します。
6 * システムエンジニアを目指す初心者の方にも分かりやすいように、
7 * シンプルなXMLとXSDの例を用いています。
8 */
9function validateXmlSchemaFromSourceExample(): void
10{
11    // 検証対象となるXMLデータ
12    // このXMLはシンプルな商品情報を表しています。
13    $xmlData = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<product>
16    <id>123</id>
17    <name>Sample Widget</name>
18    <price>99.99</price>
19</product>
20XML;
21
22    // XMLの構造を定義するスキーマ (XSD) データ
23    // このXSDは、product要素がid(整数), name(文字列), price(小数)を持つことを定義しています。
24    $xsdSchema = <<<XSD
25<?xml version="1.0" encoding="UTF-8"?>
26<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
27    <xs:element name="product">
28        <xs:complexType>
29            <xs:sequence>
30                <xs:element name="id" type="xs:integer"/>
31                <xs:element name="name" type="xs:string"/>
32                <xs:element name="price" type="xs:decimal"/>
33            </xs:sequence>
34        </xs:complexType>
35    </xs:element>
36</xs:schema>
37XSD;
38
39    // Dom\Document オブジェクトを新しく作成します。
40    // このオブジェクトを使ってXML文書を操作します。
41    $document = new Dom\Document();
42
43    // 検証のためにXMLデータをDom\Documentにロードします。
44    // schemaValidateSource を呼び出す前にXMLをパースしておく必要があります。
45    $document->loadXML($xmlData);
46
47    // schemaValidateSource メソッドを使ってXMLがスキーマに準拠しているか検証します。
48    // 第1引数にスキーマ文字列、第2引数にフラグ(オプション、デフォルトは0)を渡します。
49    // 戻り値は bool (真偽値) です。trueなら準拠、falseなら非準拠。
50    $isValid = $document->schemaValidateSource($xsdSchema);
51
52    // 検証結果を表示します。
53    if ($isValid) {
54        echo "XMLデータは提供されたスキーマに準拠しています。\n";
55    } else {
56        echo "XMLデータは提供されたスキーマに準拠していません。\n";
57        // 検証エラーの詳細が必要な場合、libxml_use_internal_errors(true) を設定し、
58        // libxml_get_errors() を使用することでエラー情報を取得できますが、
59        // このシンプルな例では割愛しています。
60    }
61}
62
63// 上記の関数を実行して、サンプルコードの動作を確認します。
64validateXmlSchemaFromSourceExample();
65

Dom\Document::schemaValidateSourceメソッドは、XML文書が指定されたスキーマ（XSD）定義に準拠しているかを検証するための機能です。このメソッドは、スキーマ定義をファイルとして読み込むのではなく、PHPの文字列として直接与えることができる点が特徴です。

このサンプルコードでは、まず商品情報を表すXMLデータと、そのXMLの構造を定義するXSDスキーマをそれぞれ文字列として用意しています。次に、Dom\Documentオブジェクトを新しく作成し、そのloadXML()メソッドを使って検証対象のXMLデータを内部に読み込みます。

その後、schemaValidateSource()メソッドを呼び出して検証を行います。このメソッドの最初の引数には、XMLを検証するためのXSDスキーマの定義文字列を指定します。2番目の引数である$flagsはオプションで、通常はデフォルト値の0で問題ありません。メソッドは検証結果を真偽値（bool）で返します。XMLデータがスキーマに正しく準拠していればtrue、そうでなければfalseが返されます。これにより、XMLの形式が期待通りの構造になっているかを簡単に確認し、プログラムの信頼性を高めることができます。