【PHP8.x】DOMCdataSection::lookupNamespaceURI()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMCdataSection::lookupNamespaceURI メソッドのデモンストレーション。
5 * CDataセクションを含むXMLノードから、定義された名前空間URIを検索します。
6 *
7 * @return void
8 */
9function demonstrateDomCdataSectionNamespaceLookup(): void
10{
11    // 1. DOMDocumentを作成し、XML構造を準備します。
12    //    XMLバージョンとエンコーディングを指定します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力時にXMLを整形して見やすくします。
15    $dom->formatOutput = true;
16
17    // 2. 名前空間を持つルート要素を作成します。
18    //    'http://example.com/default' をデフォルト名前空間として設定します。
19    //    'root' は要素名です。
20    $rootElement = $dom->createElementNS('http://example.com/default', 'root');
21    //    'myprefix' というプレフィックスに 'http://example.com/myprefix' 名前空間URIを割り当てます。
22    $rootElement->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:myprefix', 'http://example.com/myprefix');
23    $dom->appendChild($rootElement);
24
25    // 3. ルート要素の子要素として 'data' 要素を作成します。
26    //    'data' 要素は親要素 'root' のデフォルト名前空間を継承します。
27    $dataElement = $dom->createElement('data');
28    $rootElement->appendChild($dataElement);
29
30    // 4. CDataSectionを作成し、'data' 要素の子として追加します。
31    //    CDataSection自体は名前空間を持ちませんが、その親ノードを通して名前空間解決を行います。
32    $cdata = $dom->createCDATASection('これはCDataセクションのコンテンツです。');
33    $dataElement->appendChild($cdata);
34
35    echo "--- DOMCdataSection::lookupNamespaceURI デモンストレーション ---\n\n";
36
37    // 5. CDataセクションから様々なプレフィックスの名前空間URIを検索します。
38
39    // デフォルト名前空間 (プレフィックスがnullまたは空文字列の場合) を検索します。
40    // 'data' 要素が属するデフォルト名前空間のURIが返されるはずです。
41    $defaultNamespaceUri = $cdata->lookupNamespaceURI(null);
42    echo "デフォルト名前空間のURI (プレフィックス: null): " . ($defaultNamespaceUri ?? '見つかりません') . "\n";
43
44    $defaultNamespaceUriEmpty = $cdata->lookupNamespaceURI('');
45    echo "デフォルト名前空間のURI (プレフィックス: 空文字列): " . ($defaultNamespaceUriEmpty ?? '見つかりません') . "\n\n";
46
47    // 'myprefix' というプレフィックスの名前空間を検索します。
48    // ルート要素で定義した名前空間URIが返されるはずです。
49    $myPrefixNamespaceUri = $cdata->lookupNamespaceURI('myprefix');
50    echo "プレフィックス 'myprefix' のURI: " . ($myPrefixNamespaceUri ?? '見つかりません') . "\n\n";
51
52    // 定義されていないプレフィックスの名前空間を検索します。
53    // 定義されていないため、null が返されるはずです。
54    $undefinedPrefixNamespaceUri = $cdata->lookupNamespaceURI('undefined');
55    echo "未定義プレフィックス 'undefined' のURI: " . ($undefinedPrefixNamespaceUri ?? '見つかりません') . "\n";
56
57    echo "\n--- 生成されたXMLドキュメント --- \n";
58    echo $dom->saveXML();
59    echo "\n-----------------------------------\n";
60}
61
62// 関数を実行し、結果を出力します。
63demonstrateDomCdataSectionNamespaceLookup();
64

PHPのDOMCdataSection::lookupNamespaceURIメソッドは、XMLドキュメントのCDataセクションから、特定の名前空間プレフィックスに対応する名前空間URIを探す際に利用されます。CDataセクション自体は名前空間を持ちませんが、その親ノードの定義に基づいて名前空間を解決します。

引数$prefixには検索したい名前空間のプレフィックスを文字列で渡します。nullや空文字列''は、デフォルト名前空間を意味します。

戻り値は、指定されたプレフィックスに対応する名前空間URIが見つかればそのURIを文字列で、見つからなければnullを返します。

このサンプルコードでは、名前空間を定義したXMLドキュメントを作成し、CDataセクションを配置しています。その後、CDataセクションからデフォルト名前空間、定義済みのmyprefix、そして未定義のプレフィックスの名前空間URIを検索し、それぞれの結果を表示しています。これにより、名前空間の解決がどのように行われるかを確認いただけます。

Copy
1<?php
2
3/**
4 * DOMCdataSection::lookupNamespaceURI() の使用例を示します。
5 * この関数は、XML ドキュメントのスコープ内で指定されたプレフィックスに対応する名前空間 URI を検索する方法を示します。
6 * 特定のプレフィックスに対する名前空間が見つからない場合の挙動も確認できます。
7 */
8function demonstrateDomCdataSectionNamespaceLookup(): void
9{
10    // 新しい DOMDocument を作成し、XML の整形出力を有効にします。
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true;
13
14    // 名前空間プレフィックスが宣言されたルート要素を作成します。
15    // ここで 'myns' プレフィックスが 'http://example.com/myns' URI にバインドされます。
16    $root = $dom->createElementNS('http://example.com/base', 'base:root');
17    $root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:myns', 'http://example.com/myns');
18    $dom->appendChild($root);
19
20    // CDATA セクションを格納するための子要素を作成します。
21    $childElement = $dom->createElement('data');
22    $root->appendChild($childElement);
23
24    // CDATA セクションを作成します。
25    // CDATA セクションの内容は XML として解析されませんが、
26    // それ自体は XML ドキュメントの既存の名前空間スコープ内に存在します。
27    $cdataSection = $dom->createCDATASection('This is some unparsed <data> with special characters.');
28    $childElement->appendChild($cdataSection);
29
30    echo "--- 生成された XML ドキュメント ---\n";
31    echo $dom->saveXML() . "\n";
32
33    echo "--- DOMCdataSection::lookupNamespaceURI() のデモンストレーション ---\n";
34
35    // ケース 1: 先祖要素で定義されているプレフィックスを検索します。
36    // 'myns' プレフィックスはルート要素で定義されているため、URI が見つかるはずです。
37    $definedPrefix = 'myns';
38    $uriForDefinedPrefix = $cdataSection->lookupNamespaceURI($definedPrefix);
39
40    if ($uriForDefinedPrefix !== null) {
41        echo "プレフィックス '{$definedPrefix}' の URI: {$uriForDefinedPrefix}\n";
42    } else {
43        echo "プレフィックス '{$definedPrefix}' の URI が見つかりませんでした (この設定では予期しない結果)。\n";
44    }
45
46    // ケース 2: どの先祖要素でも定義されていないプレフィックスを検索します。
47    // この場合、'namespace not found' (名前空間が見つからない) シナリオとして null が返されるはずです。
48    $undefinedPrefix = 'unknownns';
49    $uriForUndefinedPrefix = $cdataSection->lookupNamespaceURI($undefinedPrefix);
50
51    if ($uriForUndefinedPrefix === null) {
52        echo "プレフィックス '{$undefinedPrefix}' の URI が見つかりませんでした (期待通り、'名前空間が見つからない' 状況を示します)。\n";
53    } else {
54        echo "プレフィックス '{$undefinedPrefix}' の URI が予期せず見つかりました: {$uriForUndefinedPrefix}\n";
55    }
56
57    // ケース 3: デフォルトの名前空間を検索します (プレフィックスに null を渡します)。
58    // この例では明示的なデフォルト名前空間が設定されていないため、null が返されるはずです。
59    $defaultNamespaceURI = $cdataSection->lookupNamespaceURI(null);
60    if ($defaultNamespaceURI !== null) {
61        echo "デフォルト名前空間 URI: {$defaultNamespaceURI}\n";
62    } else {
63        echo "デフォルト名前空間 URI が見つかりませんでした (期待通り)。\n";
64    }
65}
66
67// デモンストレーション関数を実行します。
68demonstrateDomCdataSectionNamespaceLookup();

DOMCdataSection::lookupNamespaceURI()は、XMLドキュメント内の特定のCDATAセクションのスコープで、指定された名前空間プレフィックスに対応するURIを検索するPHPのメソッドです。

このメソッドは、引数として検索したいプレフィックスを文字列で受け取ります。もしデフォルトの名前空間を調べたい場合は、引数にnullを指定します。

戻り値としては、指定されたプレフィックスに対応する名前空間URIが見つかった場合にそのURI（文字列）を返します。もし、検索したプレフィックスが現在のスコープで見つからない場合や、デフォルト名前空間が設定されていない場合はnullが返されます。このnullは、「名前空間が見つからない」状況（php namespace not found）を示します。

サンプルコードでは、まずXMLドキュメントを作成し、名前空間プレフィックス「myns」を定義したルート要素と、その中にCDATAセクションを含む要素を追加しています。その後、lookupNamespaceURI()を使って、定義済みの「myns」プレフィックスに対するURIが正しく取得できること、そしてドキュメント内で定義されていない「unknownns」プレフィックスやデフォルト名前空間を検索した場合には、期待通りnullが返されることを示しています。これにより、XMLデータ処理において、特定の名前空間URIを効率的に特定する方法や、名前空間が存在しない場合の挙動を理解できます。