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

Copy
1<?php
2
3/**
4 * Dom\Document::lookupPrefix メソッドの使用例を示します。
5 * 指定された名前空間URIに対応するプレフィックスを検索します。
6 *
7 * @param string $namespaceUri 検索する名前空間URI
8 * @return void
9 */
10function demonstrateLookupPrefix(string $namespaceUri): void
11{
12    echo "検索する名前空間URI: " . $namespaceUri . PHP_EOL;
13
14    // 新しいDOMドキュメントを作成します。
15    $dom = new Dom\Document('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力を整形します
17
18    // ルート要素を作成し、名前空間とプレフィックスを割り当てます。
19    $root = $dom->createElementNS('http://example.com/ns1', 'ns1:root');
20    $dom->appendChild($root);
21
22    // 別の要素を追加し、異なる名前空間を割り当てます。
23    $child = $dom->createElementNS('http://example.com/ns2', 'ns2:child');
24    $root->appendChild($child);
25
26    echo "--- 生成されたXMLのプレビュー ---" . PHP_EOL;
27    echo $dom->saveXML() . PHP_EOL;
28    echo "----------------------------" . PHP_EOL;
29
30    // 指定された名前空間URIに対応するプレフィックスを検索します。
31    $prefix = $dom->lookupPrefix($namespaceUri);
32
33    // 結果を表示します。
34    if ($prefix !== null) {
35        echo "名前空間URI '" . $namespaceUri . "' に対応するプレフィックスは '" . $prefix . "' です。" . PHP_EOL;
36    } else {
37        echo "名前空間URI '" . $namespaceUri . "' に対応するプレフィックスは見つかりませんでした。" . PHP_EOL;
38    }
39
40    echo PHP_EOL;
41}
42
43// 例1: 存在する名前空間URIを検索
44demonstrateLookupPrefix('http://example.com/ns1');
45
46// 例2: 別の存在する名前空間URIを検索
47demonstrateLookupPrefix('http://example.com/ns2');
48
49// 例3: 存在しない名前空間URIを検索
50demonstrateLookupPrefix('http://example.com/nonexistent');

このサンプルコードは、PHPのDom\Document::lookupPrefixメソッドの使い方を具体的に示しています。このメソッドは、XMLドキュメント内で定義された名前空間URIと、それに対応するプレフィックスの関係を検索するために利用されます。

引数には検索したい名前空間のURI（string $namespaceURI）を指定します。メソッドは、ドキュメント内でそのURIに割り当てられているプレフィックスを文字列（string）で返します。もし該当するプレフィックスがドキュメント内に見つからない場合は、nullを返します（戻り値の?stringはこのどちらかの可能性があることを意味します）。

サンプルコードでは、まずDom\Documentオブジェクトを作成し、createElementNSメソッドを使って異なる名前空間URIとプレフィックスを持つXML要素をいくつか追加しています。これにより、名前空間とプレフィックスの関連付けをドキュメント内に構築します。その後、lookupPrefixメソッドを使って、実際に存在する名前空間URIや、意図的に存在しない名前空間URIを引数として渡し、それぞれに対応するプレフィックスが正しく検索されるか、あるいはnullが返されるかを確認し、その結果を出力しています。このメソッドは、XMLデータをプログラムで処理する際に、特定の名前空間URIからそのプレフィックスを動的に取得したい場合に非常に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Document::lookupPrefix のサンプルコード。
5 *
6 * この関数は、XMLドキュメント内で指定された名前空間URIに対応するプレフィックス（エイリアス）を検索します。
7 *
8 * キーワード `location.search` について:
9 * `location.search` はJavaScriptでURLのクエリ文字列（例: `?param=value`）を取得する際に使用されます。
10 * PHPでは、URLのクエリ文字列は通常 `$_GET` スーパーグローバル変数や `$_SERVER['QUERY_STRING']` で扱われます。
11 * このサンプルでは、URLのクエリパラメータとして名前空間URIを受け取り、
12 * それを Dom\Document::lookupPrefix メソッドに渡すシナリオを想定しています。
13 */
14function demonstrateLookupPrefixFromQuery(): void
15{
16    // URLクエリから名前空間URIを取得します。
17    // 例: ?namespace_uri=http://example.com/my-ns のようにアクセスすると、そのURIが使われます。
18    // デフォルト値としてよく使われるSVGの名前空間URIを設定しています。
19    $namespaceURI = $_GET['namespace_uri'] ?? 'http://www.w3.org/2000/svg';
20
21    echo "--- Dom\\Document::lookupPrefix のデモンストレーション ---" . PHP_EOL;
22    echo "URLクエリから取得された名前空間URI: " . htmlspecialchars($namespaceURI) . PHP_EOL . PHP_EOL;
23
24    // Dom\Document オブジェクトを新規作成します。
25    $dom = new Dom\Document();
26
27    // 名前空間を持つ簡単なXML文字列をロードします。
28    // xmlns:myns="http://example.com/my-ns" は "http://example.com/my-ns" に "myns" というプレフィックスを割り当てています。
29    // xmlns:svg="http://www.w3.org/2000/svg" は "http://www.w3.org/2000/svg" に "svg" というプレフィックスを割り当てています。
30    $xmlString = <<<XML
31    <root xmlns:myns="http://example.com/my-ns" xmlns:svg="http://www.w3.org/2000/svg">
32        <myns:element id="1"/>
33        <svg:circle cx="10" cy="10" r="5"/>
34        <anotherElement/>
35    </root>
36    XML;
37
38    $dom->loadXML($xmlString);
39
40    // Dom\Document::lookupPrefix を使用して、指定された名前空間URIのプレフィックスを検索します。
41    // プレフィックスが見つかった場合はその文字列を、見つからない場合は null を返します。
42    $prefix = $dom->lookupPrefix($namespaceURI);
43
44    if (null !== $prefix) {
45        echo "見つかったプレフィックス: " . htmlspecialchars($prefix) . PHP_EOL;
46        echo "これは、XML内で '{$namespaceURI}' に '{$prefix}:' というエイリアスが使われていることを意味します。" . PHP_EOL;
47    } else {
48        echo "エラー: 指定された名前空間URI '{$namespaceURI}' に対応するプレフィックスは見つかりませんでした。" . PHP_EOL;
49        echo "XMLドキュメント内にそのURIが定義されていないか、またはプレフィックスが割り当てられていません。" . PHP_EOL;
50    }
51
52    echo PHP_EOL . "--- 別の例 (見つからない場合) ---" . PHP_EOL;
53    $nonExistentURI = "http://example.com/non-existent-ns";
54    echo "検索するURI (存在しない): " . htmlspecialchars($nonExistentURI) . PHP_EOL;
55    $prefixNonExistent = $dom->lookupPrefix($nonExistentURI);
56    if (null !== $prefixNonExistent) {
57        echo "見つかったプレフィックス: " . htmlspecialchars($prefixNonExistent) . PHP_EOL;
58    } else {
59        echo "見つかったプレフィックス: (null) - 想定通り、存在しないURIなので見つかりません。" . PHP_EOL;
60    }
61}
62
63// 関数を実行します。
64// コマンドラインで実行する場合:
65// php your_script.php
66// Webサーバーで実行し、URLでパラメータを渡す場合:
67// http://localhost/your_script.php?namespace_uri=http://example.com/my-ns
68// http://localhost/your_script.php?namespace_uri=http://www.w3.org/2000/svg
69demonstrateLookupPrefixFromQuery();
70

PHPのDom\Document::lookupPrefixメソッドは、XMLドキュメント内で指定された名前空間URIに対応するプレフィックス（別名）を検索するために利用します。このメソッドはDom\Documentクラスに属しており、string $namespaceURIという名前空間URIを引数として受け取ります。検索の結果、対応するプレフィックスが見つかった場合はそのプレフィックスを表す文字列を返し、見つからなかった場合はnullを返します。

サンプルコードでは、WebブラウザのURLからクエリ文字列（例えば?namespace_uri=...）を通じて名前空間URIを受け取るシナリオを想定しています。これはJavaScriptでURLのクエリ部分を扱うlocation.searchに相当し、PHPでは$_GETスーパーグローバル変数で同様に取得できます。取得した名前空間URIを使って、事前にロードされたXMLドキュメント内を検索します。

例えば、XMLドキュメントにxmlns:myns="http://example.com/my-ns"のように定義されている場合、lookupPrefix('http://example.com/my-ns')を実行するとmynsという文字列が返されます。もし指定した名前空間URIがXMLドキュメントに定義されていない場合はnullが返され、その名前空間にプレフィックスが割り当てられていないことを示します。これにより、XMLの名前空間とプレフィックスの関係を動的に確認することが可能です。