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

Copy
1<?php
2
3/**
4 * DOMEntityのbaseURIプロパティの使用例
5 *
6 * この関数は、XML文字列からDOMDocumentを作成し、
7 * ドキュメントタイプ定義 (DTD) に含まれるエンティティのbaseURIを取得します。
8 * 内部DTDエンティティの場合、baseURIは通常、ドキュメントを読み込んだ際のURI
9 * (例: ファイルパス) となるか、この例のようにloadXML()で直接文字列を
10 * 読み込んだ場合は空文字列となります。
11 */
12function demonstrateDomEntityBaseUri(): void
13{
14    // XML文字列を定義。内部DTDにエンティティを定義しています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<!DOCTYPE root [
18  <!ENTITY myEntity "これは内部エンティティのテキストです。">
19]>
20<root>
21  <item>&myEntity;</item>
22</root>
23XML;
24
25    // DOMDocumentオブジェクトを作成
26    $dom = new DOMDocument();
27    
28    // XMLを読み込みます。
29    // loadXML() はXML文字列からドキュメントを解析します。
30    // エラーが発生する可能性を考慮し、通常は適切なエラーハンドリングが必要です。
31    // ここではサンプルコードの簡潔さのため、エラー抑制演算子を使用しています。
32    @$dom->loadXML($xmlString);
33
34    // ドキュメントタイプ (DOCTYPE) ノードを取得
35    $doctype = $dom->doctype;
36
37    if ($doctype) {
38        // ドキュメントタイプのエンティティマップを取得
39        // これはDTDで定義されたすべてのエンティティを含む DOMNamedNodeMap です。
40        $entities = $doctype->entities;
41
42        // "myEntity" という名前のエンティティを検索
43        $myEntity = $entities->getNamedItem('myEntity');
44
45        if ($myEntity instanceof DOMEntity) {
46            // DOMEntityのbaseURIプロパティを取得して表示します。
47            // baseURIは、ノードがどこからロードされたかを示すURIです。
48            // この例ではloadXML()で文字列を直接読み込んでいるため、通常は空文字列になります。
49            // もし load() メソッドでファイルから読み込んだ場合、そのファイルのURIが返されます。
50            echo "エンティティ 'myEntity' の baseURI: " . ($myEntity->baseURI ?: "(空文字列)") . "\n";
51        } else {
52            echo "エラー: エンティティ 'myEntity' が見つかりませんでした。\n";
53        }
54    } else {
55        echo "エラー: DTD (DOCTYPE) がXMLドキュメントに定義されていません。\n";
56    }
57}
58
59// 定義した関数を実行して、DOMEntity::baseURIの動作を確認します。
60demonstrateDomEntityBaseUri();

PHPのDOMEntity::baseURIプロパティは、XMLドキュメント内で定義されたエンティティが「どこから読み込まれたか」を示すURI（Uniform Resource Identifier）を文字列として取得します。このプロパティは引数を必要とせず、常に文字列を返します。

サンプルコードでは、DOMDocumentクラスを用いてXML文字列を読み込み、その内部で定義されたエンティティのbaseURIプロパティを取得する具体的な方法を示しています。特に、DOMDocument::loadXML()メソッドでXML文字列を直接読み込んだ場合、エンティティのbaseURIは通常、空文字列となります。これは、ドキュメントがファイルからではなく、メモリ上の文字列から生成されたためです。もしDOMDocument::load()メソッドでXMLファイルを読み込んだ場合には、そのファイルのパスがbaseURIとして返されることもあります。このプロパティは、XML文書の外部リソースとの関連性を確認する際に役立つ情報を提供します。

Copy
1<?php
2
3/**
4 * PHPのDOM拡張機能を使用し、XMLドキュメント内のDOMEntity::baseURIプロパティにアクセスするサンプルコードです。
5 * DOMEntity::baseURIは、エンティティが宣言された場所のベースURIを返します。
6 * XMLドキュメント内部で宣言されたエンティティの場合、このプロパティは通常空文字列またはnullになります。
7 */
8
9// XML ドキュメントの文字列を定義します。
10// 内部DTDで 'greeting' という名前のエンティティを宣言しています。
11$xmlString = <<<XML
12<?xml version="1.0" encoding="UTF-8"?>
13<!DOCTYPE document [
14  <!ENTITY greeting "Hello, World!">
15]>
16<document>
17  <message>&greeting;</message>
18</document>
19XML;
20
21// DOMDocument オブジェクトを作成します。
22$dom = new DOMDocument();
23
24// XML 文字列をロードします。
25// ロードに失敗した場合にfalseを返すため、チェックすることが推奨されます。
26if (!$dom->loadXML($xmlString)) {
27    echo "XMLのロードに失敗しました。\n";
28    exit(1);
29}
30
31// ドキュメントタイプ定義 (DTD) を取得します。
32$doctype = $dom->doctype;
33
34// DTDが存在し、かつエンティティが定義されていることを確認します。
35if ($doctype instanceof DOMDocumentType && $doctype->entities->length > 0) {
36    // 'greeting' エンティティを名前で取得します。
37    $entity = $doctype->entities->getNamedItem('greeting');
38
39    if ($entity instanceof DOMEntity) {
40        // DOMEntity::baseURI プロパティの値を取得します。
41        // この例のようにXML文字列からロードされた内部エンティティの場合、
42        // baseURIは通常、空文字列またはnullになります。
43        $baseURI = $entity->baseURI;
44
45        echo "エンティティ 'greeting' の baseURI: ";
46        if ($baseURI === null || $baseURI === '') {
47            echo "(空文字列または null)";
48        } else {
49            echo $baseURI;
50        }
51        echo "\n";
52    } else {
53        echo "指定されたエンティティ 'greeting' が見つかりませんでした。\n";
54    }
55} else {
56    echo "XMLドキュメントにDTDまたはエンティティが定義されていません。\n";
57}
58
59?>

このサンプルコードは、PHPのDOM拡張機能を使用してXMLドキュメント内のエンティティ情報にアクセスする方法を示しています。特に、DOMEntityクラスのbaseURIプロパティに焦点を当て、その役割と値の取得方法を説明します。

DOMEntity::baseURIは、エンティティが宣言された場所の基となるURI（Uniform Resource Identifier）を文字列として返します。このプロパティに引数はなく、直接アクセスして値を取得します。

サンプルコードでは、XML文字列内部にgreetingというエンティティを定義し、それをDOMDocumentにロードします。その後、ドキュメントタイプ定義（DTD）からgreetingエンティティを取得し、そのDOMEntityオブジェクトのbaseURIプロパティの値を出力しています。

この例のように、XMLドキュメント内部で直接定義されたエンティティの場合、baseURIプロパティは通常、空文字列またはnullを返します。これは、外部ファイルを参照するわけではないため、特定のベースURIが存在しないことを意味します。baseURIプロパティは、外部DTDファイルや外部エンティティを参照する際に、その参照元URIを確認するために役立ちます。