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

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

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

基本的な使い方

baseURIプロパティは、Dom\Attrクラスのインスタンスが表す属性ノードのベースURI（Uniform Resource Identifier）を保持するプロパティです。PHPのDOM拡張の一部として利用できるDom\Attrクラスは、HTMLやXMLドキュメントにおける要素の属性（例えば、<a href="index.html">のhrefのように、要素に付加される情報）を表現するために使用されます。このbaseURIプロパティは、その属性ノードが属するドキュメントや外部エンティティがどこに位置しているのかを示す、基準となるURL（ウェブサイトのアドレス）のような情報を文字列として提供します。

具体的には、ドキュメント内で相対パスが指定されたリソース（例えば、画像やリンクなど）を絶対パスに変換する際に、どのURLを基準として解決すべきかという情報を提供します。例えば、外部から読み込まれたXMLデータに含まれる属性が相対パスを持つ場合、このbaseURIプロパティを参照することで、その属性のパスを正しく解釈するための元のURIを知ることができます。このプロパティは読み取り専用であり、通常は有効なベースURIを文字列で返しますが、ベースURIが不明な場合や適用されない場合はnullを返すこともあります。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$dom->loadHTML('<a href="example.html" id="my-link">Link</a>');
4$element = $dom->getElementById('my-link');
5$attr = $element->attributes->getNamedItem('href');
6
7echo $attr->baseURI;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、この属性ノードの基底URIを表す文字列を返します。

サンプルコード

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


1<?php
2
3/**
4 * Dom\Attr::baseURI プロパティの使用例を示す関数です。
5 * このプロパティは、属性ノードが属するドキュメントの基底URIを返します。
6 * 通常、ドキュメントがファイルからロードされた場合、そのファイルのパスになります。
7 */
8function demonstrateDomAttrBaseURI(): void
9{
10    // 1. Dom\Document オブジェクトがロードする一時的なHTMLファイルを作成します。
11    // これにより、後で取得する属性ノードの baseURI がこのファイルのパスになります。
12    $tempHtmlFileName = 'example_document_for_baseuri.html';
13    $htmlContent = '<!DOCTYPE html><html><head><title>Test Document</title></head><body><div id="myElement" data-example="value">Hello Dom\Attr</div></body></html>';
14
15    // ファイルへの書き込みに失敗した場合はエラーメッセージを表示して終了します。
16    if (file_put_contents($tempHtmlFileName, $htmlContent) === false) {
17        echo "エラー: 一時ファイル '{$tempHtmlFileName}' の作成に失敗しました。" . PHP_EOL;
18        return;
19    }
20
21    echo "一時ファイル '{$tempHtmlFileName}' を作成しました。" . PHP_EOL;
22
23    try {
24        // 2. Dom\Document オブジェクトを初期化し、作成したHTMLファイルをロードします。
25        // PHP 8 以降では、新しい Dom ネームスペースが推奨されます。
26        $document = new Dom\Document();
27        $document->loadHTMLFile($tempHtmlFileName);
28
29        // 3. ドキュメント内の特定の要素とその属性ノードを取得します。
30        // 'myElement'というIDを持つ<div>要素を見つけます。
31        $element = $document->getElementById('myElement');
32
33        if ($element === null) {
34            echo "エラー: ID 'myElement' の要素が見つかりませんでした。" . PHP_EOL;
35            return;
36        }
37
38        // その要素から 'data-example' という属性のノードを取得します。
39        // このgetAttributeNode()メソッドは Dom\Attr オブジェクトを返します。
40        $attrNode = $element->getAttributeNode('data-example');
41
42        if ($attrNode === null) {
43            echo "エラー: 'data-example' 属性ノードが見つかりませんでした。" . PHP_EOL;
44            return;
45        }
46
47        // 4. 取得した Dom\Attr オブジェクトの baseURI プロパティの値を表示します。
48        // baseURI は、この属性ノードが属するドキュメントの基底URIを示します。
49        // ファイルからロードした場合は、そのファイルの絶対パスとなります。
50        echo "----------------------------------------" . PHP_EOL;
51        echo "Dom\\Attr プロパティ情報:" . PHP_EOL;
52        echo "  属性名: " . $attrNode->name . PHP_EOL;
53        echo "  属性値: " . $attrNode->value . PHP_EOL;
54        echo "  Dom\\Attr::baseURI: " . $attrNode->baseURI . PHP_EOL;
55        echo "----------------------------------------" . PHP_EOL;
56
57    } catch (Throwable $e) {
58        // 例外が発生した場合、エラーメッセージを表示します。
59        echo "処理中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
60    } finally {
61        // 5. 使用した一時ファイルを削除し、クリーンアップを行います。
62        if (file_exists($tempHtmlFileName)) {
63            unlink($tempHtmlFileName);
64            echo "一時ファイル '{$tempHtmlFileName}' を削除しました。" . PHP_EOL;
65        }
66    }
67}
68
69// 上記の関数を実行し、Dom\Attr::baseURI の動作を確認します。
70demonstrateDomAttrBaseURI();
71
72?>

Dom\Attr::baseURIプロパティは、XMLやHTMLドキュメント内で特定の属性ノードが属しているドキュメントの基底URI（Uniform Resource Identifier）を文字列として返します。このプロパティは引数を取らず、常に文字列を戻り値として提供します。

このプロパティは、DOM（Document Object Model）を操作する際に、特定の属性ノードがどの場所から読み込まれたドキュメントの一部であるかを知りたい場合に利用されます。例えば、ファイルシステム上のファイルからHTMLドキュメントを読み込んだ場合、そのドキュメント内の属性ノードのbaseURIは、その読み込んだファイルの絶対パスを示します。これは、ドキュメント内で使用される相対パスを解決する際の基点となります。

サンプルコードでは、まず一時的なHTMLファイルを作成し、それをDom\Documentオブジェクトでロードしています。次に、ドキュメント内の特定の要素から属性ノード（Dom\Attrオブジェクト）を取得し、そのbaseURIプロパティの値を表示しています。実行すると、作成した一時ファイルのパスがbaseURIとして出力され、このプロパティがドキュメントの読み込み元の情報を正確に提供していることが確認できます。このように、baseURIはドキュメントのコンテキストを理解する上で役立つ情報を提供します。

このサンプルコードは、Dom\Attr::baseURIプロパティが、属性ノード自身の値ではなく、その属性ノードが属するドキュメント全体の基底URIを返すことを示しています。一時ファイルからHTMLをロードしているため、baseURIは作成された一時ファイルの絶対パスとなります。Webアプリケーションでは、通常は現在のページのURLやHTMLの<base>タグで指定されたURIが基底URIとして適用されますのでご注意ください。ファイル操作やDOM要素の取得は失敗する可能性があるため、file_put_contentsの結果確認や、getElementById、getAttributeNodeがnullを返す場合のチェックなど、適切なエラーハンドリングを常に実装することが重要です。このコードはPHP 8以降で推奨されるDomネームスペースを使用しています。

PHP Dom\Attr::baseURIで属性のベースURIを取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\Attr::baseURI プロパティの使用例を示します。
7 * XMLドキュメント内の特定の属性ノードが持つベースURIを取得します。
8 *
9 * baseURIは、そのノードが属するドキュメントまたは親要素から継承されるURI、
10 * あるいはXMLデータ内の 'xml:base' 属性によって明示的に指定されるURIです。
11 * WebアプリケーションのベースURL（ウェブサイトのルートURL）とは異なる概念であることに注意してください。
12 *
13 * @return void
14 */
15function demonstrateDomAttrBaseURI(): void
16{
17    // 新しいDOMDocumentオブジェクトを作成します。
18    $dom = new DOMDocument('1.0', 'UTF-8');
19
20    // 'xml:base' 属性を含むXML文字列をロードします。
21    // 'xml:base' 属性は、その要素とその子孫ノードのベースURIを定義します。
22    $xmlString = <<<XML
23<?xml version="1.0" encoding="UTF-8"?>
24<root>
25  <element id="example-element" data-attribute="value_a" xml:base="http://example.com/custom_base/">
26    <child-element sub-attribute="value_b"/>
27  </element>
28  <another-element data-attribute="value_c"/>
29</root>
30XML;
31
32    // XML文字列をDOMDocumentにロードします。
33    // loadXML() を使用した場合、ドキュメント自体の baseURI は通常 null となります。
34    $dom->loadXML($xmlString);
35
36    // 'element' 要素をIDで取得します。
37    $element = $dom->getElementById('example-element');
38
39    if ($element instanceof DOMElement) {
40        echo "要素 'element' が見つかりました。\n";
41        // 要素自体のベースURIを表示します。'xml:base' の値が反映されます。
42        echo "  要素 'element' の baseURI: " . ($element->baseURI ?? 'null') . "\n";
43
44        // 'element' 要素の 'data-attribute' 属性ノードを取得します。
45        // これは Dom\Attr オブジェクトを返します。
46        $attrNode = $element->getAttributeNode('data-attribute');
47
48        if ($attrNode instanceof Dom\Attr) {
49            echo "  属性 'data-attribute' が見つかりました。\n";
50            // Dom\Attr::baseURI プロパティは、この属性が属する要素のベースURIを返します。
51            // ここでは、親要素 'element' に設定された 'xml:base' の値が継承されます。
52            echo "  属性 'data-attribute' の baseURI: " . ($attrNode->baseURI ?? 'null') . "\n";
53        } else {
54            echo "  属性 'data-attribute' が見つかりませんでした。\n";
55        }
56    } else {
57        echo "要素 'element' が見つかりませんでした。\n";
58    }
59
60    echo "\n-- 'xml:base' が設定されていない要素の属性の例 --\n";
61
62    // 'another-element' 要素を取得します。
63    $anotherElement = $dom->getElementsByTagName('another-element')->item(0);
64
65    if ($anotherElement instanceof DOMElement) {
66        echo "要素 'another-element' が見つかりました。\n";
67        // この要素には 'xml:base' が設定されていないため、ドキュメントのベースURI (null) を継承します。
68        echo "  要素 'another-element' の baseURI: " . ($anotherElement->baseURI ?? 'null') . "\n";
69
70        $simpleAttrNode = $anotherElement->getAttributeNode('data-attribute');
71        if ($simpleAttrNode instanceof Dom\Attr) {
72            echo "  属性 'data-attribute' が見つかりました。\n";
73            // 'another-element' に 'xml:base' がないため、
74            // この属性の baseURI もドキュメントのベースURI (null) を継承します。
75            echo "  属性 'data-attribute' の baseURI: " . ($simpleAttrNode->baseURI ?? 'null') . "\n";
76        } else {
77            echo "  属性 'data-attribute' が見つかりませんでした。\n";
78        }
79    } else {
80        echo "要素 'another-element' が見つかりませんでした。\n";
81    }
82}
83
84// 関数を実行して、Dom\Attr::baseURI の動作を確認します。
85demonstrateDomAttrBaseURI();

PHPのDom\Attr::baseURIプロパティは、XMLドキュメント内の特定の属性ノードが持つベースURIを取得するために使用されます。このプロパティは引数を取らず、属性ノードのベースURIをstring型で返します。ベースURIとは、そのノードが属するドキュメントや親要素から継承されるURI、あるいはXMLデータ内のxml:base属性によって明示的に指定されるURIのことです。一般的なWebアプリケーションのベースURL（ウェブサイトのルートURL）とは異なる、XMLの文脈での概念である点にご注意ください。

提供されたサンプルコードでは、xml:base属性が設定されたXMLをDOMDocumentにロードし、Dom\Attr::baseURIプロパティの動作を示しています。まず、IDがexample-elementの要素にはxml:base="http://example.com/custom_base/"が設定されており、その要素に属するdata-attribute属性ノードのbaseURIを取得すると、このxml:baseの値が返されます。次に、xml:baseが設定されていないanother-element要素の属性ノードのbaseURIを取得する例も示されており、この場合は親要素からの継承やxml:baseがないため、通常はnull（またはドキュメントのベースURI）が返されることが確認できます。このコードは、xml:base属性が属性ノードのbaseURIにどのように影響するかを具体的に理解するのに役立ちます。

Dom\Attr::baseURIは、WebサイトのベースURLではなく、XMLドキュメント内で定義されるノードの基準URIを示します。これは主にXMLデータ中のxml:base属性やドキュメントの読み込み元によって決定されます。属性ノードのbaseURIは、その属性が所属する親要素のbaseURIを継承して返されます。DOMDocument::loadXML()でXML文字列を読み込んだ場合、xml:baseが明示的に指定されていない要素や属性のbaseURIは通常nullとなる点にご注意ください。getAttributeNodeのようなメソッドは、対象の属性ノードが見つからない場合にnullを返しますので、必ずinstanceof Dom\Attrで戻り値の型を確認してからプロパティにアクセスし、安全にコードを記述することが重要です。戻り値は文字列ですが、nullの可能性も考慮し、サンプルコードのように?? 'null'などで適切に処理することをおすすめします。