Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

baseURIプロパティは、DOMDocumentFragmentクラスに属し、ノードの基底URI(Base URI)を保持するプロパティです。

基底URIとは、ウェブドキュメント内の相対URI(例えば、画像ファイルやリンクのパスなど)を、完全な絶対URIに解決する際の基準となるURIを指します。例えば、ウェブページのHTMLドキュメントであれば、そのページのURL自体が基底URIとなります。

DOMDocumentFragmentは、HTMLやXMLドキュメントの「断片」を表すオブジェクトであり、完全なドキュメントとしては扱われません。そのため、DOMDocumentFragmentオブジェクト自体は、通常、独立したURIを持つことがありません。

したがって、このbaseURIプロパティにアクセスした場合、ほとんどのケースで値はnullを返します。これは、DOMDocumentFragmentが単独でURIの解決基準を持つのではなく、それが最終的に挿入される親ドキュメントの基底URIに依存して相対パスが解決されるためです。

PHPでDOM操作を行う際に、DOMDocumentFragment内の要素が持つ相対的なリソースパスの解決基準を確認したい場合、このプロパティの値がnullであることを考慮する必要があります。この振る舞いを理解することで、より堅牢なDOM処理を実装できるようになります。

構文(syntax)

1<?php
2
3// DOMDocumentオブジェクトを作成します
4$doc = new DOMDocument();
5
6// HTMLを読み込みます。このとき、<base>タグでベースURIが設定されます
7$doc->loadHTML('<html><head><base href="http://www.example.com/path/"></head><body></body></html>');
8
9// ドキュメントに属するDOMDocumentFragmentオブジェクトを作成します
10$fragment = $doc->createDocumentFragment();
11
12// DOMDocumentFragmentのbaseURIプロパティ(読み取り専用)にアクセスし、
13// 所属するドキュメントのベースURIを取得します
14echo $fragment->baseURI;
15
16?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string|null

このプロパティは、このDOMDocumentFragmentの基底URIを文字列として返します。基底URIが設定されていない場合は、nullを返します。

サンプルコード

PHP: DOMDocumentFragmentのbaseURIを取得する

1<?php
2
3/**
4 * DOMDocumentFragmentのbaseURIプロパティの使用例を示します。
5 *
6 * DOMDocumentFragmentは、XML/HTMLノードの「断片」を表現する特殊なノードです。
7 * baseURIプロパティは、そのノードが属するベースURI(相対パス解決の基準となるURI)を返しますが、
8 * DOMDocumentFragment自体は通常、特定のドキュメントツリーに属していないため、
9 * このプロパティはほとんどの場合 `null` を返します。
10 *
11 * システムエンジニアを目指す初心者の方へ:
12 * baseURIは、WebページやXMLドキュメントで相対パス(例: <img src="image.png">)を
13 * 解決する際に「どこを基準にするか」を示す重要な情報です。
14 * DOMDocumentFragmentの場合は、まだドキュメントに組み込まれていないため、
15 * 基準となるURIがないことが多いということを理解しましょう。
16 */
17function showDomDocumentFragmentBaseUriExample(): void
18{
19    // 新しいDOMDocumentを作成します。
20    // DOMDocumentFragmentは通常、DOMDocumentから作成されます。
21    $dom = new DOMDocument();
22
23    // DOMDocumentFragmentのインスタンスを作成します。
24    // このフラグメントはまだどのドキュメントツリーにも挿入されていません。
25    $fragment = $dom->createDocumentFragment();
26
27    // DOMDocumentFragmentのbaseURIプロパティにアクセスします。
28    // フラグメントは独立しているため、通常は null が返されます。
29    $baseUri = $fragment->baseURI;
30
31    echo "DOMDocumentFragmentのbaseURI: ";
32    if (is_null($baseUri)) {
33        echo "null\n";
34    } else {
35        echo $baseUri . "\n";
36    }
37}
38
39// 関数を実行してサンプルコードの動作を確認します。
40showDomDocumentFragmentBaseUriExample();

PHP 8のDOMDocumentFragmentクラスに属するbaseURIプロパティは、XMLやHTMLノードの基準となるURI(ベースURI)を取得します。このプロパティは引数を取らず、文字列(string)またはnullを戻り値として返します。

DOMDocumentFragmentは、XMLやHTMLのノードを一時的にまとめる特殊な「断片」です。これは通常、特定のDOMドキュメントにまだ挿入されていない状態で作成されます。そのため、このbaseURIプロパティにアクセスした場合、ほとんどのケースで基準となるURIが存在しないことを示すnullが返されます。

システムエンジニアを目指す初心者の方にとって、baseURIはWebページやXMLドキュメント内で相対パス(例えば、<img src="images/logo.png">のようにファイル名だけが指定されているパス)を解決する際に、どこを基準にすれば良いかを示す重要な情報です。これにより、ブラウザやプログラムは正しいリソースの場所を特定できます。

このサンプルコードでは、DOMDocumentからDOMDocumentFragmentのインスタンスを生成しています。生成直後のフラグメントはどのドキュメントにも挿入されていないため、$fragment->baseURIにアクセスしても、出力結果は「null」となります。これは、独立したDOMDocumentFragmentには、相対パス解決の基準となるURIが設定されていないという挙動を示しています。

DOMDocumentFragmentのbaseURIプロパティは、通常nullを返します。これは、このオブジェクトが独立したノードの断片であり、まだ特定のドキュメントに挿入されていないため、相対パスを解決する基準となるURIを持たないことが主な理由です。

サンプルコードのように、このプロパティにアクセスする際は、戻り値がstringまたはnullのどちらでも安全に対応できるよう、is_null()などで必ず戻り値をチェックしてください。baseURIはWebコンテンツ内で相対パスを絶対パスに変換する際の基準となる重要な情報ですが、DOMDocumentFragmentの文脈ではその役割を持つことが稀です。したがって、有効なURIが返されることはほとんどなく、基本的にはnullとして処理する前提でコードを記述すると、予期せぬエラーを防ぎ安全です。

PHP DOMDocumentFragment baseURI を取得する

1<?php
2
3/**
4 * DOMDocumentFragment の baseURI プロパティの使用例を示す関数。
5 *
6 * DOMDocumentFragment は、DOMツリーの一部として機能するドキュメントの断片です。
7 * baseURI プロパティは、この断片が相対URIを解決するために使用するベースURIを返します。
8 * 通常、これはその断片が所属する DOMDocument のベースURIを継承します。
9 *
10 * @return void
11 */
12function demonstrateDomDocumentFragmentBaseUri(): void
13{
14    echo "DOMDocumentFragment::baseURI プロパティのデモンストレーション:\n\n";
15
16    // 1. 新しい DOMDocument オブジェクトを作成します。
17    $dom = new DOMDocument();
18
19    // 2. HTMLコンテンツをロードし、<base>タグでドキュメントのベースURIを明示的に設定します。
20    //    これにより、ドキュメント内の相対URIはこのベースURIを基準に解決されます。
21    $htmlContent = '
22    <!DOCTYPE html>
23    <html>
24    <head>
25        <title>テストドキュメント</title>
26        <base href="http://www.example.com/documents/v1/">
27    </head>
28    <body>
29        <h1>サンプルページ</h1>
30        <p>このページはテスト用に作成されました。</p>
31    </body>
32    </html>';
33    $dom->loadHTML($htmlContent);
34
35    // DOMDocument の baseURI を表示します。
36    echo "DOMDocument の baseURI: " . ($dom->baseURI ?? "null (未設定)") . "\n";
37
38    // 3. DOMDocument から DOMDocumentFragment を作成します。
39    //    DOMDocumentFragment は、複数のノードを一度に扱うためのコンテナとして使用されます。
40    $fragment = $dom->createDocumentFragment();
41
42    // 4. フラグメントにノードを追加します(baseURIには直接影響しませんが、一般的な使用法です)。
43    $paragraph = $dom->createElement('p', 'これはフラグメントに追加された段落です。');
44    $fragment->appendChild($paragraph);
45
46    // 5. DOMDocumentFragment の baseURI プロパティを取得し、表示します。
47    //    DOMDocumentFragment の baseURI は、それが所属する DOMDocument の baseURI を継承します。
48    //    ここでは、<base>タグで設定されたURIが反映されていることを確認できます。
49    $fragmentBaseUri = $fragment->baseURI;
50
51    echo "DOMDocumentFragment の baseURI: " . ($fragmentBaseUri ?? "null (未設定)") . "\n";
52
53    if ($fragmentBaseUri !== null) {
54        echo "この baseURI は、フラグメント内の相対パスを解決する際に使用されます。\n";
55        echo "例: 相対パス 'images/logo.png' は '" . rtrim($fragmentBaseUri, '/') . "/images/logo.png' として解決されます。\n";
56    } else {
57        echo "baseURI が設定されていない場合、相対パスの解決は現在のスクリプトまたは親のコンテキストに依存します。\n";
58    }
59}
60
61// 上記の関数を実行してデモンストレーションを開始します。
62demonstrateDomDocumentFragmentBaseUri();

PHP 8のDOMDocumentFragmentクラスにおけるbaseURIプロパティは、ドキュメントの断片が相対URIを解決する際の基準となるURIを取得します。DOMDocumentFragmentは、DOMツリーの一部として機能するノードの集合を扱うためのコンテナです。このプロパティは引数を取らず、ベースURIを表す文字列を返すか、設定がない場合はnullを返します。

提供されたサンプルコードでは、まずDOMDocumentを作成し、HTMLコンテンツの<base href="...">タグを用いてドキュメント全体のベースURIを明示的に設定しています。この設定されたベースURIは、DOMDocumentbaseURIとして取得できます。次に、このDOMDocumentからDOMDocumentFragmentを作成すると、そのフラグメントは親であるDOMDocumentのベースURIを継承します。したがって、DOMDocumentFragmentbaseURIは、この親ドキュメントで設定された値が反映されます。

このbaseURIは、フラグメント内の要素が持つ相対パスを絶対URIとして解決する際の基準となります。例えば、baseURIhttp://www.example.com/documents/v1/であれば、フラグメント内の相対パスimages/logo.pnghttp://www.example.com/documents/v1/images/logo.pngとして解釈されます。これにより、フラグメント内の相対パスが意図通りに解釈され、コンテンツの正しい処理を可能にします。

DOMDocumentFragment::baseURIプロパティは、通常、所属するDOMDocumentbaseURIを継承します。親のDOMDocumentbaseURIは、HTMLコンテンツ内の<base>タグで明示的に設定されるか、ドキュメントがファイルパスやURLから読み込まれた際に自動で決定されます。もし親のDOMDocumentbaseURIが設定されていない場合、DOMDocumentFragment::baseURInullを返します。

このプロパティの戻り値はstringまたはnullであるため、値を参照する前には必ずnullチェックを行い、nullの場合の挙動を考慮してください。baseURIは、フラグメント内の相対パス(例: <img>タグのsrc属性)を絶対パスとして解決する際の基準となります。nullの場合は相対パスの解決方法が変わるため、特に注意が必要です。

関連コンテンツ

関連IT用語

関連プログラミング言語