【PHP8.x】DOMDocument::baseURIプロパティの使い方
baseURIプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
DOMDocumentクラスのbaseURIプロパティは、ドキュメントのベースURI（Uniform Resource Identifier）を保持するプロパティです。ベースURIとは、ドキュメント内の相対URIを解決するための基準となるURIのことです。具体的には、ドキュメント内で使用されている相対パスによるリンクや画像参照などを、絶対パスに変換する際に参照されるURIとなります。
このプロパティの値は、ドキュメントがどのようにロードされたかによって異なります。例えば、ファイルシステムからロードされた場合は、そのファイルのパスがベースURIとなります。ネットワーク経由でロードされた場合は、ドキュメントのURLがベースURIとなります。DOMDocumentオブジェクトが新規に作成され、まだ外部ソースからロードされていない場合は、通常、このプロパティは空文字列となります。
baseURIプロパティは、DOMDocumentオブジェクトの読み取り専用プロパティとして提供されており、直接値を設定することはできません。ベースURIを変更するには、ドキュメントを異なる場所からロードし直す必要があります。
システムエンジニアを目指す上で、このプロパティの重要性は、XMLやHTMLドキュメントをプログラムで扱う際に、相対URIを適切に解決し、意図したリソースにアクセスするために不可欠であるという点にあります。特に、ウェブアプリケーション開発においては、コンテンツの配信場所やリソースの配置を考慮し、正確なベースURIを理解することが重要となります。
構文(syntax)
1DOMDocument::$baseURI;
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
DOMDocument オブジェクトがロードされたドキュメントのベース URI を表す文字列を返します。この URI は、ドキュメントの解決の基点となります。
サンプルコード
PHP DOMDocument::baseURI を確認する
1<?php 2 3/** 4 * DOMDocument::baseURI プロパティの使用方法を示すサンプル関数。 5 * baseURIは、HTMLやXMLドキュメントの基準となるURI（Uniform Resource Identifier、URLの一般的な概念）を示します。 6 * このプロパティは、特にドキュメント内の相対パスの解決基準として使用されます。 7 * 8 * システムエンジニアを目指す初心者向けに、このプロパティがいつ設定され、いつ空になるのかを解説します。 9 */ 10function demonstrateDomBaseUri(): void 11{ 12 // 1. DOMDocument クラスのインスタンスを作成します。 13 // DOMDocumentは、HTMLやXMLドキュメントをオブジェクトとして扱い、プログラムで操作するためのPHPの標準クラスです。 14 $dom = new DOMDocument(); 15 16 // 2. HTML文字列をロードします。 17 // この方法 (loadHTML()) でドキュメントをロードした場合、 18 // DOMDocumentは「このHTMLがインターネット上のどこから来たか」という情報を持たないため、 19 // baseURIプロパティは通常、空文字列（またはnull）になります。 20 $htmlContent = ' 21 <!DOCTYPE html> 22 <html> 23 <head> 24 <meta charset="utf-8"> 25 <title>DOMDocument::baseURI デモンストレーション</title> 26 </head> 27 <body> 28 <h1>baseURI プロパティの確認</h1> 29 <p>このドキュメントは、プログラム内で直接HTML文字列として読み込まれました。</p> 30 <img src="images/logo.png" alt="ロゴ画像"> 31 <a href="/about.html">会社概要</a> 32 </body> 33 </html> 34 '; 35 $dom->loadHTML($htmlContent); 36 37 // 3. baseURIプロパティの値を取得します。 38 // 上記の通り文字列からロードしただけなので、ここでは空文字列が期待されます。 39 $baseUriFromHtmlString = $dom->baseURI; 40 41 echo "--- HTML文字列からDOMDocumentをロードした場合 ---" . "\n"; 42 echo "DOMDocument::baseURI の値: " . (empty($baseUriFromHtmlString) ? "[空文字列またはnull]" : $baseUriFromHtmlString) . "\n"; 43 echo "解説: この場合、ドキュメントがファイルやURLからロードされていないため、" . "\n"; 44 echo " 基準となるURIの情報がDOMDocumentにありません。そのため、baseURIは空になります。" . "\n\n"; 45 46 // 4. (参考) 外部ファイルやURLからロードした場合の baseURI についての補足説明 47 echo "--- (参考) 外部ファイルやURLからロードした場合の baseURI ---" . "\n"; 48 echo "baseURIプロパティは、通常、ドキュメントがロードされた絶対URIを示します。" . "\n"; 49 echo "例えば、PHPの `loadHTMLFile()` メソッドでインターネット上のHTMLファイルを読み込んだ場合、" . "\n"; 50 echo "そのファイルのURLがbaseURIとして設定されます。" . "\n"; 51 echo " 例: \$dom->loadHTMLFile('http://example.com/pages/document.html'); のようにロードした場合、" . "\n"; 52 echo " baseURIは 'http://example.com/pages/document.html' のようになります。" . "\n"; 53 echo "このbaseURIは、ドキュメント内の `<img src=\"images/logo.png\">` や `<a href=\"/about.html\">` のような" . "\n"; 54 echo "相対パスを絶対パスに解決する際の基準点として非常に重要です。" . "\n"; 55} 56 57// 上記で定義した関数を実行し、DOMDocument::baseURIの動作を確認します。 58demonstrateDomBaseUri(); 59 60?>
DOMDocument::baseURIプロパティは、HTMLやXMLドキュメントの基準となるURIを示す文字列を返します。このプロパティに引数はなく、常にドキュメントの基準URIを文字列型として返します。特に、ドキュメント内の<img src="images/logo.png">のような相対パスを、プログラムが絶対パスとして正しく解釈する際の基準点として非常に重要な役割を果たします。
サンプルコードでは、DOMDocumentインスタンスにHTML文字列をloadHTML()メソッドで直接読み込んでいます。この方法でドキュメントを読み込んだ場合、PHPはドキュメントが特定のファイルやURLからロードされたという情報を持たないため、baseURIプロパティは通常、空文字列となります。実行結果でこの挙動を確認できます。
一方、DOMDocument::loadHTMLFile()メソッドのように、実際のファイルパスやインターネット上のURLを指定してドキュメントをロードすると、そのファイルやURLがbaseURIとして自動的に設定されます。例えば、http://example.com/pages/document.htmlからロードすれば、baseURIもこのURLとなります。このようにbaseURI情報が設定されることで、プログラムは相対パスを正確に絶対パスへ変換し、ドキュメントの内容を適切に処理できるようになります。
DOMDocument::baseURIプロパティは、ドキュメントの読み込み方法によって値が異なりますので注意が必要です。プログラム内で直接HTML文字列をloadHTML()で読み込んだ場合、このプロパティは通常、空文字列となります。これは、DOMDocumentがドキュメントの元となるURI情報を持たないためです。一方、外部ファイルやURLをloadHTMLFile()などのメソッドで読み込んだ場合には、そのファイルの絶対URIがbaseURIとして設定されます。このbaseURIは、ドキュメント内の相対パス（例えば<img src="images/logo.png">のような記述）を絶対パスに変換する際の基準点として機能します。したがって、相対パスを正確に処理するためには、baseURIがどのように設定されるかを常に理解しておくことが重要です。
PHP DOMDocument::baseURI を取得する
1<?php 2 3/** 4 * DOMDocument::baseURI プロパティの取得例 5 * 6 * 指定されたURLからHTMLドキュメントを読み込み、 7 * そのドキュメントが取得された元のベースURIを返します。 8 * 9 * @param string $url 読み込むHTMLドキュメントのURL 10 * @return string|null 読み込んだドキュメントのベースURI、またはエラー時にnull 11 */ 12function getDocumentBaseUri(string $url): ?string 13{ 14 // DOMDocument オブジェクトを新しく作成します。 15 // このオブジェクトを使ってHTMLやXMLドキュメントを操作します。 16 $dom = new DOMDocument(); 17 18 // libxml のエラーレポートを内部的に処理するように設定します。 19 // これにより、HTML/XMLのパースエラーがPHPの警告として表示されるのを防ぎ、 20 // $dom->loadHTMLFile() の戻り値で成否を判断できるようにします。 21 libxml_use_internal_errors(true); 22 23 // 指定されたURLからHTMLドキュメントを読み込みます。 24 // 成功した場合は true、失敗した場合は false を返します。 25 if (!$dom->loadHTMLFile($url)) { 26 // ドキュメントの読み込みに失敗した場合、エラーメッセージを表示します。 27 echo "エラー: '{$url}' からドキュメントを読み込めませんでした。\n"; 28 // エラーハンドリングを元に戻し、null を返します。 29 libxml_use_internal_errors(false); 30 return null; 31 } 32 33 // libxml のエラーハンドリングを元の設定に戻します。 34 libxml_use_internal_errors(false); 35 36 // ドキュメントのベースURIを取得して返します。 37 // baseURI プロパティは、ドキュメントが読み込まれた元のURIを示します。 38 return $dom->baseURI; 39} 40 41// === 使用例 === 42// 実際のウェブサイトのURLを指定してください。 43// このスクリプトを実行するには、インターネット接続が必要です。 44// 存在しない、またはアクセスできないURLを指定するとエラーになります。 45$targetUrl = "http://example.com/"; // テスト用のURL 46 47echo "ターゲットURL: " . $targetUrl . "\n"; 48 49// 関数を呼び出してベースURIを取得します。 50$baseUri = getDocumentBaseUri($targetUrl); 51 52if ($baseUri !== null) { 53 echo "取得されたベースURI: " . $baseUri . "\n"; 54} else { 55 echo "ベースURIの取得に失敗しました。\n"; 56 echo "指定されたURLが有効であるか、ネットワーク接続を確認してください。\n"; 57} 58 59?>
PHPのDOMDocument::baseURIプロパティは、HTMLやXMLドキュメントが取得された元のベースURI（基準となるURL）を取得するために使われます。これは、ドキュメント内の相対パスがどこを基準に解決されるべきかを示す重要な情報です。
提供されたサンプルコードでは、getDocumentBaseUriという関数が、指定されたURLのHTMLドキュメントを読み込み、そのドキュメントのベースURIを返します。まず、DOMDocumentクラスのオブジェクトを新しく作成し、これを使ってHTMLドキュメントを扱います。libxml_use_internal_errors(true)を設定することで、ドキュメントの解析中に発生する可能性のあるエラーがPHPの警告として表示されるのを防ぎ、読み込みの成否をより明確に判断できるようにしています。
次に、$dom->loadHTMLFile($url)メソッドで、引数として渡された$urlからHTMLドキュメントを読み込みます。この読み込みが失敗した場合、関数はエラーメッセージを表示し、nullを返します。読み込みが成功すると、$dom->baseURIプロパティにアクセスすることで、ドキュメントのベースURIが文字列として取得され、関数の戻り値となります。このbaseURIは、ドキュメントがどこから来たのかを教えてくれるため、ウェブスクレイピングやコンテンツ解析において、リンクや画像などのリソースの絶対パスを特定する際に非常に役立ちます。
このサンプルコードは、指定されたURLからHTMLドキュメントを読み込み、そのベースURIを取得します。loadHTMLFile()関数はインターネット経由で外部リソースにアクセスするため、安定したネットワーク接続が必要です。指定したURLが存在しない、またはアクセスできない場合は、ドキュメントの読み込みに失敗しますのでご注意ください。libxml_use_internal_errors()は、HTMLパース時の警告を抑制し、loadHTMLFile()の成否を正確に判断するために使用されます。この設定は、他の処理への影響を避けるため、関数内で適切に元に戻すことが重要です。実運用では、エラー時のログ記録や例外処理など、より堅牢なエラーハンドリングの検討をお勧めいたします。