【PHP8.x】xincludeメソッドの使い方

Copy
1<?php
2
3// DOMDocument を使用して XML ドキュメントを読み込み、XInclude を処理する例
4function processXMLWithXInclude(string $xmlFilePath): void
5{
6    $dom = new DOMDocument();
7
8    // XML ドキュメントの読み込み
9    if (!$dom->load($xmlFilePath)) {
10        echo "XMLファイルの読み込みに失敗しました。\n";
11        return;
12    }
13
14    // XInclude の処理
15    $result = $dom->xinclude();
16
17    if ($result === false) {
18        echo "XInclude の処理に失敗しました。\n";
19        return;
20    }
21
22    // 処理結果の XML を表示
23    echo $dom->saveXML();
24}
25
26// サンプル XML ファイルを作成 (xinclude_test.xml)
27$xmlContent = <<<XML
28<root xmlns:xi="http://www.w3.org/2001/XInclude">
29  <xi:include href="included_file.xml" parse="xml"/>
30</root>
31XML;
32
33file_put_contents("xinclude_test.xml", $xmlContent);
34
35// インクルードされる側の XML ファイルを作成 (included_file.xml)
36$includedContent = <<<XML
37<included>
38  <message>Hello from included file!</message>
39</included>
40XML;
41
42file_put_contents("included_file.xml", $includedContent);
43
44// XInclude を処理する関数を呼び出し
45processXMLWithXInclude("xinclude_test.xml");
46
47// 不要になったファイルを削除
48unlink("xinclude_test.xml");
49unlink("included_file.xml");
50
51?>

このサンプルコードは、PHPのDOMDocumentクラスのxinclude()メソッドを使って、XMLドキュメント内でXIncludeを処理する方法を示しています。XIncludeは、XMLドキュメントの中に別のXMLドキュメントを埋め込むための仕組みです。

まず、DOMDocumentオブジェクトを作成し、load()メソッドでXMLファイルを読み込みます。load()メソッドがfalseを返す場合、ファイルの読み込みに失敗したことを意味します。

次に、xinclude()メソッドを呼び出して、XMLドキュメント内のXInclude要素を処理します。xinclude()メソッドは、オプションとして整数値 $options を受け取りますが、ここではデフォルト値の 0 を使用しています。xinclude()メソッドがfalseを返す場合、XIncludeの処理に失敗したことを意味します。成功した場合は、インクルードされたXMLの内容が元のドキュメントに組み込まれます。

処理が成功した場合、saveXML()メソッドを使って、処理結果のXMLドキュメントを文字列として取得し、画面に出力します。

サンプルでは、xinclude_test.xmlという名前のXMLファイルと、インクルードされる側のincluded_file.xmlという名前のXMLファイルを一時的に作成しています。xinclude_test.xmlには、included_file.xmlをインクルードするためのXInclude要素が含まれています。

最後に、作成した一時ファイルを削除しています。

xinclude()メソッドの戻り値は、処理が成功した場合は整数値、失敗した場合はfalseです。このサンプルコードは、XIncludeの基本的な使い方を理解するための良い出発点となります。