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

Copy
1<?php
2
3// XML ドキュメントの文字列を定義します。
4// このXMLには、名前空間URI "http://example.com/myns" に対して "myns" というプレフィックスが関連付けられています。
5$xmlString = <<<XML
6<root xmlns:myns="http://example.com/myns">
7    <myns:element attr="value" />
8    <otherElement />
9</root>
10XML;
11
12// Dom\XMLDocument の新しいインスタンスを作成します。
13// このオブジェクトは、XMLドキュメントをプログラムで操作するために使用されます。
14$document = new Dom\XMLDocument();
15
16// 定義したXML文字列をドキュメントに読み込みます。
17// これにより、XMLの構造が解析され、オブジェクトとしてメモリにロードされます。
18// loadXML() メソッドは成功した場合に true を、失敗した場合に false を返しますが、
19// このサンプルでは簡潔さのためエラーチェックは省略しています。
20$document->loadXML($xmlString);
21
22echo "--- Dom\\XMLDocument::lookupPrefix の使用例 ---\n\n";
23
24// 例1: 存在する名前空間URIに対応するプレフィックスを検索します。
25// XML内の "http://example.com/myns" というURIは "myns" というプレフィックスで定義されています。
26$namespaceUri1 = "http://example.com/myns";
27$prefix1 = $document->lookupPrefix($namespaceUri1);
28
29echo "検索対象の名前空間URI: '{$namespaceUri1}'\n";
30if ($prefix1 !== null) {
31    echo "  -> 見つかったプレフィックス: '{$prefix1}'\n";
32} else {
33    echo "  -> この名前空間URIに対応するプレフィックスは見つかりませんでした。\n";
34}
35
36echo "\n";
37
38// 例2: 存在しない名前空間URIに対応するプレフィックスを検索します。
39// このURIはXMLドキュメント内で定義されていないため、プレフィックスは見つかりません。
40$namespaceUri2 = "http://example.com/nonexistent";
41$prefix2 = $document->lookupPrefix($namespaceUri2);
42
43echo "検索対象の名前空間URI: '{$namespaceUri2}'\n";
44if ($prefix2 !== null) {
45    echo "  -> 見つかったプレフィックス: '{$prefix2}'\n";
46} else {
47    echo "  -> この名前空間URIに対応するプレフィックスは見つかりませんでした。\n";
48}
49
50?>

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

サンプルコードでは、まず名前空間mynsが定義されたXML文字列を用意し、Dom\XMLDocumentオブジェクトに読み込んでいます。次に、lookupPrefixメソッドを使って「http://example.com/myns」という名前空間URIを検索します。このURIはXML内で「myns」プレフィックスとして定義されているため、メソッドは「myns」という文字列を返します。一方、「http://example.com/nonexistent」のように存在しない名前空間URIを検索した場合、対応するプレフィックスは見つからないため、`null`が返されることを確認できます。これにより、XMLドキュメント内の名前空間とプレフィックスの関連性をプログラムから効率的に確認できます。

Copy
1<?php
2
3/**
4 * URLのクエリパラメータから名前空間URIを取得し、Dom\XMLDocument を使用して
5 * そのURIに対応するXMLプレフィックスを検索するサンプルコードです。
6 *
7 * キーワード「location.search」はJavaScriptでURLのクエリ文字列を指しますが、
8 * PHPでは通常 $_GET スーパーグローバル変数で対応する情報を取得します。
9 * このサンプルでは、URLのクエリパラメータとして名前空間URIを受け取り、
10 * XMLドキュメント内でそのURIのプレフィックスを検索します。
11 */
12function lookupXmlPrefixFromQuery(): void
13{
14    // 名前空間が定義された簡単なXML文字列
15    $xmlString = <<<XML
16<root xmlns:ex="http://example.com/ns/example" xmlns:oth="http://example.com/ns/other">
17    <ex:item>Example Item</ex:item>
18    <oth:data>Other Data</oth:data>
19</root>
20XML;
21
22    // Dom\XMLDocument オブジェクトのインスタンス化
23    $xmlDocument = new Dom\XMLDocument();
24
25    // XML文字列を読み込みます
26    // 読み込みに失敗した場合の基本的なエラーハンドリング
27    if (!$xmlDocument->loadXML($xmlString)) {
28        echo "エラー: XMLの読み込みに失敗しました。\n";
29        return;
30    }
31
32    // URLのクエリパラメータから名前空間URIを取得します。
33    // 例: http://localhost/script.php?namespace=http://example.com/ns/example
34    // クエリパラメータが指定されていない場合は、デフォルトのURIを使用します。
35    $namespaceUri = $_GET['namespace'] ?? '';
36
37    if (empty($namespaceUri)) {
38        echo "ヒント: URLに '?namespace=http://example.com/ns/example' のようなクエリパラメータを追加して試してください。\n";
39        // デフォルトとして、定義済みの名前空間URIを使用
40        $namespaceUri = "http://example.com/ns/example";
41    }
42
43    echo "検索対象の名前空間URI: '" . htmlspecialchars($namespaceUri) . "'\n";
44
45    // Dom\XMLDocument::lookupPrefix メソッドを使用して、
46    // 指定された名前空間URIに対応するプレフィックスを検索します。
47    // 戻り値は ?string 型で、見つからなければ null を返します。
48    $prefix = $xmlDocument->lookupPrefix($namespaceUri);
49
50    if ($prefix !== null) {
51        echo "名前空間URI '" . htmlspecialchars($namespaceUri) . "' に対応するプレフィックスは '" . htmlspecialchars($prefix) . "' です。\n";
52    } else {
53        echo "名前空間URI '" . htmlspecialchars($namespaceUri) . "' に対応するプレフィックスは見つかりませんでした。\n";
54    }
55}
56
57// 関数を実行します
58lookupXmlPrefixFromQuery();
59
60?>

このサンプルコードは、PHPのDom\XMLDocumentクラスに属するlookupPrefixメソッドの利用方法を示しています。lookupPrefixメソッドは、XMLドキュメント内で特定の名前空間URI（Uniform Resource Identifier）がどのXMLプレフィックスに対応しているかを検索するために使用されます。

引数には検索したい名前空間URIを文字列として渡します。メソッドは、対応するプレフィックスが見つかればその文字列を返し、見つからなければnullを返します。これは戻り値が?string型であることを意味し、文字列かnullのどちらかが返されることを示します。

サンプルでは、まず簡単なXML文字列をDom\XMLDocumentに読み込みます。次に、ウェブブラウザのURLに含まれるクエリパラメータ（例: http://example.com/script.php?namespace=...）から名前空間URIを取得します。これはJavaScriptのlocation.searchがURLのクエリ文字列を扱うのと同様に、PHPでは$_GETスーパーグローバル変数で実現されます。

取得した名前空間URIをlookupPrefixメソッドに渡し、結果として得られたプレフィックス、またはnullに応じて適切なメッセージを表示します。これにより、XMLドキュメント内の名前空間とプレフィックスのマッピングを動的に確認する方法が示されます。