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

Copy
1<?php
2
3/**
4 * DOMDocumentとDOMCommentを使用して、コメントノードの基底URI (baseURI) を取得するサンプルコードです。
5 * baseURIは、ノードが属するドキュメントがどこから読み込まれたか（または作成されたか）を示すURIです。
6 * このサンプルでは、直接DOMを構築するため、baseURIは通常nullまたは空文字列となります。
7 */
8function getCommentBaseURI(): void
9{
10    // 1. 新しいDOMDocumentインスタンスを作成します。
11    // これは空のHTML/XMLドキュメントとして機能します。
12    $doc = new DOMDocument();
13    // オプション: フォーマットを整形して読みやすくする
14    $doc->formatOutput = true;
15
16    // 2. 新しいコメントノードを作成します。
17    // この時点では、このコメントノードはどのドキュメントにも属していません。
18    $commentText = 'これはPHPスクリプトによって追加されるコメントです。';
19    $commentNode = $doc->createComment($commentText);
20
21    // ドキュメントに追加する前のbaseURIプロパティの値を確認します。
22    // 親ノードがなく、ドキュメントツリーに属していないため、通常は null が返されます。
23    echo "--- ドキュメント追加前 ---\n";
24    echo "コメントの内容: " . $commentNode->nodeValue . "\n";
25    echo "baseURI: " . ($commentNode->baseURI ?? 'null (ドキュメントに属していません)') . "\n\n";
26
27    // 3. 作成したコメントノードをDOMDocumentのルートに追加します。
28    // これにより、コメントノードはドキュメントツリーの一部となります。
29    $doc->appendChild($commentNode);
30
31    // 4. ドキュメントに追加されたコメントノードの baseURI プロパティにアクセスします。
32    // baseURIは、ノードが属するドキュメントの読み込み元URIを示します。
33    // このスクリプトのようにDOMDocumentを新規作成し、直接ノードを追加した場合、
34    // ドキュメント自体に具体的なURI（ファイルパスなど）がないため、
35    // baseURIは通常 'null' または空文字列 '' となります。
36    // (PHPのバージョンやDOMDocumentのメソッドによっては挙動が異なる場合があります)
37    // 例えば、$doc->loadHTMLFile('example.html'); のようにファイルから読み込んだ場合は、
38    // そのファイルのパスがbaseURIとして設定されることがあります。
39    $baseURI = $commentNode->baseURI;
40
41    echo "--- ドキュメント追加後 ---\n";
42    echo "コメントの内容: " . $commentNode->nodeValue . "\n";
43    echo "baseURI: ";
44    if ($baseURI === null) {
45        echo "null (ドキュメントにURIが設定されていません)";
46    } elseif ($baseURI === '') {
47        echo "'' (空文字列 - ドキュメントにURIが設定されていません)";
48    } else {
49        echo $baseURI;
50    }
51    echo "\n";
52}
53
54// 関数を実行してサンプルコードを動作させます。
55getCommentBaseURI();

PHP 8のDOMCommentクラスが持つbaseURIプロパティは、コメントノードが属するドキュメントの基底URI（基本となるURI）を提供するものです。これは、そのノードが属するドキュメントがどこから読み込まれたか、あるいは作成されたかを示す情報と言えます。このプロパティは引数を取らず、戻り値として文字列（string）またはnullを返します。nullは、URI情報が存在しない場合や特定できない場合に返されます。

サンプルコードでは、DOMDocumentを作成し、そこにDOMCommentノードを生成しています。まず、コメントノードがまだどのドキュメントにも追加されていない段階では、その「場所」が未定であるため、baseURIプロパティはnullを返します。

次に、このコメントノードをDOMDocumentに追加し、ドキュメントツリーの一部とします。ノードがドキュメントに属するようになると、そのドキュメントの基底URIがbaseURIに反映されます。しかし、今回のサンプルコードのように、PHPスクリプト内でDOMDocumentを新規作成し、直接ノードを追加した場合は、ドキュメント自体に外部から読み込まれた具体的なURI情報がないため、baseURIは通常nullまたは空文字列（''）となります。例えば、DOMDocument::loadHTMLFile()メソッドで外部のHTMLファイルを読み込んだ場合には、そのファイルのパスがbaseURIとして設定されることとなり、挙動が異なります。このbaseURIプロパティは、ドキュメント内の相対パスを絶対パスに解決する際などに基準となるURIを特定するために利用されます。

Copy
1<?php
2
3/**
4 * DOMCommentノードからbaseURIプロパティを取得するサンプルコードです。
5 * baseURIは、そのノードが属するドキュメントのベースURI（Uniform Resource Identifier）を返します。
6 * メモリ上で作成されたドキュメントの場合、通常は空文字列になります。
7 * ファイルからロードされたドキュメントの場合は、そのファイルのパスがベースURIとなります。
8 */
9function demonstrateDomCommentBaseUri(): void
10{
11    // 1. 新しいDOMDocumentオブジェクトを作成します。
12    //    これはHTMLまたはXMLドキュメントをメモリ上で表現するためのオブジェクトです。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 出力を整形するために設定
15
16    // 2. 簡単なHTML構造をドキュメントに追加します。
17    $html = $dom->createElement('html');
18    $dom->appendChild($html);
19    $body = $dom->createElement('body');
20    $html->appendChild($body);
21
22    // 3. コメントノードを作成します。
23    //    DOMDocument::createComment() メソッドを使用して新しいDOMCommentオブジェクトを作成します。
24    $commentText = 'これはサンプルコメントです。';
25    $commentNode = $dom->createComment($commentText);
26
27    // 4. 作成したコメントノードをドキュメントのbody要素に追加します。
28    $body->appendChild($commentNode);
29
30    echo "DOMCommentのbaseURIプロパティのデモ:\n";
31    echo "-----------------------------------\n";
32
33    // 5. DOMCommentオブジェクトのbaseURIプロパティにアクセスして値を取得します。
34    //    このプロパティは読み取り専用で、ノードが属するドキュメントのURIを返します。
35    //    戻り値は ?string (string型またはnull) です。
36    $baseUri = $commentNode->baseURI;
37
38    echo "作成されたコメントのテキスト: " . $commentNode->nodeValue . "\n";
39    echo "コメントノードの baseURI: ";
40
41    // baseURIがnullまたは空文字列の場合を考慮して表示します。
42    if ($baseUri === null) {
43        echo "null (ベースURIが未定義です)\n";
44    } elseif ($baseUri === '') {
45        echo "' ' (空文字列: ドキュメントがメモリ上で作成されたか、ベースURIが指定されていません)\n";
46    } else {
47        echo $baseUri . "\n";
48    }
49
50    echo "\n生成されたHTML構造:\n";
51    echo $dom->saveHTML(); // ドキュメントの内容をHTML形式で出力
52}
53
54// 関数を実行してデモを開始します。
55demonstrateDomCommentBaseUri();
56

PHPのDOMCommentクラスのbaseURIプロパティは、そのコメントノードが属するドキュメントのベースURI（Uniform Resource Identifier）を取得するために利用されます。このプロパティは引数を取らず、戻り値として?string型、つまり文字列またはnullを返します。具体的には、ノードのURIが存在しない場合や未定義の場合にはnullが、URIが空である場合は空文字列（''）が返される可能性があります。

baseURIが返す値は、ドキュメントの生成元によって異なります。例えば、サンプルコードのようにメモリ上で新しいDOMDocumentを作成した場合、関連付けられるベースURIがないため、baseURIプロパティは通常、空文字列となります。これに対し、既存のXMLやHTMLファイルを読み込んでDOMDocumentを生成した場合は、そのファイルのパスがベースURIとして返されます。

サンプルコードでは、DOMDocumentとDOMCommentをメモリ上で作成し、そのコメントノードからbaseURIプロパティの値を取得しています。実行結果を通じて、メモリ上で作成されたドキュメントに属するコメントのbaseURIが空文字列となることを確認できます。このプロパティは、ドキュメント内の相対パスなどを解決する際の基準点として利用できるため、DOM操作を行うシステム開発において重要な情報を提供します。