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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::baseURI プロパティの使用例を示す関数。
5 *
6 * このプロパティは、XMLドキュメントがロードされたベースURI（Uniform Resource Identifier）を返します。
7 * 例えば、ファイルからロードされた場合はそのファイルのパス、
8 * ネットワーク上のURLからロードされた場合はそのURLを返します。
9 * XML文字列からロードされた場合など、ベースURIが存在しない場合は null を返します。
10 *
11 * @return void
12 */
13function demonstrateXmlDocumentBaseURI(): void
14{
15    echo "Dom\\XMLDocument::baseURI プロパティのデモンストレーション:\n";
16
17    // 1. 一時的なXMLファイルを作成し、Dom\XMLDocument::load() でロードする
18    //    この方法でロードすると baseURI がファイルパスに設定されます。
19    $xmlContent = <<<XML
20<?xml version="1.0" encoding="UTF-8"?>
21<root>
22    <item>サンプルデータ</item>
23    <description>このドキュメントのベースURIを確認します。</description>
24</root>
25XML;
26    // 一時ファイルのパスを生成
27    $tempFilePath = sys_get_temp_dir() . '/example_document_' . uniqid() . '.xml';
28
29    // 一時ファイルにXMLコンテンツを書き込む
30    file_put_contents($tempFilePath, $xmlContent);
31
32    try {
33        // Dom\XMLDocument のインスタンスを作成
34        $document = new Dom\XMLDocument();
35
36        // XMLファイルをロード
37        // この処理により、baseURI プロパティには $tempFilePath の値が設定されます。
38        $document->load($tempFilePath);
39
40        echo "\n--- ファイルからロードした場合 ---\n";
41        echo "ロード元のURI (ファイルパス): " . $tempFilePath . "\n";
42        // baseURI プロパティの値を取得し、null の場合は代替文字列を表示
43        echo "取得された baseURI: " . ($document->baseURI ?? "null (ベースURIなし)") . "\n";
44
45    } catch (Throwable $e) {
46        // XMLドキュメントのロード中に発生したエラーを捕捉
47        echo "XMLドキュメントのロード中にエラーが発生しました: " . $e->getMessage() . "\n";
48    } finally {
49        // 処理後、作成した一時ファイルを削除してクリーンアップ
50        if (file_exists($tempFilePath)) {
51            unlink($tempFilePath);
52        }
53    }
54
55    // 補足: Dom\XMLDocument::loadXML() を使ってXML文字列から直接ロードした場合、
56    //       通常 baseURI プロパティは null になります。
57    //       これは、特定のファイルやURLに紐付けられていないためです。
58}
59
60// demonstrateXmlDocumentBaseURI 関数を実行
61demonstrateXmlDocumentBaseURI();
62
63?>

Dom\XMLDocument::baseURI プロパティは、PHP 8で導入されたDOM拡張機能の一部であり、XMLドキュメントがどこからロードされたかを示すベースURI（Uniform Resource Identifier）を取得するために使用されます。このプロパティは引数を取らず、ドキュメントの元の場所を文字列として返します。

具体的には、XMLドキュメントがファイルパスを指定してDom\XMLDocument::load()メソッドでロードされた場合、そのファイルのパス（string）を返します。また、ネットワーク上のURLからロードされた場合も、そのURLが文字列として返されます。一方、XML文字列から直接Dom\XMLDocument::loadXML()メソッドでドキュメントが作成された場合など、特定のファイルやURLに紐付けられていない場合は、このプロパティはnullを返します。

サンプルコードでは、一時的なXMLファイルを作成し、Dom\XMLDocument::load()メソッドでそのファイルを読み込んでいます。この操作により、baseURIプロパティにはロード元のファイルパスが設定され、その値が表示されることを確認できます。このように、baseURIを使用することで、XMLドキュメントの出所をプログラムから確認し、相対パスの解決やデバッグに役立てることが可能です。

Copy
1<?php
2
3/**
4 * 一時的な XML ファイルを作成し、指定されたコンテンツを書き込みます。
5 *
6 * @param string $content XMLコンテンツ文字列
7 * @return string 作成された一時ファイルのパス
8 * @throws RuntimeException 一時ファイルの作成に失敗した場合
9 */
10function createTempXmlFile(string $content): string
11{
12    // システムの一時ディレクトリにユニークなファイル名で一時ファイルを作成します。
13    // 'xml_example_' はファイル名のプレフィックスです。
14    $tempFileName = tempnam(sys_get_temp_dir(), 'xml_example_');
15
16    if ($tempFileName === false) {
17        throw new RuntimeException("一時ファイルの作成に失敗しました。一時ディレクトリの書き込み権限を確認してください。");
18    }
19
20    // ファイルにXMLコンテンツを書き込みます。
21    if (file_put_contents($tempFileName, $content) === false) {
22        unlink($tempFileName); // 書き込みに失敗した場合は作成されたファイルを削除します。
23        throw new RuntimeException("一時ファイルへのXMLコンテンツの書き込みに失敗しました。");
24    }
25
26    return $tempFileName;
27}
28
29/**
30 * Dom\XMLDocument クラスの baseURI プロパティの使用例を示します。
31 *
32 * Dom\XMLDocument::baseURI は、XML ドキュメントがロードされた元の URI を返します。
33 * これは、XML ドキュメント内の相対パスを解決する際の基準となる URI です。
34 *
35 * 注意: これはウェブアプリケーションにおける「ベースURL」（例: https://example.com/）
36 * とは異なる概念です。主にXMLファイルの物理的な場所を指します。
37 */
38function demonstrateDomXmlDocumentBaseUri(): void
39{
40    // サンプルとなるシンプルな XML コンテンツ
41    $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>
42<root>
43    <item id="1">First Item</item>
44    <item id="2">Second Item</item>
45</root>';
46
47    $tempXmlFile = ''; // 後で一時ファイルのパスを格納するために初期化
48
49    try {
50        // 1. XML コンテンツを含む一時ファイルを作成します。
51        $tempXmlFile = createTempXmlFile($xmlContent);
52        echo "作成された一時XMLファイルのパス: " . $tempXmlFile . "\n\n";
53
54        // 2. Dom\XMLDocument インスタンスを作成します。
55        // PHP 8 で導入された新しい DOM 拡張の推奨クラスです。
56        $document = new Dom\XMLDocument();
57
58        // 3. 一時ファイルから XML ドキュメントをロードします。
59        // load() メソッドは、ファイルパスまたは URL から XML をロードします。
60        if ($document->load($tempXmlFile)) {
61            echo "XMLファイルが正常にロードされました。\n";
62
63            // 4. baseURI プロパティの値を取得し、表示します。
64            // ファイルからロードした場合、baseURI はそのファイルの絶対パス (URI形式) になります。
65            $baseUriFromFile = $document->baseURI;
66            echo "Dom\\XMLDocument::baseURI (ファイルからロード): " . ($baseUriFromFile ?? 'null') . "\n";
67
68            echo "\n--- 文字列からXMLをロードした場合の baseURI ---\n";
69
70            // 5. 新しい Dom\XMLDocument インスタンスを作成し、文字列からXMLをロードします。
71            $documentFromString = new Dom\XMLDocument();
72            // loadXML() メソッドは、XML コンテンツ文字列から XML をロードします。
73            if ($documentFromString->loadXML($xmlContent)) {
74                echo "XMLコンテンツが文字列から正常にロードされました。\n";
75
76                // 6. 文字列からロードした場合の baseURI を取得し、表示します。
77                // 通常、文字列からロードした場合は baseURI は null になります。
78                $baseUriFromString = $documentFromString->baseURI;
79                echo "Dom\\XMLDocument::baseURI (文字列からロード): " . ($baseUriFromString ?? 'null') . "\n";
80            } else {
81                echo "XMLコンテンツの文字列からのロードに失敗しました。\n";
82            }
83
84        } else {
85            echo "一時XMLファイルのロードに失敗しました。パスが正しいか、ファイルが有効なXMLであるか確認してください。\n";
86        }
87    } catch (RuntimeException $e) {
88        // エラーが発生した場合にメッセージを表示します。
89        echo "エラーが発生しました: " . $e->getMessage() . "\n";
90    } finally {
91        // 7. 処理の最後に、作成された一時ファイルを削除します。
92        // これにより、ディスクスペースを消費せず、クリーンアップされます。
93        if (!empty($tempXmlFile) && file_exists($tempXmlFile)) {
94            unlink($tempXmlFile);
95            echo "\n一時ファイルを削除しました: " . $tempXmlFile . "\n";
96        }
97    }
98}
99
100// 上記のサンプル関数を実行します。
101demonstrateDomXmlDocumentBaseUri();

Dom\XMLDocument::baseURIは、PHP 8で導入された新しいDOM拡張に属するプロパティで、XMLドキュメントがどこからロードされたかを示すURI（Uniform Resource Identifier）を返します。これは、XMLドキュメント内の相対パスを解決する際の基準となる場所を表します。

このサンプルコードでは、baseURIプロパティの挙動を二つのケースで確認しています。まず、createTempXmlFile関数で作成した一時XMLファイルをDom\XMLDocumentクラスのload()メソッドでロードした場合、baseURIはその一時ファイルの絶対パス（URI形式）を文字列として返します。これは、XMLドキュメントが物理的なファイルからロードされたことを示しています。

次に、loadXML()メソッドを使ってXMLコンテンツを文字列から直接ロードした場合、baseURIプロパティは通常nullを返します。これは、特定のファイルパスが存在しないためです。

このbaseURIは、ウェブアプリケーションのルートパスを示す一般的な「ベースURL」とは異なり、主にXMLドキュメント自体の物理的な場所やロード元を特定するために使用されます。戻り値はstring型またはnullとなります。