【PHP8.x】Dom\CDATASection::lookupPrefix()メソッドの使い方

Copy
1<?php
2
3/**
4 * Dom\CDATASection::lookupPrefix メソッドの基本的な使用例を示します。
5 *
6 * このメソッドは、指定された名前空間URIに対応するプレフィックスを、
7 * CDATAセクションノードが属するXMLドキュメントの文脈で検索します。
8 * CDATAセクション自体が名前空間を定義することはありませんが、
9 * その親や祖先の要素が定義する名前空間のプレフィックスを解決できます。
10 */
11function demonstrateCDATASectionLookupPrefix(): void
12{
13    // 1. 新しいDOMドキュメントを作成します。
14    $dom = new Dom\Document('1.0', 'UTF-8');
15    $dom->formatOutput = true; // 出力を見やすくするために整形を有効にします。
16
17    // 2. ルート要素を作成し、名前空間とそのプレフィックスを定義します。
18    // 'http://example.com/rootns' は名前空間URI、'root' はそのプレフィックスです。
19    $rootElement = $dom->createElementNS('http://example.com/rootns', 'root:myRoot');
20    // 'data' プレフィックスと 'http://example.com/datans' 名前空間URIをルート要素に定義します。
21    $rootElement->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:data', 'http://example.com/datans');
22    $dom->appendChild($rootElement);
23
24    // 3. 子要素を作成し、別の名前空間とそのプレフィックスを定義します。
25    // 'http://example.com/childns' は名前空間URI、'child' はそのプレフィックスです。
26    $childElement = $dom->createElementNS('http://example.com/childns', 'child:myItem');
27    // 'info' プレフィックスと 'http://example.com/infons' 名前空間URIを子要素に定義します。
28    $childElement->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:info', 'http://example.com/infons');
29    $rootElement->appendChild($childElement);
30
31    // 4. CDATAセクションノードを作成します。
32    // CDATAセクションは特殊文字を含む可能性のあるテキストデータを格納するために使用されます。
33    $cdata = $dom->createCDATASection('This is some <data> with special characters.');
34    $childElement->appendChild($cdata); // CDATAセクションを子要素に追加します。
35
36    echo "--- 生成されたXMLドキュメント ---\n";
37    echo $dom->saveXML() . "\n";
38
39    echo "--- Dom\\CDATASection::lookupPrefix のテスト ---\n";
40
41    // 5. CDATASectionノードに対して lookupPrefix を呼び出し、結果を確認します。
42
43    // 子要素 'child:myItem' で定義された名前空間 'http://example.com/infons' のプレフィックスを検索します。
44    $prefixInfo = $cdata->lookupPrefix('http://example.com/infons');
45    echo "名前空間 'http://example.com/infons' (親要素 'child:myItem' で定義) のプレフィックス: ";
46    echo ($prefixInfo === null ? 'null' : "'$prefixInfo'") . " (期待値: 'info')\n";
47
48    // ルート要素 'root:myRoot' で定義された名前空間 'http://example.com/datans' のプレフィックスを検索します。
49    $prefixData = $cdata->lookupPrefix('http://example.com/datans');
50    echo "名前空間 'http://example.com/datans' (祖先要素 'root:myRoot' で定義) のプレフィックス: ";
51    echo ($prefixData === null ? 'null' : "'$prefixData'") . " (期待値: 'data')\n";
52
53    // ルート要素 'root:myRoot' 自体の名前空間 'http://example.com/rootns' のプレフィックスを検索します。
54    $prefixRoot = $cdata->lookupPrefix('http://example.com/rootns');
55    echo "名前空間 'http://example.com/rootns' (祖先要素 'root:myRoot' の名前空間) のプレフィックス: ";
56    echo ($prefixRoot === null ? 'null' : "'$prefixRoot'") . " (期待値: 'root')\n";
57
58    // 存在しない名前空間URIのプレフィックスを検索します。
59    $prefixNonExistent = $cdata->lookupPrefix('http://example.com/nonexistent');
60    echo "存在しない名前空間 'http://example.com/nonexistent' のプレフィックス: ";
61    echo ($prefixNonExistent === null ? 'null' : "'$prefixNonExistent'") . " (期待値: null)\n";
62}
63
64// 関数を実行してサンプルコードの動作を確認します。
65demonstrateCDATASectionLookupPrefix();
66
67?>

PHP 8のDom\CDATASection::lookupPrefixメソッドは、XMLドキュメント内で指定された名前空間URIに対応するプレフィックスを検索する際に使用されます。XMLでは、要素や属性の重複を避けるために名前空間URIとプレフィックスを関連付けて使用します。このメソッドは、CDATASectionノード自体が名前空間を定義することはありませんが、その親や祖先要素が定義する名前空間のプレフィックスを、CDATASectionノードが属するXMLツリーの文脈で解決します。

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

サンプルコードでは、まず複数の名前空間とプレフィックスが定義されたXMLドキュメントを作成し、その中にDom\CDATASectionを追加しています。そして、このCDATASectionオブジェクトからlookupPrefixメソッドを呼び出し、親や祖先要素で定義された名前空間URIに対応するプレフィックスが期待通りに取得できることを確認しています。例えば、http://example.com/infonsからはinfo、http://example.com/datansからはdataというプレフィックスが取得され、存在しないURIにはnullが返される様子が示されています。このメソッドは、XML文書の動的な処理において名前空間の情報を解決する際に役立ちます。

Copy
1<?php
2
3/**
4 * URLクエリパラメータから名前空間URIを取得し、DOMのCDATASectionノードから対応するプレフィックスを検索する関数。
5 *
6 * この関数は、ウェブブラウザからアクセスされた際に、URLのクエリパラメータ
7 * (JavaScriptの `location.search` に相当する部分) から名前空間URIを受け取り、
8 * DOMツリー内でそのURIに関連付けられているプレフィックスを検索します。
9 *
10 * 例として、以下のURLでこのスクリプトにアクセスすると動作を確認できます:
11 * http://localhost/your_script.php?namespace_uri=http://www.example.com/myns
12 *
13 * または、プレフィックスが見つからない場合:
14 * http://localhost/your_script.php?namespace_uri=http://www.unknown.com/ns
15 *
16 * @return void
17 */
18function findNamespacePrefixFromUrlParam(): void
19{
20    // URLのクエリパラメータ 'namespace_uri' から検索対象の名前空間URIを取得します。
21    // PHPの $_GET スーパーグローバル変数は、JavaScriptの location.search をパースしたデータに相当します。
22    // パラメータが指定されていない場合は、デフォルトのURIを使用します。
23    $searchNamespaceUri = $_GET['namespace_uri'] ?? 'http://www.example.com/default_ns';
24
25    // 新しいDOMDocumentを作成し、XMLのバージョンとエンコーディングを指定します。
26    $dom = new DOMDocument('1.0', 'UTF-8');
27    $dom->formatOutput = true; // 出力されるXMLを見やすく整形します。
28
29    // ルート要素を作成し、名前空間とそのプレフィックスを定義します。
30    // ここで 'myns' というプレフィックスが 'http://www.example.com/myns' に割り当てられます。
31    $rootElement = $dom->createElementNS('http://www.example.com/myns', 'myns:data');
32    $dom->appendChild($rootElement);
33
34    // 子要素を作成し、別の名前空間とプレフィックスを定義します。
35    // ここで 'other' というプレフィックスが 'http://www.example.com/otherns' に割り当てられます。
36    $childElement = $dom->createElementNS('http://www.example.com/otherns', 'other:item');
37    $rootElement->appendChild($childElement);
38
39    // Dom\CDATASection ノードを作成します。
40    // CDATASectionは、内部のテキストがXMLパーサによって特殊文字として解釈されないようにするセクションです。
41    // このノード自体が名前空間を持たない場合でも、親ノードやドキュメントノードが持つ名前空間情報を
42    // 検索するコンテキストを提供します。
43    $cdataNode = $dom->createCDATASection("これは < & > 特殊文字を含むCDATAセクションです。");
44    $childElement->appendChild($cdataNode);
45
46    // 検索対象の名前空間URIを表示します。
47    echo "検索対象の名前空間URI: '{$searchNamespaceUri}'\n\n";
48
49    // Dom\CDATASection ノードから lookupPrefix メソッドを呼び出します。
50    // このメソッドは、ノード自身またはその祖先で定義されている名前空間の中から、
51    // 指定されたURIに対応するプレフィックスを検索します。
52    $prefix = $cdataNode->lookupPrefix($searchNamespaceUri);
53
54    // 検索結果に基づいてメッセージを表示します。
55    if ($prefix !== null) {
56        echo "見つかったプレフィックス: '{$prefix}'\n";
57        echo "指定された名前空間URI '{$searchNamespaceUri}' はXMLツリー内でプレフィックス '{$prefix}' に関連付けられています。\n";
58    } else {
59        echo "プレフィックスは見つかりませんでした。\n";
60        echo "指定された名前空間URI '{$searchNamespaceUri}' はXMLツリー内のどのプレフィックスにも関連付けられていません。\n";
61    }
62
63    echo "\n--- 生成されたXMLドキュメント ---\n";
64    // 生成されたXMLドキュメントの内容を表示します。
65    echo $dom->saveXML();
66}
67
68// 関数を実行します。
69findNamespacePrefixFromUrlParam();
70
71?>

このPHPコードは、XMLドキュメント内で定義された名前空間URIに対応するプレフィックスを検索する方法を示すものです。具体的には、Dom\CDATASectionクラスのlookupPrefixメソッドを使用します。このメソッドは、引数として渡されたstring $namespace、つまり検索したい名前空間のURIに対し、現在のノード（CDATASection）自身またはその祖先ノードで定義されているプレフィックスを探します。プレフィックスが見つかった場合はそのstringを返し、見つからない場合はnullを返します。

サンプルコードでは、まずURLのクエリパラメータから名前空間URIを取得しています。これは、ウェブブラウザのlocation.searchで得られる情報と似ており、PHPの$_GETスーパーグローバル変数で簡単にアクセスできます。次に、DOMDocumentを作成し、createElementNSを用いて複数の名前空間とプレフィックスを定義したXMLツリーを構築します。CDATASectionノードは、内部のテキストをXMLパーサに解釈させないための特殊なセクションですが、このノードを通して名前空間情報を検索するコンテキストを提供します。

cdataNode->lookupPrefix($searchNamespaceUri)の呼び出しによって、URLから取得した名前空間URIがXMLツリー内のどのプレフィックスに対応しているかを確認します。例えば、http://www.example.com/mynsが検索対象の名前空間URIとして渡されると、コード内で定義されたmynsというプレフィックスが見つかります。検索結果はif ($prefix !== null)で判定され、見つかったプレフィックス、または見つからなかった旨が表示されます。この機能は、XML処理において特定の名前空間URIからそのXMLドキュメント内で使用されているプレフィックスを動的に解決する必要がある場合に役立ちます。