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

Copy
1<?php
2
3/**
4 * DOMCdataSection::baseURI プロパティの使用例
5 * このスクリプトは、一時的なXMLファイルを作成し、DOMDocumentでロードします。
6 * その後、ファイル内のCDATAセクションを見つけ、その baseURI プロパティを出力します。
7 * baseURI は、ノードの基となるURI（ファイルパスなど）を示します。
8 */
9function demonstrateDomCdataSectionBaseUri(): void
10{
11    // 1. 一時的なXMLファイルを作成します。
12    // このファイルがDOMDocumentの基準URIとなります。
13    $tempFileName = tempnam(sys_get_temp_dir(), 'xml_cdata_');
14    if ($tempFileName === false) {
15        echo "一時ファイルの作成に失敗しました。\n";
16        return;
17    }
18
19    $xmlContent = <<<XML
20<?xml version="1.0" encoding="UTF-8"?>
21<root>
22    <data><![CDATA[これはCDATAセクションの内容です。特殊文字 < & > もそのまま扱われます。]]></data>
23    <info>追加情報</info>
24</root>
25XML;
26    file_put_contents($tempFileName, $xmlContent);
27
28    echo "一時ファイル名: " . $tempFileName . "\n\n";
29
30    // 2. DOMDocumentを作成し、作成したXMLファイルをロードします。
31    // ファイルからロードすることで、baseURI がファイルパスに設定されます。
32    $dom = new DOMDocument();
33    $dom->load($tempFileName);
34
35    // 3. ドキュメント内で CDATA セクションノードを検索します。
36    $cdataSection = null;
37    $dataElements = $dom->getElementsByTagName('data');
38    if ($dataElements->length > 0) {
39        $dataElement = $dataElements->item(0);
40        foreach ($dataElement->childNodes as $childNode) {
41            // childNode が DOMCdataSection のインスタンスであるか確認します。
42            if ($childNode instanceof DOMCdataSection) {
43                $cdataSection = $childNode;
44                break;
45            }
46        }
47    }
48
49    // 4. CDATA セクションが見つかった場合、その baseURI プロパティを出力します。
50    if ($cdataSection) {
51        echo "CDATAセクションの内容: " . $cdataSection->nodeValue . "\n";
52        echo "CDATAセクションの baseURI: " . $cdataSection->baseURI . "\n";
53        echo "\n補足: baseURIは、このノードが属するドキュメントの基となるURI（この場合はXMLファイルのパス）を示します。\n";
54    } else {
55        echo "CDATAセクションが見つかりませんでした。\n";
56    }
57
58    // 5. 使用した一時ファイルを削除します。
59    unlink($tempFileName);
60}
61
62// 関数を実行してサンプルコードの動作を確認します。
63demonstrateDomCdataSectionBaseUri();
64
65?>

PHP 8のDOMCdataSection::baseURIプロパティは、XMLドキュメント内でCDATAセクションを表すDOMCdataSectionクラスに属しており、そのノードが属するドキュメントの基となるURI（Uniform Resource Identifier）を文字列として取得します。このプロパティは引数を一切取らず、常にstring型でURIの情報を返します。

このサンプルコードは、baseURIプロパティの挙動を具体的に示しています。まず、スクリプトは一時的なXMLファイルを作成し、その中にCDATAセクションを含む簡単なXML構造を定義します。次に、DOMDocumentオブジェクトを作成し、load()メソッドを使ってこの一時XMLファイルをロードします。ファイルからXMLをロードすると、そのファイルパスがドキュメント全体の基となるURIとして内部的に設定されます。

コードはロードされたドキュメントの中からCDATAセクションノードを検索して特定します。そして、特定したDOMCdataSectionオブジェクトのbaseURIプロパティにアクセスし、その値を画面に出力します。この際、出力されるbaseURIは作成した一時XMLファイルの絶対パスとなります。これにより、CDATAセクションの内容がどのURIに由来するのかをプログラムで把握できるようになります。このプロパティは、特に複数のファイルやネットワークリソースからXMLデータが組み合わされるような状況で、各ノードのオリジンを追跡する際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * DOMCdataSection::baseURI プロパティの使用例を示します。
5 *
6 * この関数は、XML ドキュメントをメモリ上にロードし、その中から CDATA セクションを探し、
7 * その CDATA セクションが属するドキュメントのベース URI を取得して表示します。
8 *
9 * DOMCdataSection の baseURI プロパティは、そのノードが属するドキュメントが
10 * ロードされた元の場所 (URI) を返します。
11 * これは、ウェブアプリケーションで一般的に使われる「現在のページのベースURL」とは
12 * 異なる概念であることに注意してください。
13 *
14 * @return void
15 */
16function demonstrateDomCdataSectionBaseUri(): void
17{
18    // DOMDocument オブジェクトを初期化します。
19    $dom = new DOMDocument();
20
21    // CDATA セクションを含むXML文字列を定義します。
22    // このXMLはメモリからロードされるため、baseURI は通常空文字列になります。
23    // もしXMLファイルからロードした場合 (例: $dom->load('path/to/document.xml'))、
24    // そのファイルのパスが baseURI となります。
25    $xmlContent = <<<XML
26<?xml version="1.0" encoding="UTF-8"?>
27<root>
28    <item>
29        <description><![CDATA[これはCDATAセクションのコンテンツです。特殊文字 <, &, > もエスケープされずにそのまま含まれます。]]></description>
30        <link>relative/path/to/resource.html</link>
31    </item>
32</root>
33XML;
34
35    // XML文字列を DOMDocument にロードします。
36    // エラーチェックを省略していますが、実際のアプリケーションではロードの成否を確認するべきです。
37    $dom->loadXML($xmlContent);
38
39    // CDATA セクションノードを検索します。
40    // この例では、<description> 要素の最初の子ノードが CDATA セクションであると仮定します。
41    $cdataSection = null;
42    $descriptionElements = $dom->getElementsByTagName('description');
43
44    if ($descriptionElements->length > 0) {
45        $firstDescriptionElement = $descriptionElements->item(0);
46        foreach ($firstDescriptionElement->childNodes as $childNode) {
47            if ($childNode instanceof DOMCdataSection) {
48                $cdataSection = $childNode;
49                break; // 最初のCDATAセクションを見つけたらループを終了
50            }
51        }
52    }
53
54    if ($cdataSection !== null) {
55        // DOMCdataSection の baseURI プロパティにアクセスします。
56        // 前述の通り、XML文字列からロードした場合は空文字列が返されます。
57        $baseUri = $cdataSection->baseURI;
58
59        echo "DOMCdataSection のベースURI: " . ($baseUri === '' ? '[空文字列]' : $baseUri) . "\n";
60        echo "CDATAセクションの内容: " . $cdataSection->data . "\n";
61    } else {
62        echo "XMLドキュメントから CDATA セクションが見つかりませんでした。\n";
63    }
64}
65
66// 関数を実行してサンプルコードの動作を確認します。
67demonstrateDomCdataSectionBaseUri();
68

DOMCdataSection::baseURI プロパティは、PHPのDOM拡張機能において、XMLドキュメント内のCDATAセクションが属するドキュメントのベースURI（Uniform Resource Identifier）を取得するために使用されます。このプロパティは引数を取らず、戻り値として文字列（string）を返します。返される文字列は、そのXMLドキュメントがどこから読み込まれたか、つまりそのドキュメントの「元の場所」を示すものです。これは、Webサーバーで動作するPHPスクリプトのURLとは異なり、XMLファイルのパスやネットワーク上のURIを指します。

サンプルコードでは、まずDOMDocumentオブジェクトを初期化し、CDATAセクションを含むXML文字列をメモリ上にロードしています。次に、getElementsByTagNameメソッドとループを使ってドキュメントからDOMCdataSectionのインスタンスを探し出します。CDATAセクションが見つかった後、$cdataSection->baseURIプロパティにアクセスすることでベースURIを取得し、表示しています。メモリからロードされたXMLの場合、通常このプロパティは空文字列を返しますが、もしXMLファイルからロードした場合（例: $dom->load('path/to/document.xml')）は、そのファイルのパスがベースURIとして返されます。このプロパティは、XMLドキュメントのコンテキストを理解する上で役立ちます。