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

Copy
1<?php
2
3// DOMDocumentを作成します。これはXML/HTMLドキュメントを表現するためのクラスです。
4// '1.0' はXMLのバージョン、'UTF-8' は文字エンコーディングを指定します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6
7// ドキュメントにルート要素 '<root>' を作成し追加します。
8$element = $dom->createElement('root');
9$dom->appendChild($element);
10
11// ルート要素に 'exampleAttr' という名前の属性を作成し、値を設定します。
12$attr = $dom->createAttribute('exampleAttr');
13$attr->value = 'someValue';
14$element->appendChild($attr);
15
16// 作成した属性（DOMAttrオブジェクト）を要素から取得します。
17// attributes->getNamedItem() メソッドを使って、名前で属性を取得します。
18$domAttr = $element->attributes->getNamedItem('exampleAttr');
19
20// 属性が正常に取得できたかを確認します。
21if ($domAttr instanceof DOMAttr) {
22    // DOMAttr の baseURI プロパティにアクセスし、その属性のベースURIを取得します。
23    // baseURI は、属性が定義されているノード（この場合は <root> 要素）の
24    // ベースURIを指します。
25    // メモリ内で作成されたDOMDocumentの場合、通常は空文字列 ('') または null になります。
26    // ファイルから読み込まれたDOMDocumentの場合、そのファイルのURIになることがあります。
27    $baseURI = $domAttr->baseURI;
28
29    echo "属性 '{$domAttr->name}' のベースURI: ";
30
31    // baseURI の値に基づいて適切なメッセージを表示します。
32    // 戻り値は string|null なので、null の可能性も考慮します。
33    if ($baseURI === null || $baseURI === '') {
34        echo "未定義 (メモリ内で作成されたため、またはベースURIがないため)\n";
35    } else {
36        echo $baseURI . "\n";
37    }
38} else {
39    echo "エラー: 属性 'exampleAttr' が見つかりませんでした。\n";
40}

このPHPサンプルコードは、DOM（Document Object Model）における属性（DOMAttr）のベースURI（baseURI）プロパティの働きを具体的に示しています。baseURIプロパティは、その属性が属する文書のベースURIを取得するために使用されます。

コードではまず、新しいXMLドキュメントを作成し、ルート要素である<root>と、その要素にexampleAttrという名前の属性をプログラム上で追加しています。次に、追加したexampleAttr属性に対応するDOMAttrオブジェクトを要素から取得しています。

DOMAttr::baseURIプロパティは、引数を一切取らず、戻り値としてstring型またはnullを返します。このプロパティの値は、属性が定義されているノード（この場合は<root>要素）のベースURIを示します。例えば、ファイルからXMLドキュメントを読み込んだ場合は、そのファイルのURIがbaseURIとして返されることがあります。しかし、このサンプルコードのようにメモリ上で新規に作成されたドキュメントの場合、ベースURIが明示的に設定されていないため、通常は空文字列（''）またはnullが返されます。

サンプルコードでは、取得したDOMAttrオブジェクトのbaseURIプロパティにアクセスし、その結果を表示しています。nullまたは空文字列が返された場合は「未定義」と表示し、それ以外の値の場合は実際のURIを表示することで、baseURIの挙動を初心者の方にも分かりやすく説明しています。このプロパティは、ドキュメント内の相対パスを絶対パスに解決する際などに利用されます。

Copy
1<?php
2
3/**
4 * DOMAttr::baseURI プロパティの使用例を示す関数。
5 *
6 * この関数は、XML文字列からDOMドキュメントを作成し、
7 * その中の属性から baseURI プロパティを取得する方法を示します。
8 * baseURI は、属性が定義されている要素の基準となるURI（Uniform Resource Identifier）を返します。
9 * これは、ドキュメント内で相対URIを解決する際の基準となります。
10 */
11function demonstrateDomAttrBaseURI(): void
12{
13    // xml:base 属性を含むXML文字列を定義します。
14    // ここで定義された "http://example.com/data/" が、この要素とその子孫のベースURIとなります。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<root xml:base="http://example.com/data/">
18    <item id="item-123"/>
19</root>
20XML;
21
22    // 新しいDOMドキュメントを作成し、XML文字列をロードします。
23    $dom = new DOMDocument();
24    $dom->loadXML($xmlString);
25
26    // ドキュメントから 'item' 要素を取得します。
27    $itemElement = $dom->getElementsByTagName('item')->item(0);
28
29    if ($itemElement === null) {
30        echo "エラー: 'item' 要素が見つかりませんでした。" . PHP_EOL;
31        return;
32    }
33
34    // 'item' 要素から 'id' 属性を取得します。getAttributeNode() メソッドは DOMAttr オブジェクトを返します。
35    $idAttribute = $itemElement->getAttributeNode('id');
36
37    if ($idAttribute === null) {
38        echo "エラー: 'id' 属性が見つかりませんでした。" . PHP_EOL;
39        return;
40    }
41
42    echo "--- DOMAttr::baseURI のデモンストレーション ---" . PHP_EOL;
43
44    echo "取得した属性名: " . $idAttribute->name . PHP_EOL;
45    echo "取得した属性値: " . $idAttribute->value . PHP_EOL;
46
47    // DOMAttr::baseURI プロパティにアクセスし、その値を出力します。
48    // これは、属性が属する要素のベースURI（ここでは 'http://example.com/data/'）を返します。
49    $baseURI = $idAttribute->baseURI;
50
51    echo "属性の baseURI: " . ($baseURI ?? 'N/A (null)') . PHP_EOL;
52}
53
54// 上記のデモンストレーション関数を実行します。
55demonstrateDomAttrBaseURI();

DOMAttr::baseURIプロパティは、PHPのDOM（Document Object Model）拡張機能において、XMLドキュメント内の属性が定義されている要素の基準となるURI（ベースURI）を取得するために使用されます。このプロパティはDOMAttrクラスのインスタンス、つまりXML要素の個々の属性を表すオブジェクトからアクセスできます。

サンプルコードでは、xml:base属性によってベースURIが明示的に設定されたXML文字列を読み込み、DOMDocumentを作成しています。その後、特定の要素からid属性をDOMAttrオブジェクトとして取得し、そのDOMAttrオブジェクトのbaseURIプロパティを参照しています。このbaseURIは、属性そのもののURIではなく、属性が所属する要素、あるいはその親要素に定義された基準URIを返します。例えば、xml:base="http://example.com/data/"が指定されていれば、それがベースURIとして取得されます。

このプロパティは引数を持ちません。戻り値は基準URIを示す文字列、または基準URIが利用できない場合にnullとなります。XMLドキュメント内で相対URIを解決する際の基準点を知るために活用され、ドキュメントの構造や外部リソースへの参照を正確に解釈する際に重要な役割を果たします。