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

Copy
1<?php
2
3/**
4 * DOMElement::lookupPrefix メソッドの使用例を示します。
5 * このメソッドは、現在の要素のスコープ内で、指定された名前空間URIに対応するプレフィックスを検索します。
6 * 見つからない場合は null を返します。
7 *
8 * @return void
9 */
10function demonstrateLookupPrefix(): void
11{
12    // 名前空間を持つ簡単なXML文字列を作成します。
13    // 'ns1' と 'ns2' というプレフィックスで名前空間が定義されています。
14    $xmlString = <<<XML
15<root xmlns:ns1="http://example.com/namespace1" xmlns:ns2="http://example.com/namespace2">
16    <ns1:item>最初のアイテム</ns1:item>
17    <ns2:data>関連データ</ns2:data>
18</root>
19XML;
20
21    // DOMDocumentオブジェクトを初期化し、XML文字列を読み込みます。
22    $dom = new DOMDocument();
23    $dom->loadXML($xmlString);
24
25    // ドキュメントのルート要素を取得します。
26    // lookupPrefixは、この要素（またはその祖先）で定義された名前空間を検索します。
27    $rootElement = $dom->documentElement;
28
29    // --- 存在する名前空間のプレフィックスを検索する例 ---
30
31    // XML内で 'ns1' に割り当てられている名前空間URI
32    $namespaceUri1 = "http://example.com/namespace1";
33    $prefix1 = $rootElement->lookupPrefix($namespaceUri1);
34
35    echo "名前空間URI '{$namespaceUri1}' に対応するプレフィックス: ";
36    if ($prefix1 !== null) {
37        echo "'{$prefix1}'\n"; // 期待される出力: 'ns1'
38    } else {
39        echo "見つかりませんでした (null)\n";
40    }
41
42    // XML内で 'ns2' に割り当てられている名前空間URI
43    $namespaceUri2 = "http://example.com/namespace2";
44    $prefix2 = $rootElement->lookupPrefix($namespaceUri2);
45
46    echo "名前空間URI '{$namespaceUri2}' に対応するプレフィックス: ";
47    if ($prefix2 !== null) {
48        echo "'{$prefix2}'\n"; // 期待される出力: 'ns2'
49    } else {
50        echo "見つかりませんでした (null)\n";
51    }
52
53    // --- 存在しない名前空間のプレフィックスを検索する例 (nullが返る) ---
54
55    // XML内で定義されていない名前空間URI
56    $nonExistentNamespaceUri = "http://example.com/nonExistentNamespace";
57    $nonExistentPrefix = $rootElement->lookupPrefix($nonExistentNamespaceUri);
58
59    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックス: ";
60    if ($nonExistentPrefix !== null) {
61        echo "'{$nonExistentPrefix}'\n";
62    } else {
63        echo "見つかりませんでした (null) - これは期待される結果です\n";
64    }
65}
66
67// サンプル関数を実行します。
68demonstrateLookupPrefix();

PHPのDOMElement::lookupPrefixメソッドは、XMLドキュメントの要素内で、指定された名前空間URIに対応するプレフィックスを検索するために使用されます。XMLでは、要素や属性の名前が重複しないように名前空間が使われ、通常は短いプレフィックス（例: ns1:）で識別されます。このメソッドは、引数として検索したい名前空間URI（string $namespace）を受け取ります。そして、現在の要素、またはその親要素や祖先要素で、そのURIが定義されていれば、対応するプレフィックスを文字列で返します。もし該当する名前空間URIが見つからなかった場合は、nullが戻り値として返されます。

サンプルコードでは、名前空間を持つXML文字列を読み込み、DOMDocumentオブジェクトとして扱っています。ルート要素に対してlookupPrefixメソッドを呼び出し、http://example.com/namespace1やhttp://example.com/namespace2といった既存の名前空間URIから、それぞれ対応するプレフィックスであるns1やns2を正確に取得する様子が示されています。また、XML内で定義されていない名前空間URIを指定した場合には、期待通りnullが返されることも確認できます。このメソッドは、XMLの名前空間をプログラムで動的に処理する際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * URLクエリパラメータを処理し、DOMElement::lookupPrefixの動作を示すサンプル関数。
5 *
6 * この関数は、ブラウザのURLからクエリパラメータ（例: ?ns_uri=...&data=...）を取得し、
7 * それらを使ってXML DOM文書を構築し、特定要素の名前空間プレフィックスを検索します。
8 * PHPにおける'location.search'（URLのクエリ文字列）の扱いは、`$_GET`スーパーグローバル配列を通じて行われます。
9 *
10 * 実行例:
11 *   http://localhost/your_script.php?ns_uri=http://example.com/ns/data&data=HelloPHP
12 */
13function demonstrateDomPrefixLookup(): void
14{
15    // URLのクエリパラメータから名前空間URIとデータ内容を取得します。
16    // 'ns_uri'パラメータがない場合はデフォルトURIを使用します。
17    $namespaceUri = $_GET['ns_uri'] ?? 'http://example.com/default/namespace';
18    // 'data'パラメータがない場合はデフォルト値を使用します。
19    $dataContent = $_GET['data'] ?? 'Default Item Content';
20
21    // DOMDocumentオブジェクトを作成し、XML文書の操作を開始します。
22    $dom = new DOMDocument('1.0', 'UTF-8');
23    $dom->formatOutput = true; // XML出力を見やすく整形します。
24
25    // ルート要素を作成します。
26    $root = $dom->createElement('RootElement');
27    $dom->appendChild($root);
28
29    // クエリパラメータから取得した名前空間URIとプレフィックス付きの名前で子要素を作成します。
30    // ここで 'item:' というプレフィックスを使用することで、この名前空間URIが
31    // 'item' プレフィックスと関連付けられることをDOMが内部的に処理します。
32    $childElement = $dom->createElementNS($namespaceUri, 'item:ChildItem');
33    $childElement->nodeValue = $dataContent; // クエリパラメータからのデータを要素の内容に設定
34    $root->appendChild($childElement);
35
36    // DOMElement::lookupPrefix メソッドを使用して、
37    // 指定した名前空間URIに対応するプレフィックスを検索します。
38    // $childElement のスコープ（自身または祖先要素）で定義されたプレフィックスを探します。
39    $foundPrefix = $childElement->lookupPrefix($namespaceUri);
40
41    // 生成されたXML文書を表示します。
42    echo "<h3>Generated XML:</h3>";
43    echo "<pre>" . htmlentities($dom->saveXML()) . "</pre>";
44
45    // lookupPrefixの結果を表示します。
46    echo "<h3>Lookup Result:</h3>";
47    if ($foundPrefix !== null) {
48        echo "<p>For Namespace URI: '{$namespaceUri}'</p>";
49        echo "<p>The found prefix on element '{$childElement->nodeName}' is: '<strong>{$foundPrefix}</strong>'</p>";
50    } else {
51        echo "<p>No prefix found for Namespace URI: '{$namespaceUri}' on element '{$childElement->nodeName}'.</p>";
52    }
53}
54
55// スクリプトが直接実行された場合にメイン関数を呼び出します。
56demonstrateDomPrefixLookup();
57
58?>

DOMElement::lookupPrefixメソッドは、XML文書内の特定のDOM要素に対して、指定された名前空間URIに対応するプレフィックスを検索するために使用されます。引数$namespaceには検索したい名前空間のURI（例: http://example.com/ns/data）を文字列で指定します。メソッドは、そのURIに対応するプレフィックスが見つかった場合は文字列で、見つからなかった場合はnullを返します。

このサンプルコードでは、PHPでWebブラウザのURLクエリパラメータ（JavaScriptのlocation.searchに相当する部分）を$_GETスーパーグローバル変数を通じて取得し、これを利用してXML文書を動的に生成します。具体的には、ns_uriパラメータから名前空間URIを、dataパラメータから要素の内容を取得しています。

まず、DOMDocumentを作成し、取得した名前空間URIとプレフィックス付きの名前（例: item:ChildItem）を用いてcreateElementNSで子要素を生成します。このとき、PHPのDOM拡張機能が内部的に名前空間とプレフィックスの関連付けを処理します。

その後、$childElementに対してlookupPrefix($namespaceUri)を呼び出すことで、この要素のスコープ内で定義されている、指定した名前空間URIに対応するプレフィックスが何であるかを検索し、結果を表示しています。これにより、XML文書内で使用されている名前空間とプレフィックスの対応関係をプログラムで確認できることを示しています。