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

Copy
1<?php
2
3// このスクリプトは、Dom\XMLDocument クラスの documentURI プロパティの使用方法を示します。
4// documentURI は、XML ドキュメントがロードされた場所（URIまたはファイルパス）を返します。
5
6// サンプルとして使用するXMLコンテンツを定義します。
7$xmlContent = <<<XML
8<?xml version="1.0" encoding="UTF-8"?>
9<data>
10  <item id="1">First Item</item>
11  <item id="2">Second Item</item>
12</data>
13XML;
14
15// 一時ファイルをシステムのテンポラリディレクトリに作成します。
16// tempnam() は一意なファイル名を生成し、その名前で空のファイルを作成します。
17$tempXmlFilePath = tempnam(sys_get_temp_dir(), 'xml_example_');
18
19// 一時ファイルの作成に失敗した場合の処理。
20if ($tempXmlFilePath === false) {
21    echo "エラー: 一時ファイルを作成できませんでした。\n";
22    exit(1);
23}
24
25// XMLコンテンツを一時ファイルに書き込みます。
26if (file_put_contents($tempXmlFilePath, $xmlContent) === false) {
27    echo "エラー: XMLコンテンツを一時ファイルに書き込めませんでした。\n";
28    // 部分的に作成されたファイルをクリーンアップします。
29    if (file_exists($tempXmlFilePath)) {
30        unlink($tempXmlFilePath);
31    }
32    exit(1);
33}
34
35try {
36    // Dom\XMLDocument クラスの新しいインスタンスを作成します。
37    // PHP 8.1 以降では、DOMDocument は Dom\XMLDocument のエイリアスです。
38    $document = new Dom\XMLDocument();
39
40    // 一時ファイルからXMLをロードします。
41    // この操作により、documentURI プロパティがファイルのパスに設定されます。
42    if (!$document->load($tempXmlFilePath)) {
43        throw new Exception("XMLファイルのロードに失敗しました: " . $tempXmlFilePath);
44    }
45
46    // documentURI プロパティにアクセスし、その値を取得します。
47    // このプロパティは、ドキュメントがロードされたURI（ファイルパスなど）を返します。
48    // 文字列からロードされた場合や、URI情報がない場合は null を返すことがあります。
49    $documentUri = $document->documentURI;
50
51    // documentURI の値を出力します。
52    echo "読み込んだXMLファイルのURI (documentURI): ";
53    if ($documentUri !== null) {
54        echo $documentUri . "\n";
55    } else {
56        echo "N/A (documentURIが設定されていません。通常、XMLが文字列から直接読み込まれた場合に発生します。)\n";
57    }
58
59} catch (Exception $e) {
60    // エラーが発生した場合、メッセージを出力します。
61    echo "エラーが発生しました: " . $e->getMessage() . "\n";
62} finally {
63    // 処理が成功したか失敗したかに関わらず、一時ファイルを確実に削除します。
64    if (file_exists($tempXmlFilePath)) {
65        unlink($tempXmlFilePath);
66    }
67}

PHP 8のDom\XMLDocumentクラスが持つdocumentURIプロパティは、XMLドキュメントがどこからロードされたか、その元のURI（統一リソース識別子）やファイルパスを示す情報を提供します。このプロパティは引数を取りません。戻り値はstring型またはnullとなります。

具体的には、外部のファイルやURLからDom\XMLDocumentインスタンスにXMLドキュメントを読み込んだ場合、documentURIはそのリソースのパスを示す文字列を返します。例えば、load()メソッドでファイルを読み込むと、そのファイルのパスがこのプロパティに設定されます。

しかし、XMLドキュメントがプログラム内の文字列から直接作成された場合や、何らかの理由でURI情報が関連付けられていない場合には、documentURIはnullを返します。

サンプルコードでは、一時ファイルにXMLコンテンツを保存し、その一時ファイルをDom\XMLDocumentのload()メソッドで読み込んでいます。その後、$document->documentURIにアクセスすると、読み込んだ一時ファイルのパスが文字列として取得され、出力されます。これにより、documentURIがXMLドキュメントのロード元を正確に示していることが確認でき、ドキュメントのソースの特定やデバッグなどに活用できます。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::documentURI プロパティの使用方法をデモンストレーションします。
5 *
6 * この関数は、XMLドキュメントがどこからロードされたか（そのURI）を取得する方法を示します。
7 * キーワード「php documentroot」と関連付けて、XMLファイルがサーバー上の
8 * ドキュメントルート以下に配置されるケースを想定した説明を含みます。
9 *
10 * @return void
11 */
12function demonstrateDomXMLDocumentURI(): void
13{
14    // システムエンジニアを目指す初心者の方へ:
15    // この例では、設定ファイルに見立てたXMLを一時的に作成し、
16    // それを Dom\XMLDocument クラスで読み込みます。
17    // その後、読み込んだXMLがどこにあるかを示すURI (場所) を取得します。
18
19    // 1. サンプルXMLファイルの内容を定義
20    //    これは、ウェブアプリケーションの設定ファイルなどをイメージしてください。
21    $xmlContent = <<<'XML'
22<?xml version="1.0" encoding="UTF-8"?>
23<application>
24    <environment>development</environment>
25    <database>
26        <host>localhost</host>
27        <name>app_db</name>
28        <user>app_user</user>
29    </database>
30    <config name="max_connections" value="100"/>
31</application>
32XML;
33
34    // 2. XMLコンテンツを一時ファイルとして保存
35    //    `sys_get_temp_dir()` はOSが提供する一時ディレクトリのパスを返します。
36    //    これにより、実際にファイルシステムに存在するXMLファイルをロードできます。
37    //    ウェブサーバーの `DOCUMENT_ROOT` (ドキュメントルート) に配置される
38    //    XMLファイルをシミュレートしていると考えてください。
39    $tempFileName = 'app_settings.xml';
40    $tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . $tempFileName;
41    file_put_contents($tempFilePath, $xmlContent);
42
43    echo "一時XMLファイルを以下のパスに作成しました:\n";
44    echo "  " . $tempFilePath . "\n\n";
45
46    try {
47        // 3. Dom\XMLDocument::createFromFile() メソッドでXMLファイルをロード
48        //    このPHP 8で導入されたメソッドは、指定されたファイルパス (URI) から
49        //    新しいXMLドキュメントオブジェクトを構築します。
50        $document = Dom\XMLDocument::createFromFile($tempFilePath);
51
52        // 4. documentURI プロパティからXMLドキュメントのURIを取得
53        //    `documentURI` は、そのXMLドキュメントがどこからロードされたか、
54        //    あるいはそのドキュメントのベースURIを示します。
55        //    `createFromFile()` を使ってファイルをロードした場合、
56        //    ロード元のファイルのURI (絶対パス) がこのプロパティに設定されます。
57        $documentUri = $document->documentURI;
58
59        echo "Dom\\XMLDocument::documentURI プロパティの値:\n";
60        echo "  " . ($documentUri ?? 'null (URIが設定されていません)') . "\n\n";
61
62        // 5. キーワード「php documentroot」との関連性についての補足説明
63        echo "補足 (キーワード: php documentroot):\n";
64        echo "  `documentURI` はXMLファイル自身の「物理的な場所」または「ベースURI」を示します。\n";
65        echo "  もしこのPHPスクリプトがウェブサーバー上で実行され、\n";
66        echo "  `" . $tempFileName . "` がウェブサーバーのドキュメントルート\n";
67        echo "  (PHPの `$_SERVER['DOCUMENT_ROOT']` で取得できるパス) 以下に存在していた場合、\n";
68        echo "  `documentURI` は、`file:///` または `/` から始まるファイルの絶対パス、\n";
69        echo "  あるいはウェブ経由でアクセスされた場合は `http://...` となることがあります。\n";
70        echo "  これはPHPスクリプトの実行パスとは異なり、XMLドキュメントがどこに「存在するか」を\n";
71        echo "  XMLのコンテキストで示すものです。\n";
72
73    } catch (Dom\Exception $e) {
74        // XMLファイルのロード中にエラーが発生した場合の処理
75        echo "XMLファイルのロード中にエラーが発生しました: " . $e->getMessage() . "\n";
76    } finally {
77        // 6. 後処理: 作成した一時ファイルを削除
78        //    テスト用のファイルなので、不要になったら削除します。
79        if (file_exists($tempFilePath)) {
80            unlink($tempFilePath);
81            echo "\n一時XMLファイルを削除しました: " . $tempFilePath . "\n";
82        }
83    }
84}
85
86// 上記の関数を実行して、サンプルコードの動作を確認します。
87demonstrateDomXMLDocumentURI();
88
89?>

Dom\XMLDocument::documentURIプロパティは、PHP 8で導入されたDom\XMLDocumentクラスに属し、XMLドキュメントがどこからロードされたか、またはそのドキュメントのベースとなるURIを示す役割を持ちます。このプロパティは引数を取らず、XMLドキュメントのURIを表す文字列を返しますが、URIが設定されていない場合はnullを返します。

このサンプルコードでは、まず一時的なXML設定ファイルを作成し、それをDom\XMLDocument::createFromFile()メソッドで読み込みます。このメソッドは、指定されたファイルパスから新しいXMLドキュメントオブジェクトを構築します。ファイルからのロードが完了した後、$document->documentURIと記述することで、そのXMLドキュメントがファイルシステム上のどのパスから読み込まれたか、つまりその絶対URIを取得できます。

取得されるURIは、例えばfile:///tmp/app_settings.xmlのような形式となり、XMLファイル自身の物理的な場所を示します。これは、WebサーバーのDOCUMENT_ROOT（ドキュメントルート）以下に配置されたXMLファイルを扱う際にも重要です。documentURIはPHPスクリプトの実行パスとは異なり、XMLドキュメントが「どこに存在するファイルか」をXMLのコンテキストで明確に示し、関連リソースの解決などに利用できる情報となります。システムエンジニアを目指す方にとって、設定ファイルなどの物理的な場所を正確に把握する上で役立つプロパティです。