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

Copy
1<?php
2
3/**
4 * DOMNotation クラスの baseURI プロパティの使用例を示します。
5 *
6 * DOMNotation は、XML の DTD (Document Type Definition) で定義される記法を表すノードです。
7 * baseURI プロパティは、そのノードが属するドキュメントのベースURI (基底URI) を返します。
8 * 通常、メモリ内で作成されたXMLノードの場合、baseURIは空文字列となりますが、
9 * ファイルからXMLを読み込んだ場合は、そのファイルのパスが返されることがあります。
10 */
11function demonstrateDomNotationBaseURI(): void
12{
13    // DOMDocument オブジェクトを作成します。
14    $dom = new DOMDocument();
15
16    // NOTATION (記法) を含むXML文字列を読み込みます。
17    // ここでは "gif" という名前のNOTATIONを定義しています。
18    $xmlString = <<<XML
19<!DOCTYPE root [
20    <!NOTATION gif SYSTEM "image/gif">
21    <!ELEMENT root EMPTY>
22]>
23<root/>
24XML;
25
26    // XML文字列をDOMDocumentに読み込みます。
27    $dom->loadXML($xmlString);
28
29    // ドキュメントの DOCTYPE (Document Type Definition) を取得します。
30    $docType = $dom->doctype;
31
32    if ($docType !== null) {
33        // DOCTYPE から NOTATION のリスト (DOMNamedNodeMap) を取得します。
34        // NOTATIONはDTD内で定義された記法の集合です。
35        $notations = $docType->notations;
36
37        if ($notations !== null && $notations->length > 0) {
38            // "gif" という名前の DOMNotation オブジェクトを取得します。
39            $notation = $notations->getNamedItem('gif');
40
41            if ($notation instanceof DOMNotation) {
42                // DOMNotation オブジェクトの baseURI プロパティを取得します。
43                $baseUri = $notation->baseURI;
44
45                // baseURI の値を出力します。
46                // メモリ上のXMLのため、通常は空文字列になります。
47                echo "DOMNotation 'gif' の baseURI: " . ($baseUri === '' ? '[空文字列 (メモリ内XMLのため)]' : $baseUri) . "\n";
48            } else {
49                echo "指定された DOMNotation 'gif' が見つかりませんでした。\n";
50            }
51        } else {
52            echo "DOCTYPE に NOTATION が定義されていません。\n";
53        }
54    } else {
55        echo "XML ドキュメントに DOCTYPE が見つかりませんでした。\n";
56    }
57}
58
59// 関数を実行して、baseURI の値を確認します。
60demonstrateDomNotationBaseURI();
61

PHP 8のDOMNotationクラスには、XMLドキュメントのDTD（Document Type Definition）で定義される「記法」（NOTATION）に関する情報を提供するプロパティが用意されています。その一つがbaseURIプロパティです。

DOMNotation::baseURIプロパティは、特定のDOMNotationノードが属するドキュメントの「基底URI」（Base URI）を文字列として返します。このプロパティに引数はありません。基底URIとは、関連する他のURIの解決の基準となるURIのことです。

サンプルコードでは、まずDOMDocumentを作成し、NOTATION gif SYSTEM "image/gif"という記法を含むXMLをメモリ上に読み込んでいます。その後、$dom->doctypeからDOMNamedNodeMapであるnotationsを取得し、getNamedItem('gif')で特定のDOMNotationオブジェクト（$notation）を取り出しています。

この$notationオブジェクトから$notation->baseURIにアクセスすることで、基底URIの値を取得できます。メモリ上で作成されたXMLドキュメントの場合、baseURIは通常、空文字列を返します。これは、そのXMLデータが特定のファイルパスに関連付けられていないためです。もしXMLがファイルから読み込まれた場合は、そのファイルのパスが基底URIとして返されることがあります。このプロパティを通じて、XMLドキュメントの構造情報と、そのデータの出自に関する手がかりを得ることができます。

Copy
1<?php
2
3/**
4 * DOMNotationのbaseURIプロパティの使用例
5 *
6 * この関数は、XMLのDTD (Document Type Definition) 内で定義される
7 * DOMNotationオブジェクトからbaseURIプロパティの値を取得する方法を示します。
8 *
9 * baseURIは、XMLノードの相対URIを解決するための基準となるURIですが、
10 * DOMNotationはXML文書の構造定義の一部であるため、
11 * このプロパティは通常、そのNOTATIONが読み込まれたXML文書自体のURI、
12 * またはメモリ上で生成された場合は空文字列を返します。
13 *
14 * システムエンジニアを目指す初心者にも理解しやすいよう、正確かつ簡潔なコードを提供します。
15 */
16function demonstrateDomNotationBaseURI(): void
17{
18    // 1. 新しいDOMDocumentオブジェクトを作成します。
19    $dom = new DOMDocument();
20
21    // 2. DTDにNOTATIONが定義されたXML文字列を準備します。
22    //    NOTATIONは <!NOTATION name SYSTEM "uri"> の形式で宣言されます。
23    //    'SYSTEM "uri"' の部分は関連する外部リソースの場所を示すことができますが、
24    //    DOMNotation::baseURIがこの"uri"を直接返すわけではありません。
25    $xmlString = <<<XML
26<?xml version="1.0" encoding="UTF-8"?>
27<!DOCTYPE document [
28  <!NOTATION myIcon SYSTEM "images/icon.png">
29  <!NOTATION myViewer SYSTEM "http://example.com/viewer-app">
30]>
31<document>
32  <data>XML DTD notation example.</data>
33</document>
34XML;
35
36    // 3. XML文字列をDOMDocumentにロードします。
37    //    ロードが失敗した場合に備えてチェックします。
38    if (!$dom->loadXML($xmlString)) {
39        echo "エラー: XMLのロードに失敗しました。\n";
40        return;
41    }
42
43    echo "DOMNotation::baseURI プロパティの取得例:\n\n";
44
45    // 4. ドキュメントのDTD情報を取得します。
46    //    DOMDocumentTypeオブジェクトはDTDに関する情報を提供します。
47    //    DTDが存在しない場合はnullを返します。
48    $doctype = $dom->doctype;
49
50    if ($doctype === null) {
51        echo "このXMLドキュメントにはDTDがありません。\n";
52        return;
53    }
54
55    // 5. DTDに定義されているNOTATIONのリストを取得します。
56    //    $doctype->notations は DOMNamedNodeMap オブジェクトであり、
57    //    その中にDOMNotationオブジェクトが含まれています。
58    $notations = $doctype->notations;
59
60    if ($notations === null || $notations->length === 0) {
61        echo "DTD内にNOTATIONが定義されていません。\n";
62        return;
63    }
64
65    // 6. 各NOTATIONオブジェクトをループし、baseURIプロパティの値を表示します。
66    foreach ($notations as $notation) {
67        // $notationがDOMNotationのインスタンスであることを確認します。
68        if ($notation instanceof DOMNotation) {
69            echo "----------------------------------------\n";
70            echo "NOTATION名 (nodeName): " . $notation->nodeName . "\n";
71            echo "SYSTEM ID: " . $notation->systemId . "\n";
72            echo "PUBLIC ID: " . ($notation->publicId ?? 'なし') . "\n";
73            echo "baseURI: '" . $notation->baseURI . "'\n"; // ここでDOMNotation::baseURIを取得
74
75            // メモリ上のXMLをロードした場合のbaseURIに関する補足説明
76            echo "  (補足: この例ではメモリ上のXML文字列からロードしているため、\n";
77            echo "         baseURIは通常、空文字列になります。もしファイルからXMLをロードした場合は、\n";
78            echo "         そのファイルのパスがbaseURIとして返されることがあります。)\n";
79        }
80    }
81    echo "----------------------------------------\n";
82}
83
84// サンプル関数を実行して、DOMNotation::baseURIプロパティの動作を確認します。
85demonstrateDomNotationBaseURI();

PHP 8のDOMNotationクラスに属するbaseURIプロパティは、XMLノードの相対URIを解決するための基準となるURIを文字列として返します。このプロパティは引数を取りません。DOMNotationはXML文書の構造を定義するDTD（Document Type Definition）の一部で、外部のデータ形式などを宣言する際に利用されます。baseURIは、XMLが読み込まれた場所のURIを示し、相対パスの解決に役立ちます。例えば、XMLファイルから読み込まれた場合はそのファイルのURIを返しますが、メモリ上の文字列から読み込まれた場合は、通常空文字列を返します。

サンプルコードでは、DTDに定義されたDOMNotationオブジェクトからbaseURIプロパティの値を取得する具体的な方法を示しています。まず、DOMDocumentにXMLをロードし、ドキュメントのDTD情報からNOTATIONのリストを取得します。その後、各DOMNotationオブジェクトのbaseURIを表示することで、プロパティの挙動を確認できます。このプロパティは、XML文書内で参照される外部リソースの基準URIを把握したい場合に活用できます。