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

Copy
1<?php
2
3/**
4 * Dom\CDATASection::baseURI プロパティの動作をデモンストレーションします。
5 *
6 * このプロパティは、CDATAセクションが属するドキュメントのベースURI（Uniform Resource Identifier）を返します。
7 * 一般的に、XMLドキュメントがファイルからロードされた場合、baseURI にはそのファイルのパスが設定されます。
8 * ドキュメントがメモリ上で動的に作成された場合、baseURI は通常 null となります。
9 *
10 * @return void
11 */
12function demonstrateCDATASectionBaseURI(): void
13{
14    // 1. 新しいDOMドキュメントを作成します。
15    // メモリ上でドキュメントを作成する場合、Dom\Document::baseURI (そしてそれに続く Dom\CDATASection::baseURI) は
16    // 通常は設定されず、null となります。
17    $dom = new Dom\Document('1.0', 'UTF-8');
18
19    // ルート要素を作成し、ドキュメントに追加します。
20    $root = $dom->createElement('exampleRoot');
21    $dom->appendChild($root);
22
23    // CDATAセクションの内容を定義します。
24    $cdataContent = 'これはCDATAセクションの内容です。<tag>HTMLタグ</tag>のようなマークアップもエスケープされずに保持されます。';
25
26    // CDATAセクションノードを作成し、ルート要素に追加します。
27    $cdataSection = $dom->createCDATASection($cdataContent);
28    $root->appendChild($cdataSection);
29
30    echo "--- Dom\\CDATASection::baseURI プロパティのデモンストレーション ---\n\n";
31
32    // 2. 作成した Dom\CDATASection オブジェクトから baseURI プロパティにアクセスします。
33    $baseURI = $cdataSection->baseURI;
34
35    echo "作成された Dom\\CDATASection の baseURI: ";
36    if ($baseURI !== null) {
37        // baseURI が設定されている場合
38        echo $baseURI . "\n";
39    } else {
40        // baseURI が null の場合
41        echo "null\n";
42        echo "(このドキュメントはメモリ上で作成されたため、baseURI は設定されていません。)\n";
43        echo "  補足: もしXMLドキュメントをファイルからロードした場合 (例: \$dom->load('path/to/file.xml');)、\n";
44        echo "  baseURI にはそのファイルのパスが設定されます。\n";
45    }
46    echo "\n";
47
48    // 参考として、ドキュメント自体 (Dom\Document) の baseURI も確認します。
49    // Dom\CDATASection の baseURI は、通常、その親である Dom\Document の baseURI と同じになります。
50    echo "関連する Dom\\Document の baseURI: ";
51    if ($dom->baseURI !== null) {
52        echo $dom->baseURI . "\n";
53    } else {
54        echo "null\n";
55    }
56    echo "\n";
57}
58
59// デモンストレーション関数を実行します。
60demonstrateCDATASectionBaseURI();

PHP 8のDom\CDATASection::baseURIプロパティは、XMLドキュメント内のCDATAセクションが属するドキュメントの基準URI（Uniform Resource Identifier）を取得するために使用されます。このプロパティは引数を取らず、戻り値として文字列（URI）またはnullを返します。

XMLドキュメントがファイルからロードされた場合、baseURIには通常、そのファイルのパスが文字列として設定されます。しかし、サンプルコードのようにドキュメントがPHPのコード内で新しく動的に生成された場合、そのドキュメントにはファイルシステム上の具体的な場所がないため、baseURIプロパティはnullを返します。サンプルコードでは、メモリ上で作成されたCDATAセクションのbaseURIがnullとなることを確認し、その理由について解説しています。

このプロパティは、XMLドキュメント内の相対パスを解決する際や、特定のCDATAセクションがどのドキュメントに由来するのか、そのドキュメントの場所に関する情報を確認する必要がある場合に役立ちます。

Copy
1<?php
2
3use Dom\Document;
4use Dom\CDATASection;
5
6/**
7 * XMLドキュメント内のDom\CDATASectionノードのbaseURIプロパティを取得し、表示する関数。
8 *
9 * baseURIは、そのノードが属するドキュメントの基底URI、またはノードが外部エンティティの
10 * 一部である場合のそのエンティティのURIを示します。
11 * これは、WebアプリケーションのルートURLとは異なる概念です。
12 */
13function demonstrateCdataSectionBaseURI(): void
14{
15    // 一時的なXMLファイルを作成します。
16    // このファイルにはCDATAセクションを含めます。
17    $xmlContent = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<root>
20    <item>データA</item>
21    <message><![CDATA[これは特別な<文字>を含むCDATAセクションです。]]></message>
22    <item>データB</item>
23</root>
24XML;
25
26    // システムの一時ディレクトリに一時ファイルを作成します。
27    $tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'example_cdata.xml';
28    file_put_contents($tempFilePath, $xmlContent);
29
30    try {
31        // Dom\Documentのインスタンスを作成します。
32        $dom = new Document();
33
34        // XMLファイルを読み込みます。
35        // ファイルからロードされたDomノードのbaseURIは、通常そのファイルのURIを継承します。
36        $dom->load($tempFilePath);
37
38        // XMLドキュメントからCDATASectionノードを探します。
39        // CDATAセクションは、通常は要素の子ノードとして存在します。
40        $foundCdataSection = null;
41        $messageElements = $dom->getElementsByTagName('message');
42
43        if ($messageElements->count() > 0) {
44            $messageElement = $messageElements->item(0);
45            foreach ($messageElement->childNodes as $node) {
46                if ($node instanceof CDATASection) {
47                    $foundCdataSection = $node;
48                    break;
49                }
50            }
51        }
52
53        if ($foundCdataSection) {
54            // Dom\CDATASectionノードのbaseURIプロパティにアクセスし、その値を出力します。
55            // nullの場合に備え、null合体演算子 (??) を使用します。
56            echo "Dom\\CDATASection::baseURI: " . ($foundCdataSection->baseURI ?? 'null') . PHP_EOL;
57
58            // 比較のために、ロード元のファイルの絶対パスも表示します。
59            // baseURIは通常、このファイルパスのURI形式（例: file:///...）になります。
60            echo "ロード元ファイル絶対パス: " . realpath($tempFilePath) . PHP_EOL;
61        } else {
62            echo "エラー: Dom\\CDATASectionノードが見つかりませんでした。" . PHP_EOL;
63        }
64
65    } catch (\Throwable $e) {
66        // エラーが発生した場合に、そのメッセージを表示します。
67        echo "処理中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
68    } finally {
69        // 処理の終了後、作成した一時ファイルを削除してクリーンアップします。
70        if (file_exists($tempFilePath)) {
71            unlink($tempFilePath);
72        }
73    }
74}
75
76// 関数を実行します。
77demonstrateCdataSectionBaseURI();

PHPのDom\CDATASection::baseURIは、XMLドキュメント内のCDATAセクションノードが属するドキュメントの基底URI、またはノードが外部エンティティの一部である場合のそのエンティティのURIを取得するプロパティです。このプロパティに引数はなく、戻り値は文字列（string）または、URIが存在しない場合はnullとなります。これはウェブアプリケーションのルートURLとは異なる概念で、XMLノードの相対パス解決の基準となるURIを指します。

サンプルコードでは、まず一時的なXMLファイルを作成し、その中にCDATAセクションを含めます。次にDom\Documentクラスを使用してこのXMLファイルを読み込むことで、ノードのbaseURIはロード元のファイルのURIを継承します。コードはmessage要素内のDom\CDATASectionノードを探し出し、そのbaseURIプロパティの値を出力しています。この出力は、通常、一時ファイルの絶対パスがfile:///形式になったものになります。処理後には作成した一時ファイルを削除し、エラーが発生した際も適切なメッセージを表示するようにしています。このプロパティは、XMLドキュメントの構造や外部リソースの参照をプログラムで扱う際に役立ちます。