【PHP8.x】XMLReader::baseURIプロパティの使い方

Copy
1<?php
2
3/**
4 * XMLReader を使用して XML ドキュメントからベースURIを読み取るサンプル。
5 *
6 * XMLReader::baseURI は、現在のノードのベースURIを文字列で返します。
7 * ベースURIとは、XMLドキュメント内で相対URIが定義されている場合に、
8 * それらを解決するための基準となるURI (Uniform Resource Identifier) です。
9 * 例えば、XMLファイルを特定のURLから開いた場合、そのURLがベースURIとなります。
10 * XML文字列を読み込む際に明示的にURIを指定しない場合、通常は空文字列が返されます。
11 *
12 * @param string $xmlString XML ドキュメントの文字列。
13 * @param string $explicitBaseUri XMLReader::XML() に渡す明示的なベースURI (オプション)。
14 *                                 これを指定することで、XMLReader::baseURI の値となります。
15 * @return void
16 */
17function displayXmlBaseUri(string $xmlString, string $explicitBaseUri = ''): void
18{
19    // XMLReader オブジェクトを初期化します。
20    $reader = new XMLReader();
21
22    // XML 文字列を読み込みます。
23    // 第3引数 ($explicitBaseUri) にURIを指定すると、それが XMLReader::baseURI プロパティの値となります。
24    // この引数を省略するか空文字列を渡すと、baseURI は通常空文字列になります。
25    if ($reader->XML($xmlString, null, $explicitBaseUri) === false) {
26        echo "エラー: XML ドキュメントの読み込みに失敗しました。" . PHP_EOL;
27        return;
28    }
29
30    echo "--- XML ドキュメントのベースURIを確認します ---" . PHP_EOL;
31
32    // XML ドキュメントをノードごとに読み進めます。
33    // 各ノードを読み込むたびに baseURI プロパティの値を確認できます。
34    while ($reader->read()) {
35        // XMLReader::baseURI プロパティの値を取得します。
36        $baseUri = $reader->baseURI;
37
38        // ノード名とベースURIを表示します。
39        // ノード名が取得できない場合 (テキストノード、コメントノードなど) は代替テキストを表示します。
40        echo "ノード: " . ($reader->name ?: '[テキスト/コメント]') . ", baseURI: '" . $baseUri . "'" . PHP_EOL;
41    }
42
43    // XMLReader を閉じ、関連するリソースを解放します。
44    $reader->close();
45
46    echo "------------------------------------------------" . PHP_EOL;
47}
48
49// --- サンプルコードの実行例 ---
50
51// 例 1: XMLReader::XML() に明示的なベースURIを指定した場合
52// この場合、baseURI プロパティには指定したURIが表示されます。
53echo "ケース1: 明示的にベースURIを指定した場合" . PHP_EOL;
54$sampleXml1 = '<config><setting name="language" value="en"/></config>';
55$givenBaseUri1 = 'https://example.com/api/v1/settings.xml';
56displayXmlBaseUri($sampleXml1, $givenBaseUri1);
57echo PHP_EOL; // 出力の区切り
58
59// 例 2: XMLReader::XML() にベースURIを指定しなかった場合
60// この場合、baseURI プロパティは通常空文字列になります。
61echo "ケース2: ベースURIを指定しなかった場合" . PHP_EOL;
62$sampleXml2 = '<data><item id="A"/><item id="B"/></data>';
63displayXmlBaseUri($sampleXml2);
64

XMLReader::baseURIは、PHPのXMLReaderクラスが提供するプロパティで、現在処理しているXMLノードの「ベースURI」を文字列で取得します。ベースURIとは、XMLドキュメント内で相対URI（例えば、他のファイルへのパスなど）が定義されている場合に、それらを正しく解決するための基準となるURI（Uniform Resource Identifier）のことです。

このプロパティは引数を受け取らず、string型の値を返します。XMLReader::XML()メソッドでXML文字列を読み込む際、第三引数にURIを明示的に指定するか、XMLReader::open()メソッドでURLからXMLドキュメントを開いた場合に、そのURIがbaseURIプロパティの値として設定されます。もしURIが指定されなかったり、XML文字列をURIなしで読み込んだりした場合は、通常は空文字列が返されます。

サンプルコードでは、XMLReaderオブジェクトを使ってXMLドキュメントをノードごとに読み進めながら、各ノードでbaseURIプロパティの値を取得し表示しています。XMLReader::XML()メソッドに明示的にベースURIを渡した場合と、何も渡さなかった場合のbaseURIの挙動の違いを通じて、このプロパティがどのように機能するかを具体的に確認できます。これにより、XMLドキュメント内で相対パスがどのように解決されるかを理解する手助けとなります。

Copy
1<?php
2
3/**
4 * XMLファイルから、特定のノードのベースURIを取得するサンプル関数です。
5 *
6 * XMLReader::baseURI プロパティは、現在処理中のノードのベースURIを返します。
7 * これは、XML文書内で相対URIが定義されている場合に、その解決基準となるURIです。
8 * 例えば、XMLファイルがファイルシステムから直接読み込まれる場合、
9 * 通常はそのXMLファイル自体の完全なパス（file://...の形式）がベースURIとなります。
10 * WebアプリケーションのベースURLとは異なる文脈である点にご注意ください。
11 *
12 * @param string $xmlFilePath 読み込むXMLファイルのパス。
13 * @return string|null ベースURI（string型）、またはファイルが開けなかった場合はnullを返します。
14 */
15function getXmlNodeBaseUri(string $xmlFilePath): ?string
16{
17    // XMLReader オブジェクトを新規作成します。
18    $reader = new XMLReader();
19
20    // 指定されたXMLファイルを読み込みます。
21    // ファイルが見つからない、またはアクセスできない場合はエラーをログに記録し、nullを返します。
22    if (!$reader->open($xmlFilePath)) {
23        error_log("エラー: XMLファイル '{$xmlFilePath}' を開けませんでした。");
24        return null;
25    }
26
27    $baseUri = null;
28
29    // XMLノードを一つずつ読み進めます。
30    // read() メソッドは、次のノードに移動できる限りtrueを返します。
31    while ($reader->read()) {
32        // ノードが要素（開始タグ）であるかを確認します。
33        // ここでは、最初に検出された要素ノードのベースURIを取得する例を示します。
34        if ($reader->nodeType === XMLReader::ELEMENT) {
35            // 現在のノードの baseURI プロパティから値を取得します。
36            $baseUri = $reader->baseURI;
37            // 目的のURIを取得したら、これ以上読み進める必要がないためループを終了します。
38            break;
39        }
40    }
41
42    // XMLReader のリソースを解放するため、リーダーを閉じます。
43    $reader->close();
44
45    return $baseUri;
46}
47
48// === サンプルコードを単体で動作させるための実行部分 ===
49
50// 現在のディレクトリに一時的なXMLファイルを作成します。
51// 実際の利用時には、既存のXMLファイルを指定してください。
52$tempXmlFileName = 'sample_base_uri_doc.xml';
53$xmlContent = <<<XML
54<?xml version="1.0" encoding="UTF-8"?>
55<root>
56    <item id="1">サンプルデータ</item>
57    <subitem xml:base="http://example.com/base/">
58        <link href="image.png"/>
59    </subitem>
60</root>
61XML;
62
63// ファイルにXMLコンテンツを書き込みます。
64if (file_put_contents($tempXmlFileName, $xmlContent) === false) {
65    echo "エラー: 一時XMLファイル '{$tempXmlFileName}' を作成できませんでした。\n";
66    exit(1);
67}
68
69// 作成したXMLファイルを使ってベースURIを取得します。
70echo "XMLファイル '{$tempXmlFileName}' のベースURIを取得します。\n";
71$uri = getXmlNodeBaseUri($tempXmlFileName);
72
73if ($uri !== null) {
74    echo "取得されたXMLのベースURI: " . $uri . "\n";
75    // この$uriは、通常、ファイルシステム上の絶対パス (例: file:///C:/path/to/script/sample_base_uri_doc.xml)
76    // または、XML内にxml:base属性が指定されていれば、それが反映されたURIになります。
77} else {
78    echo "ベースURIの取得に失敗しました。\n";
79}
80
81// 作成した一時ファイルを削除します。
82if (file_exists($tempXmlFileName)) {
83    unlink($tempXmlFileName);
84    echo "一時ファイル '{$tempXmlFileName}' を削除しました。\n";
85}
86
87?>

このサンプルコードは、PHPのXMLReaderクラスを利用して、XMLファイル内の特定のノードが持つベースURIを取得する方法を示しています。XMLReader::baseURIプロパティは、現在XMLReaderが指しているノードのベースURIを文字列として返します。このベースURIは、XML文書内で定義されている相対URIを解決する際の基準となるものです。例えば、XMLファイルがファイルシステムから直接読み込まれる場合、通常はそのXMLファイル自体の絶対パスがベースURIとなりますが、XML文書内にxml:base属性が指定されていれば、それが優先的にベースURIとして反映されます。これはWebアプリケーションのベースURLとは異なる、XML文書の内部的なURI解決の概念である点にご注意ください。

提供されているgetXmlNodeBaseUri関数は、引数として読み込むXMLファイルのパス（$xmlFilePath）を文字列型で受け取ります。関数内部では、XMLReaderオブジェクトを作成し、指定されたXMLファイルを開いて、最初の要素ノードが見つかるまでXMLを読み進めます。最初の要素ノードが見つかると、そのノードのbaseURIプロパティから値を取得し、関数はそのURIを文字列として返します。もしファイルが開けなかった場合や、ベースURIが取得できなかった場合はnullを返します。このプロパティは、XML文書の構造を解析し、含まれるURI情報を正確に処理する際に役立ちます。