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

Copy
1<?php
2
3// XML ドキュメントをロードし、XInclude を処理するサンプル
4function processXInclude(string $xmlFile): int
5{
6    // XML ドキュメントを作成
7    $dom = new DOMDocument();
8
9    // XML ファイルをロード
10    if (!$dom->load($xmlFile)) {
11        echo "Failed to load XML file.\n";
12        return -1; // エラーコード
13    }
14
15    // XInclude を処理
16    $result = $dom->xinclude();
17
18    // 処理結果を確認
19    if ($result) {
20        // 処理後の XML を出力（または他の処理）
21        echo $dom->saveXML();
22        return 0; // 成功コード
23    } else {
24        echo "XInclude processing failed.\n";
25        return -2; // エラーコード
26    }
27}
28
29// XInclude を含む XML ファイルのパス
30$xmlFile = 'xinclude.xml';
31
32// サンプル XML ファイルを作成 (存在しない場合)
33if (!file_exists($xmlFile)) {
34    $xmlContent = <<<XML
35<?xml version="1.0"?>
36<root xmlns:xi="http://www.w3.org/2001/XInclude">
37  <xi:include href="included.xml" />
38</root>
39XML;
40
41    file_put_contents($xmlFile, $xmlContent);
42
43    $includedXmlContent = <<<XML
44<included>
45  <message>This is included content.</message>
46</included>
47XML;
48    file_put_contents('included.xml', $includedXmlContent);
49}
50
51// XInclude 処理を実行
52$status = processXInclude($xmlFile);
53
54// 処理結果に基づいてメッセージを表示
55if ($status === 0) {
56    echo "XInclude processed successfully.\n";
57} else {
58    echo "XInclude processing failed with code: " . $status . "\n";
59}
60
61?>

このサンプルコードは、PHPのDOMDocumentクラスのxincludeメソッドを使用して、XMLドキュメントにXIncludeを適用する方法を示します。xincludeメソッドは、XMLドキュメント内の<xi:include>要素を、指定されたファイルの内容で置き換える処理を行います。

まず、DOMDocumentオブジェクトを作成し、loadメソッドでXIncludeを含むXMLファイルを読み込みます。次に、xinclude()メソッドを呼び出して、XMLドキュメント内のXIncludeディレクティブを処理します。xinclude()メソッドは、処理が成功した場合はtrue（1）、失敗した場合はfalse（0）を返します。オプションとして、処理の挙動を制御する整数値を $options 引数に指定できます（デフォルトは0）。

サンプルでは、xinclude.xmlというファイルが存在しない場合に、サンプルファイルを作成しています。このXMLファイルは、included.xmlという別のファイルをインクルードするよう指定しています。

xinclude()メソッドの処理結果に応じて、処理後のXMLドキュメントをsaveXML()メソッドで文字列として出力します。そして、処理が成功したかどうかに応じてメッセージを表示します。戻り値として、処理のステータスを示す整数値を返します。0は成功、-1と-2はエラーを表します。XIncludeを使用することで、XMLドキュメントをモジュール化し、再利用性を高めることができます。