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

Copy
1<?php
2
3// DOMDocument::lookupPrefix メソッドのサンプルコード
4// このメソッドは、指定された名前空間URIに対応するXMLプレフィックスを検索します。
5// 主にXML文書内の要素や属性の名前空間情報を扱う際に使用されます。
6
7// 1. DOMDocument オブジェクトを作成します。
8$dom = new DOMDocument();
9
10// 2. 名前空間とプレフィックスを含むXML文字列を準備します。
11//    'myns' と 'other' という2つのプレフィックスがそれぞれ異なる名前空間URIに
12//    関連付けられています。
13$xmlString = <<<XML
14<root xmlns:myns="http://example.com/myns-uri" xmlns:other="http://example.com/other-uri">
15    <myns:item>これは myns 名前空間のアイテムです。</myns:item>
16    <other:item>これは other 名前空間のアイテムです。</other:item>
17    <item>これは名前空間なしのアイテムです。</item>
18</root>
19XML;
20
21// 3. DOMDocument に XML 文字列をロードします。
22//    これにより、XML文書の構造がメモリ内に構築され、操作可能になります。
23$dom->loadXML($xmlString);
24
25echo "--- DOMDocument::lookupPrefix の使用例 ---\n\n";
26
27// 4. 存在する名前空間URIに対応するプレフィックスを検索します。
28//    "http://example.com/myns-uri" に対応するプレフィックスを調べます。
29$existingNamespaceUri1 = "http://example.com/myns-uri";
30$prefixFound1 = $dom->lookupPrefix($existingNamespaceUri1);
31
32// 5. 検索結果を出力します。
33//    lookupPrefix は、対応するプレフィックスが見つかった場合は文字列を、
34//    見つからなかった場合は null を返します。
35if ($prefixFound1 !== null) {
36    echo "名前空間URI '{$existingNamespaceUri1}' に対応するプレフィックス: '{$prefixFound1}'\n";
37} else {
38    echo "名前空間URI '{$existingNamespaceUri1}' に対応するプレフィックスは見つかりませんでした。\n";
39}
40
41echo "\n"; // 出力を見やすくするための区切り
42
43// 6. 別の存在する名前空間URIでプレフィックスを検索します。
44//    "http://example.com/other-uri" に対応するプレフィックスを調べます。
45$existingNamespaceUri2 = "http://example.com/other-uri";
46$prefixFound2 = $dom->lookupPrefix($existingNamespaceUri2);
47
48if ($prefixFound2 !== null) {
49    echo "名前空間URI '{$existingNamespaceUri2}' に対応するプレフィックス: '{$prefixFound2}'\n";
50} else {
51    echo "名前空間URI '{$existingNamespaceUri2}' に対応するプレフィックスは見つかりませんでした。\n";
52}
53
54echo "\n"; // 出力を見やすくするための区切り
55
56// 7. 存在しない名前空間URIを検索します。
57//    XML文書内で定義されていない名前空間URIで検索するとどうなるか確認します。
58$nonExistentNamespaceUri = "http://example.com/non-existent-uri";
59$prefixNotFound = $dom->lookupPrefix($nonExistentNamespaceUri);
60
61if ($prefixNotFound !== null) {
62    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックス: '{$prefixNotFound}'\n";
63} else {
64    // プレフィックスが見つからないため、null が返ることが期待されます。
65    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックスは見つかりませんでした。(期待される結果)\n";
66}

PHPのDOMDocument::lookupPrefixメソッドは、XML文書内で指定された名前空間URIに対応するプレフィックス（接頭辞）を検索する機能です。このメソッドは、DOMDocumentオブジェクトにロードされたXML文書の名前空間情報を取り扱う際に利用されます。

引数$namespaceには、プレフィックスを検索したい名前空間URIを文字列で渡します。メソッドは、そのURIがXML文書内でどのプレフィックスに紐づけられているかを調べます。

戻り値は、対応するプレフィックスが見つかった場合にそのプレフィックス名を文字列として返します。もし、指定された名前空間URIに対応するプレフィックスがXML文書内に見つからない場合はnullが返されます。サンプルコードでは、定義済みの名前空間URIにはプレフィックスが、存在しないURIにはnullが返されることで、このメソッドの動作が明確に示されており、XMLデータの名前空間解決に有用です。

Copy
1<?php
2
3/**
4 * DOMDocument::lookupPrefix メソッドの使用例を示します。
5 * このコードは、Webブラウザの location.search (クエリパラメータ) から名前空間URIを取得し、
6 * そのURIに対応するXML名前空間プレフィックスを検索するシナリオを想定しています。
7 */
8function demonstrateDomLookupPrefix(): void
9{
10    // DOMDocumentの新しいインスタンスを作成します。
11    // このオブジェクトはXML文書全体を表現し、その構造や内容を操作するために使用されます。
12    $dom = new DOMDocument();
13
14    // サンプルXML文字列を読み込みます。
15    // ここでは 'my' というプレフィックスで 'http://example.com/my-ns' 名前空間を定義しています。
16    // また、'other' というプレフィックスで別の名前空間も定義しています。
17    $xmlString = <<<XML
18<root xmlns:my="http://example.com/my-ns" xmlns:other="http://example.com/other-ns">
19    <my:element attribute="value"/>
20    <other:anotherElement/>
21</root>
22XML;
23    $dom->loadXML($xmlString);
24
25    // PHPの $_GET スーパーグローバル変数を使用して、URLのクエリパラメータから
26    // 検索対象の名前空間URIを取得します。
27    // 例: スクリプトを `http://localhost/script.php?ns_uri=http://example.com/my-ns` のように実行すると、
28    // 'http://example.com/my-ns' が $targetNamespaceUri に設定されます。
29    // `??` オペレーターは、$_GET['ns_uri'] が存在しない場合に、デフォルト値
30    // 'http://example.com/my-ns' を使用して、単体で動作可能にします。
31    $targetNamespaceUri = $_GET['ns_uri'] ?? 'http://example.com/my-ns';
32
33    echo "検索対象の名前空間URI: '" . $targetNamespaceUri . "'" . PHP_EOL;
34
35    // DOMDocument::lookupPrefix メソッドを呼び出し、
36    // 指定された名前空間URIに対応するXMLプレフィックスを検索します。
37    // 見つかった場合はプレフィックス文字列を、見つからない場合は null を返します。
38    $prefix = $dom->lookupPrefix($targetNamespaceUri);
39
40    // 検索結果を出力します。
41    if ($prefix !== null) {
42        echo "見つかったプレフィックス: '" . $prefix . "'" . PHP_EOL;
43    } else {
44        echo "指定された名前空間URI ('" . $targetNamespaceUri . "') のプレフィックスは見つかりませんでした。" . PHP_EOL;
45    }
46
47    echo PHP_EOL; // 出力を見やすくするための空行
48
49    // 存在しない名前空間URIの例を試します。
50    // この場合、lookupPrefixは null を返します。
51    $nonExistentNamespace = "http://example.com/unknown-ns";
52    echo "存在しない名前空間URI ('" . $nonExistentNamespace . "') の検索:" . PHP_EOL;
53    $prefixNonExistent = $dom->lookupPrefix($nonExistentNamespace);
54    if ($prefixNonExistent !== null) {
55        echo "見つかったプレフィックス: '" . $prefixNonExistent . "'" . PHP_EOL;
56    } else {
57        echo "指定された名前空間URI ('" . $nonExistentNamespace . "') のプレフィックスは見つかりませんでした (期待される結果)。" . PHP_EOL;
58    }
59}
60
61// サンプル関数を実行します。
62demonstrateDomLookupPrefix();
63

DOMDocument::lookupPrefixメソッドは、XML文書内で定義されている特定の名前空間URIに対応するプレフィックスを検索するために使用されます。このメソッドは、引数として検索したい名前空間URI（string $namespace）を受け取ります。そして、そのURIに紐づくプレフィックスが見つかった場合は文字列として返し、見つからなかった場合はnullを返します。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、名前空間が定義されたXML文字列を読み込みます。次に、WebブラウザのURLのlocation.search（クエリパラメータ）をPHPの$_GET変数で取得し、これを検索対象の名前空間URIとして利用します。例えば、script.php?ns_uri=http://example.com/my-nsのようにアクセスすると、指定されたURIのプレフィックスを検索し、結果を表示します。これにより、WebサイトのURLに応じてXML内の特定要素を識別したり、その関連情報を処理したりするシナリオで、名前空間とプレフィックスの関連性を動的に調べる際に役立ちます。存在しない名前空間URIを指定した場合はnullが返されるため、適切な条件分岐で処理を記述することが重要です。