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

Copy
1<?php
2
3/**
4 * Dom\Notation クラスの baseURI プロパティの使用例を示します。
5 *
6 * baseURI プロパティは、ノードの基底 URI (Uniform Resource Identifier) を返します。
7 * これは、相対 URI を絶対 URI に解決するための基準となる URI です。
8 *
9 * XML ファイルからドキュメントを読み込んだ場合、通常はそのファイルのパスが baseURI となります。
10 * 文字列からドキュメントを読み込んだ場合など、基底 URI が存在しない場合は空文字列を返します。
11 *
12 * @return string Dom\Notation の baseURI、またはエラーメッセージ
13 */
14function getDomNotationBaseUri(): string
15{
16    // XML ドキュメントを文字列として定義します。
17    // このドキュメントには、DOCTYPE 宣言内に NOTATION (記法) が含まれています。
18    $xmlString = <<<XML
19<?xml version="1.0" encoding="UTF-8"?>
20<!DOCTYPE root [
21  <!-- 
22    "image/gif" というシステム識別子を持つ "gif" というNOTATIONを定義しています。
23    この "image/gif" は、このNOTATIONが指す外部リソースの種類や場所を示すことがあります。
24  -->
25  <!NOTATION gif SYSTEM "image/gif">
26  <!ELEMENT root EMPTY>
27]>
28<root/>
29XML;
30
31    // 新しい Dom\Document オブジェクトを作成します。
32    $dom = new Dom\Document();
33    
34    // 定義した XML 文字列をロードします。
35    // 文字列からロードする場合、通常 baseURI は空文字列になります。
36    $dom->loadXML($xmlString);
37
38    // ドキュメントの DOMDocumentType オブジェクトを取得します。
39    // これは XML の DOCTYPE 宣言全体を表します。
40    $docType = $dom->doctype;
41
42    if ($docType === null) {
43        return "Error: DOCTYPE not found in the XML document.";
44    }
45
46    // ドキュメントタイプから NOTATION コレクションを取得します。
47    // Dom\DocumentType::notations は Dom\NamedNodeMap (Dom\NodeList と同様に扱える) を返します。
48    $notations = $docType->notations;
49
50    // 最初の NOTATION ノードを取得します。
51    // 上記の XML_STRING の例では、"gif" という NOTATION が一つだけ存在します。
52    $notation = $notations->item(0);
53
54    // 取得したノードが Dom\Notation のインスタンスであることを確認します。
55    if ($notation instanceof Dom\Notation) {
56        // Dom\Notation オブジェクトの baseURI プロパティにアクセスし、その値を返します。
57        return $notation->baseURI;
58    } else {
59        return "Error: No Dom\\Notation instance found.";
60    }
61}
62
63// 関数を実行し、結果を出力します。
64$baseUri = getDomNotationBaseUri();
65echo "Dom\\Notation の baseURI: " . $baseUri . PHP_EOL;
66
67// baseURI が空文字列の場合、初心者向けに補足説明を表示します。
68if ($baseUri === '') {
69    echo "（補足：この例ではXMLが文字列からロードされたため、baseURIは空文字列です。\n";
70    echo "       もしファイルからXMLをロードした場合は、そのファイルの絶対パスが設定されます。）" . PHP_EOL;
71}
72

PHP 8のDom\Notation::baseURIプロパティは、XMLドキュメント内の「NOTATION」（特定のデータ形式や外部リソースを示す記法）ノードの基底URIを文字列として返します。このプロパティは引数を取らず、XML文書内で使用される相対パスなどを絶対パスに解決するための基準となるURIを提供します。戻り値は常に文字列型です。

このサンプルコードでは、XML文字列内に定義されたNOTATIONをDom\Documentクラスで解析し、Dom\DocumentTypeからそのNOTATIONノードを取得しています。そして、取得したDom\NotationオブジェクトのbaseURIプロパティにアクセスし、その値を出力します。

XMLドキュメントをPHPスクリプト内の文字列からロードした場合、基底URIは通常空文字列（''）となります。これは、URIとして参照できる元のファイルが存在しないためです。一方で、XMLファイルを直接読み込んだ場合、baseURIプロパティにはそのファイルの絶対パスが設定されます。これにより、NOTATIONで指定された外部リソースへの相対パスが、この基底URIを基準にして正確な絶対パスとして解決できるようになります。

Copy
1<?php
2
3/**
4 * Dom\Notation クラスの baseURI プロパティの取得例を示します。
5 *
6 * このプロパティは、XML ドキュメントの DTD で定義された Notation (表記法) の
7 * ベース URI を返します。通常、Notation が定義されているドキュメントのファイルパスや URL になります。
8 */
9function getNotationBaseUriExample(): string|false
10{
11    // DTD で NOTATION (表記法) を含むシンプルな XML を定義します。
12    // Dom\Notation は、XML の DTD で定義される特殊な要素です。
13    // この例では 'gif' という名前の Notation を定義しています。
14    $xmlContent = <<<XML
15    <!DOCTYPE root [
16        <!NOTATION gif SYSTEM "image/gif">
17    ]>
18    <root/>
19    XML;
20
21    // 単体で動作し、baseURI がファイルパスであることを明確に示すため、一時的なXMLファイルを作成します。
22    $tempXmlFile = tempnam(sys_get_temp_dir(), 'notation_example_') . '.xml';
23    if ($tempXmlFile === false) {
24        echo "エラー: 一時ファイルの作成に失敗しました。\n";
25        return false;
26    }
27
28    // XMLコンテンツを一時ファイルに書き込みます。
29    if (file_put_contents($tempXmlFile, $xmlContent) === false) {
30        echo "エラー: 一時ファイル '{$tempXmlFile}' への書き込みに失敗しました。\n";
31        unlink($tempXmlFile); // 失敗した場合でもファイルを削除
32        return false;
33    }
34
35    $dom = new DOMDocument();
36    // 一時ファイルからXMLをロードし、DTDのロードを有効にします。
37    // これにより、Dom\Notation オブジェクトが生成され、その baseURI プロパティに
38    // ロード元のファイルパスが設定されます。
39    if (!$dom->load($tempXmlFile, LIBXML_DTDLOAD)) {
40        echo "エラー: XMLファイル '{$tempXmlFile}' のロードに失敗しました。\n";
41        unlink($tempXmlFile); // 失敗した場合でもファイルを削除
42        return false;
43    }
44
45    // XMLロード後、一時ファイルは不要なため削除します。
46    // Notationオブジェクトはメモリ上に存在するため、ファイルの削除は問題ありません。
47    unlink($tempXmlFile);
48
49    // DOMDocument オブジェクトの notations プロパティから Dom\Notation オブジェクトを取得します。
50    // notations は Dom\NamedNodeMap オブジェクトであり、Notation のコレクションを含みます。
51    if ($dom->notations && $dom->notations->length > 0) {
52        /** @var Dom\Notation $notation */
53        // 最初に見つかった Notation オブジェクトを取得します。
54        $notation = $dom->notations->item(0);
55
56        // baseURI プロパティは、この Notation が属するドキュメントのベース URI を返します。
57        // この例では、一時的に作成したXMLファイルの完全なパスが返されます。
58        return $notation->baseURI;
59    }
60
61    echo "エラー: XMLに Dom\\Notation が見つかりませんでした。\n";
62    return false;
63}
64
65// 関数の実行と結果の表示
66$baseUri = getNotationBaseUriExample();
67
68if ($baseUri !== false) {
69    echo "Dom\\Notation の baseURI: {$baseUri}\n";
70    echo "これは、Notation が定義されている XML ドキュメントのファイルパスを示します。\n";
71} else {
72    echo "Dom\\Notation の baseURI の取得に失敗しました。\n";
73}

Dom\Notation::baseURIプロパティは、PHP 8のDOM拡張機能に属し、XMLドキュメントのDTD（Document Type Definition）で定義される「Notation（表記法）」が属するベースURIを文字列として取得します。このベースURIは、通常、そのNotationが定義されているXMLドキュメントのファイルパスやURLを指します。

このプロパティには引数はなく、戻り値は常に文字列型です。Notationがどのドキュメントに由来するかを示す役割があります。

提供されたサンプルコードでは、NOTATION要素を含むシンプルなXMLコンテンツを定義し、それを一時的なXMLファイルとして保存しています。この一時ファイルをDOMDocumentクラスのloadメソッドで読み込む際に、LIBXML_DTDLOADオプションを指定してDTDをロードすることが重要です。このオプションにより、XML内で定義されたNOTATIONがDom\Notationオブジェクトとして正しく認識されます。

XMLのロード後、DOMDocumentオブジェクトのnotationsプロパティ（これはDom\NamedNodeMapのインスタンスです）を通じて、ロードされたDom\Notationオブジェクトのコレクションから最初のNotationを取得します。この取得したDom\Notationオブジェクトに対してbaseURIプロパティにアクセスすると、一時的に作成したXMLファイルの完全なパスが文字列として返されます。これにより、XMLドキュメント内で定義されたNotationが、どのリソースから読み込まれたか（そのベースURIは何か）をプログラム的に確認できます。