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

Copy
1<?php
2
3/**
4 * Dom\EntityReference クラスの baseURI プロパティの利用例を示します。
5 *
6 * Dom\EntityReference は、XML の DTD (Document Type Definition) 内で定義される
7 * エンティティそのものを表すオブジェクトです。
8 * baseURI プロパティは、そのエンティティが定義されているベースURI（場所）を返します。
9 * 外部エンティティの場合、通常は SYSTEM ID で指定されたURIが返されます。
10 * 内部エンティティの場合、通常はドキュメント自体のベースURIか null となります。
11 *
12 * この関数は単体で動作し、Dom\Document オブジェクトを作成してXMLをロードし、
13 * 定義されたエンティティの baseURI を出力します。
14 */
15function demonstrateDomEntityReferenceBaseURI(): void
16{
17    // PHP 8 の Dom\Document クラスを使用
18    $dom = new Dom\Document();
19
20    // DTD (Document Type Definition) でエンティティを定義したXML文字列を準備
21    // ここでは、内部エンティティと外部エンティティの定義を含めます。
22    $xmlString = <<<'XML'
23<?xml version="1.0"?>
24<!DOCTYPE root [
25  <!ENTITY internalEntity "これは内部エンティティの内容です。">
26  <!ENTITY externalEntity SYSTEM "http://example.com/external-entity.txt">
27]>
28<root>
29  <item>参照: &internalEntity;</item>
30  <item>参照: &externalEntity;</item>
31</root>
32XML;
33
34    // XMLをロードします。@ を使用してエラー出力を抑制していますが、
35    // 本番環境では適切なエラーハンドリングを実装すべきです。
36    if (!@$dom->loadXML($xmlString)) {
37        echo "エラー: XMLのロードに失敗しました。\n";
38        return;
39    }
40
41    echo "XMLドキュメントが正常にロードされました。\n\n";
42
43    // ドキュメントタイプ (DOCTYPE) を取得
44    // DTDが定義されている場合、Dom\Document::doctype プロパティから Dom\DocumentType オブジェクトが得られます。
45    $doctype = $dom->doctype;
46
47    if ($doctype) {
48        echo "DOCTYPEが検出されました。\n";
49        echo "  名前: " . $doctype->name . "\n\n";
50
51        // DOCTYPEに定義されているエンティティのリストをループ処理します。
52        // Dom\DocumentType::entities は Dom\NamedNodeMap を返し、
53        // その各要素は Dom\EntityReference のインスタンスとなります。
54        echo "DOCTYPEで定義されたエンティティの一覧:\n";
55        foreach ($doctype->entities as $entityName => $entityNode) {
56            // $entityNode が Dom\EntityReference のインスタンスであることを確認
57            if ($entityNode instanceof Dom\EntityReference) {
58                echo "  エンティティ名: " . $entityName . "\n";
59                // baseURI プロパティは、エンティティの定義元のURIを返します。
60                // 戻り値は ?string (null許容文字列) なので、null の場合は 'N/A' と表示します。
61                echo "    baseURI: " . ($entityNode->baseURI ?? 'N/A') . "\n";
62                echo "    System ID: " . ($entityNode->systemId ?? 'N/A') . "\n";
63                echo "\n";
64            }
65        }
66    } else {
67        echo "XMLドキュメントに DOCTYPE が見つかりませんでした。\n";
68    }
69}
70
71// 関数を実行してサンプルコードの動作を示します
72demonstrateDomEntityReferenceBaseURI();

PHP 8のDom\EntityReferenceクラスのbaseURIプロパティは、XMLエンティティが定義されているベースURI（場所）を文字列またはnullで返すプロパティです。Dom\EntityReferenceは、XMLドキュメントのDTD（Document Type Definition）で定義されるエンティティを扱うオブジェクトです。

このプロパティは、外部エンティティの場合にはDTD内のSYSTEM IDで指定されたURIを返します。内部エンティティの場合には、通常、そのXMLドキュメント自体のベースURIかnullが戻り値となります。プロパティであるため引数は取りません。

サンプルコードは、DTDで内部エンティティと外部エンティティが定義されたXML文字列をDom\Documentにロードする例です。その後、ロードしたドキュメントからDTDに定義された各エンティティを取得し、それぞれのDom\EntityReferenceインスタンスのbaseURIプロパティの値を出力しています。baseURIがnullを返す可能性も考慮し、その場合は「N/A」と表示する処理が含まれており、初心者の方にも安全な値の取り扱い方が理解できるように示しています。この例を通じて、XMLドキュメントに定義されたエンティティの定義元URIをプログラムから取得する基本的な方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * Dom\EntityReference ノードの基底URI (baseURI) を取得するサンプルコードです。
5 *
6 * このサンプルは、PHPのDOM拡張機能における Dom\EntityReference クラスの
7 * baseURI プロパティの使用方法を示しています。
8 *
9 * システムエンジニアを目指す初心者の方へ:
10 * 一般的に「WebサイトのベースURLを取得する」という場合、
11 * $_SERVER['REQUEST_SCHEME'] や $_SERVER['HTTP_HOST'] といったスーパーグローバル変数を使って
12 * アプリケーションのルートURLを構築することが多いです。
13 *
14 * しかし、この Dom\EntityReference::baseURI は、XML/HTML ドキュメント内部で
15 * エンティティ参照が定義されている、または解決されるべき基底URIを指し、
16 * WebアプリケーションのベースURLとは異なる文脈で使われる点にご注意ください。
17 */
18function getDomEntityReferenceBaseURIExample(): void
19{
20    // 新しいDom\Documentオブジェクトを作成します。
21    // エンティティ参照ノードは、このドキュメントに属することになります。
22    $document = new Dom\Document('1.0', 'UTF-8');
23
24    // Dom\EntityReference オブジェクトは、直接 new キーワードでインスタンス化できません。
25    // Dom\Document::createEntityReference() メソッドを使用して作成します。
26    // ここでは「myEntity」という名前のエンティティ参照ノードを作成します。
27    $entityReference = $document->createEntityReference('myEntity');
28
29    // Dom\EntityReference オブジェクトの baseURI プロパティにアクセスします。
30    // このノードはまだドキュメントツリーに追加されておらず、
31    // かつドキュメント自体がファイルからロードされていないため、
32    // baseURI は通常 nullまたは空文字列を返します。これは正常な動作です。
33    $baseURI = $entityReference->baseURI;
34
35    echo "Dom\\EntityReference ノードの baseURI: " . ($baseURI ?? 'null (未設定)') . "\n";
36
37    // 補足: もし Dom\Document が特定のファイル（例: 'document.xml'）からロードされた場合、
38    // そのドキュメントに属するノードの baseURI は、そのファイルのパスを示すことがあります。
39    // ただし、createEntityReference() で作成したノードの場合、ドキュメントのURIがそのまま適用されます。
40}
41
42// 上記で定義したサンプル関数を実行します。
43getDomEntityReferenceBaseURIExample();

このPHPサンプルコードは、DOM拡張機能におけるDom\EntityReferenceクラスのbaseURIプロパティの使い方を解説しています。このプロパティは、XMLやHTMLドキュメント内で定義されたエンティティ参照ノードが、どの基底URIに基づいて解決されるべきかを示すために使用されます。

Dom\EntityReferenceノードは、直接newキーワードでインスタンス化することはできず、Dom\DocumentクラスのcreateEntityReference()メソッドを通じて生成されます。サンプルコードでは、まずDom\Documentオブジェクトを作成し、その上で「myEntity」という名前のエンティティ参照ノードを生成しています。

baseURIプロパティにアクセスすることで、そのエンティティ参照ノードが属する、または解決されるべき基底URIを取得できます。このプロパティの戻り値は?string型であり、文字列またはnullが返されます。生成されたばかりでまだドキュメントツリーに追加されていないノードや、ファイルからロードされていないドキュメント内のノードの場合、baseURIは通常nullまたは空文字列を返しますが、これは期待される挙動です。

システムエンジニアを目指す初心者の方へ。このDom\EntityReference::baseURIは、PHPアプリケーションのベースURLを取得するためによく使われる$_SERVERスーパーグローバル変数とは文脈が異なります。これは、Webアプリケーション全体のベースURLではなく、XML/HTMLドキュメント内部のエンティティ解決における基底URIを指す点にご注意ください。