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

baseURIプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月27日

基本的な使い方

baseURIプロパティは、Dom\Commentクラスのインスタンスが持つ、基準URIに関する情報を保持するプロパティです。このプロパティは、コメントノードの基準URI（Uniform Resource Identifier）を文字列として返します。基準URIとは、そのノードが属するドキュメントや要素において、相対URIを絶対URIに解決する際に基準となるアドレス情報のことです。

例えば、ウェブページ上でimages/logo.pngのような相対パスで指定されたリソースがある場合、その相対パスをhttp://example.com/images/logo.pngのような絶対パスに変換するために、この基準URIが用いられます。HTMLドキュメントにおいては、<base>要素で明示的に指定されたURIや、ドキュメント自体が読み込まれたURIが基準URIとなります。Dom\Commentオブジェクトは、それ自体がURIを持つわけではありませんが、それが所属する親ドキュメントや要素の基準URIを継承し、このプロパティに反映されます。このプロパティは読み取り専用であり、コメントノードがどのURIを基準として相対パスを解決するべきかを理解するために利用できます。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$commentNode = $dom->createComment('これはコメントです');
4$dom->appendChild($commentNode);
5
6// Dom\CommentオブジェクトのbaseURIプロパティにアクセス
7echo $commentNode->baseURI;
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?string

このプロパティは、コメントノードが属するドキュメントのベースURIを文字列で返します。コメントノードがベースURIを持たない場合はnullを返します。

サンプルコード

PHP Dom\Comment::baseURI を取得する


1<?php
2
3/**
4 * Dom\Comment クラスの baseURI プロパティの使用方法を示すサンプルコードです。
5 *
6 * baseURI プロパティは、XML ドキュメントのノードが属するドキュメントのベース URI を返します。
7 * ファイルからロードされたドキュメントの場合、そのファイルの URI を示しますが、
8 * 新しく作成されたドキュメントの場合は通常 null または空文字列になります。
9 */
10function demonstrateDomCommentBaseURI(): void
11{
12    // 1. 新しい Dom\Document オブジェクトを作成します。
13    // このドキュメントはまだファイルからロードされていないため、baseURI は明示的に設定されていません。
14    $document = new Dom\Document('1.0', 'UTF-8');
15
16    // 2. コメントノードを作成します。
17    $commentText = 'これはテストコメントです。';
18    $commentNode = $document->createComment($commentText);
19
20    // 3. 作成したコメントノードをドキュメントツリーに追加します。
21    // Dom\Comment::baseURI は、親となる Dom\Document の baseURI を継承します。
22    $document->appendChild($commentNode);
23
24    // 4. Dom\Comment オブジェクトの baseURI プロパティにアクセスします。
25    // 新しく作成された Dom\Document の場合、baseURI は null または空文字列になることが多いです。
26    // ドキュメントがファイル（例: example.html）からロードされた場合、そのファイルのパスが設定されます。
27    $baseURI = $commentNode->baseURI;
28
29    echo "Dom\\Comment::baseURI の値: ";
30    if ($baseURI === null) {
31        echo "null\n";
32        echo "（このドキュメントはファイルからロードされていないため、baseURIは設定されていません。）\n";
33    } elseif ($baseURI === '') {
34        echo "空文字列\n";
35        echo "（このドキュメントはファイルからロードされていないため、baseURIは設定されていません。）\n";
36    } else {
37        echo $baseURI . "\n";
38    }
39}
40
41// 関数を実行して動作を確認します。
42demonstrateDomCommentBaseURI();
43

PHP 8のDom\CommentクラスのbaseURIプロパティは、XMLドキュメント内のコメントノードが属するドキュメントの基準となるURI（Uniform Resource Identifier）を返すものです。このプロパティは引数を取りません。

「ベースURI」とは、通常、そのドキュメントが読み込まれたファイルの場所を示すURIを指します。例えば、example.xmlというファイルからドキュメントがロードされた場合、baseURIはそのファイルのパスを示す文字列となります。

このプロパティの戻り値は?string型で、URIを表す文字列、またはnullが返されます。新しいDom\Documentオブジェクトをプログラム内で作成し、ファイルから読み込まずにコメントノードを追加した場合、そのドキュメントにはベースURIが設定されていないため、Dom\Comment::baseURIプロパティはnullまたは空文字列を返します。これは、コメントノードのベースURIが親ドキュメントのベースURIを継承するためです。

サンプルコードでは、新しいDom\Documentを作成し、コメントノードを追加しています。このドキュメントはファイルからロードされていないため、コメントノードのbaseURIプロパティにアクセスすると、結果としてnullが表示されます。この動作を通じて、baseURIがいつ値を持つのか、また持たないのかを理解することができます。

Dom\Comment::baseURIプロパティは、コメントノードが属するXMLドキュメントの基準URIを返しますが、その値は状況によって変わる点に注意が必要です。新しいDom\Documentを作成し、そこにコメントを追加しただけでは、baseURIは多くの場合nullまたは空文字列となります。これはドキュメントがまだファイルからロードされていないためです。ドキュメントをファイルから読み込んだ場合にのみ、そのファイルのURIがbaseURIに設定されます。戻り値は?string型のため、取得した値がnullである可能性を常に考慮し、if ($baseURI === null)のようなnullチェックを必ず行ってください。このプロパティは、ノードの出自やドキュメントのロード元を判断する際に利用できます。

PHPでDOMコメントのbaseURIを取得する


1<?php
2
3/**
4 * DOMドキュメント内のコメントノードからベースURIを取得するサンプル。
5 *
6 * Dom\Comment::baseURIプロパティは、そのノードが属するドキュメントの
7 * ベースURI（基本となるURI）を返します。これは、HTML/XMLドキュメント内で
8 * 相対パス（例: <a href="images/foo.png">）を絶対パスに解決する際の
9 * 基準となるURIとして利用されます。
10 *
11 * 通常、PHPのloadHTML()関数で文字列からHTMLを読み込んだ場合、baseURIは
12 * スクリプトが実行されている現在のディレクトリの絶対パス（例: file:///path/to/script/）
13 * となることが多いです。もしloadHTMLFile()などでファイルからロードした場合は、
14 * そのファイルのURIがbaseURIとして設定されます。
15 *
16 * このbaseURIは、一般的なウェブサイトのルートURL（例: https://www.example.com/）とは異なり、
17 * ドキュメント解析における相対パス解決のための基準点を示すものです。
18 *
19 * @return string|null コメントノードのベースURI、
20 *                     またはコメントノードが見つからない場合やベースURIが設定されていない場合はnull。
21 */
22function getDomCommentBaseUri(): ?string
23{
24    // 解析対象となるHTMLコンテンツ
25    $htmlContent = <<<HTML
26    <!DOCTYPE html>
27    <html>
28    <head>
29        <title>Base URI Example</title>
30    </head>
31    <body>
32        <!-- このコメントノードのbaseURIを取得します -->
33        <p>これはテスト用の段落です。</p>
34        <img src="images/logo.png" alt="ロゴ">
35    </body>
36    </html>
37    HTML;
38
39    $dom = new DOMDocument();
40    // HTMLの解析エラーメッセージを非表示にする (libxml_use_internal_errors を使用)
41    // これにより、HTML5のタグなどに対する警告が表示されなくなります。
42    libxml_use_internal_errors(true);
43    $dom->loadHTML($htmlContent);
44    libxml_clear_errors(); // エラーを処理した後、クリアしておくことが推奨されます
45
46    $xpath = new DOMXPath($dom);
47
48    // ドキュメント内の全てのコメントノードを検索
49    // '//comment()' はXPathで全てのコメントノードを選択します
50    $commentNodes = $xpath->query('//comment()');
51
52    if ($commentNodes->length > 0) {
53        // 最初に見つかったコメントノードを取得
54        // PHP 8では、DOMCommentクラスはDom\Commentクラスのエイリアスです。
55        $commentNode = $commentNodes->item(0);
56
57        // Dom\Comment::baseURI プロパティにアクセスし、その値を返す
58        // このプロパティの戻り値の型は ?string (stringまたはnull) です。
59        return $commentNode->baseURI;
60    }
61
62    return null; // ドキュメント内にコメントノードが見つからない場合
63}
64
65// 関数を実行し、結果を出力
66$baseUri = getDomCommentBaseUri();
67
68if ($baseUri !== null) {
69    echo "DOMコメントノードのベースURI: " . $baseUri . PHP_EOL;
70} else {
71    echo "DOMコメントノードが見つからないか、ベースURIが取得できませんでした。" . PHP_EOL;
72}

Dom\Comment::baseURIプロパティは、DOMドキュメント内のコメントノードが属するドキュメントのベースURI（基本となるURI）を取得するために使用されます。このベースURIは、HTMLやXMLドキュメント内で定義された相対パス（例えば、<img src="images/logo.png">のような記述）を、絶対パスに解決する際の基準となるURLとして機能します。

PHPのDOMDocument::loadHTML()関数でHTML文字列を読み込んだ場合、baseURIはスクリプトが実行されているディレクトリの絶対パス（file:///スキーム）となることが一般的です。一方、DOMDocument::loadHTMLFile()関数でファイルから読み込んだ場合は、そのファイルのURIがベースURIとして設定されます。これは一般的なウェブサイトのルートURLとは異なり、ドキュメント解析における内部的な基準点を示します。

このプロパティは引数を持ちません。戻り値の型は?stringであり、コメントノードのベースURIを文字列として返しますが、ベースURIが設定されていない場合や、コメントノードが見つからない場合はnullを返します。

サンプルコードでは、まずHTML文字列をDOMDocumentで解析し、DOMXPathを利用してドキュメント内のコメントノードを検索しています。その後、最初に見つかったコメントノードに対してbaseURIプロパティにアクセスし、その値を画面に出力することで、ドキュメントのベースURIを確認しています。これにより、DOM操作で相対パスがどのように解決されるかの基準を理解できます。

このサンプルコードのDom\Comment::baseURIプロパティは、一般的なウェブサイトのルートURLではなく、HTML/XMLドキュメント内で相対パスを絶対パスに解決するための基準URIを示す点に注意が必要です。

loadHTML()で文字列からドキュメントを読み込んだ場合、通常はスクリプトの実行ディレクトリのパスがベースURIとなります。一方、loadHTMLFile()でファイルから読み込んだ場合は、そのファイルのURIが設定されます。

戻り値はstringまたはnullの可能性があるため、結果を利用する際には必ずnullチェックを行いましょう。

また、libxml_use_internal_errors(true)でHTML解析時の警告を非表示にできますが、処理後はlibxml_clear_errors()でエラー情報をクリアすることを推奨します。これにより、他のDOM操作に影響を与えず、予期せぬ挙動を防ぐことができます。