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

Copy
1<?php
2
3// Dom\Node::lookupPrefix メソッドの使用例
4// このメソッドは、指定された名前空間URIに対応するXMLプレフィックスを検索します。
5// システムエンジニアを目指す初心者の方へ: XMLの名前空間は、異なるXML語彙の要素や属性が混在する際に、
6// それらを区別するために使用されます。プレフィックスはその名前空間を短く参照するためのエイリアスです。
7
8// 1. 新しいDOMドキュメントを作成します。
9$dom = new Dom\Document('1.0', 'UTF-8');
10$dom->formatOutput = true; // 出力時に整形されるように設定
11
12// 2. 名前空間URIとプレフィックスを定義します。
13$namespaceUri = 'http://www.example.com/my-namespace';
14$prefix = 'myns';
15$anotherNamespaceUri = 'http://www.example.com/another-namespace';
16$anotherPrefix = 'other';
17
18// 3. ルート要素を作成し、名前空間を定義します。
19// createElementNS() を使用して、名前空間付きの要素を作成します。
20// 第1引数: 名前空間URI
21// 第2引数: 要素の完全修飾名 (プレフィックス:ローカル名)
22$root = $dom->createElementNS($namespaceUri, $prefix . ':root');
23$dom->appendChild($root);
24
25// 4. ルート要素に子要素を追加します。これも同じ名前空間を使います。
26$item = $dom->createElementNS($namespaceUri, $prefix . ':item', 'Hello, Namespace!');
27$root->appendChild($item);
28
29// 5. 別の名前空間を持つ要素も追加してみましょう。
30$anotherItem = $dom->createElementNS($anotherNamespaceUri, $anotherPrefix . ':data', 'Additional Data');
31$root->appendChild($anotherItem);
32
33// ドキュメントの内容を確認（オプション）
34// echo $dom->saveXML();
35
36echo "--- Dom\\Node::lookupPrefix の使用例 ---\n";
37
38// 6. 作成したノード（ここでは $item 要素）から lookupPrefix メソッドを呼び出し、
39//    特定の名前空間URIに対応するプレフィックスを検索します。
40//    lookupPrefixは、そのノードのスコープ内で有効なプレフィックスを検索します。
41$foundPrefixForItemNamespace = $item->lookupPrefix($namespaceUri);
42
43if ($foundPrefixForItemNamespace !== null) {
44    echo "名前空間URI '{$namespaceUri}' に対応するプレフィックスは '{$foundPrefixForItemNamespace}' です。\n";
45} else {
46    echo "名前空間URI '{$namespaceUri}' に対応するプレフィックスは見つかりませんでした。\n";
47}
48
49// 7. 別の名前空間URIで検索します。
50$foundPrefixForAnotherNamespace = $root->lookupPrefix($anotherNamespaceUri);
51
52if ($foundPrefixForAnotherNamespace !== null) {
53    echo "名前空間URI '{$anotherNamespaceUri}' に対応するプレフィックスは '{$foundPrefixForAnotherNamespace}' です。\n";
54} else {
55    echo "名前空間URI '{$anotherNamespaceUri}' に対応するプレフィックスは見つかりませんでした。\n";
56}
57
58// 8. 存在しない名前空間URIを検索した場合
59$nonExistentNamespaceUri = 'http://www.example.com/non-existent-namespace';
60$foundNonExistentPrefix = $item->lookupPrefix($nonExistentNamespaceUri);
61
62if ($foundNonExistentPrefix !== null) {
63    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックスは '{$foundNonExistentPrefix}' です。\n";
64} else {
65    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックスは見つかりませんでした。\n";
66}
67
68?>

PHPのDom\Node::lookupPrefixメソッドは、XMLドキュメント内で指定された名前空間URIに対応するプレフィックスを検索するために使用されます。XMLの名前空間は、異なる語彙を持つ要素や属性が混在する際に、それらを一意に識別するための仕組みで、プレフィックスはその名前空間URIを短く参照するための別名です。

このメソッドは、string $namespaceという引数で検索したい名前空間URIを受け取ります。そして、メソッドが呼び出されたDom\Nodeオブジェクト、つまり現在のXML要素のスコープ内で、その名前空間URIに割り当てられているプレフィックスを探します。

検索に成功した場合、対応するプレフィックスを文字列として返します。もし指定された名前空間URIに対応するプレフィックスが見つからない場合や、そもそもその名前空間がノードのスコープ内で定義されていない場合は、戻り値としてnullが返されます。

提供されたサンプルコードでは、まずDom\Documentを使ってXML構造を作成し、createElementNSメソッドで名前空間とプレフィックスを定義した要素を追加しています。その後、作成した要素からlookupPrefixメソッドを呼び出し、定義済みの名前空間URIに対しては正しいプレフィックスが返され、存在しない名前空間URIに対してはnullが返される様子が示されています。これにより、XML文書内の名前空間とプレフィックスの関係性を動的に確認できます。

Copy
1<?php
2
3/**
4 * URLのクエリ文字列 (location.search に相当) から名前空間URIを取得し、
5 * DOMドキュメント内で対応するプレフィックスを検索するサンプルコードです。
6 * Dom\Node::lookupPrefix メソッドの使用例を示します。
7 */
8function demonstrateDomNamespaceLookup(): void
9{
10    // 名前空間を持つサンプルXML文字列を定義
11    // ここでは 'prod' と 'cust' というプレフィックスを定義しています。
12    $xmlString = <<<XML
13<root xmlns:prod="http://example.com/products" xmlns:cust="http://example.com/customers">
14    <prod:item id="1">Product A</prod:item>
15    <cust:client id="C1">Customer X</cust:client>
16</root>
17XML;
18
19    // DOMDocumentオブジェクトを作成し、XMLをロード
20    $dom = new DOMDocument();
21    $dom->loadXML($xmlString);
22
23    // ルート要素を取得します。Dom\ElementクラスはDom\Nodeクラスを継承しています。
24    $rootElement = $dom->documentElement;
25
26    // URLのクエリ文字列から 'ns_uri' パラメータを取得します。
27    // 例: スクリプトに ?ns_uri=http://example.com/products のようにアクセス
28    // これはJavaScriptの location.search からパラメータを解析する動作に相当します。
29    $namespaceUriToSearch = $_GET['ns_uri'] ?? null;
30
31    if ($rootElement instanceof Dom\Node) {
32        if ($namespaceUriToSearch) {
33            echo "<h3>URLで指定された名前空間URI: " . htmlspecialchars($namespaceUriToSearch) . "</h3>";
34
35            // Dom\Node::lookupPrefix メソッドを使用して、
36            // 名前空間URIに対応するプレフィックスを検索します。
37            $prefix = $rootElement->lookupPrefix($namespaceUriToSearch);
38
39            if ($prefix !== null) {
40                echo "<p>見つかったプレフィックス: <strong>" . htmlspecialchars($prefix) . "</strong></p>";
41            } else {
42                echo "<p>指定された名前空間URIに対応するプレフィックスは見つかりませんでした。</p>";
43            }
44        } else {
45            echo "<h3>URLのクエリ文字列に 'ns_uri' パラメータが指定されていません。</h3>";
46            echo "<p>例: <code>" . htmlspecialchars($_SERVER['SCRIPT_NAME'] . "?ns_uri=http://example.com/products") . "</code> のようにアクセスしてください。</p>";
47
48            // パラメータがなくても動作確認できるように、固定値で例を示します。
49            echo "<h4>--- 固定値での検索例 ---</h4>";
50            $fixedNamespaceUri = "http://example.com/customers";
51            $fixedPrefix = $rootElement->lookupPrefix($fixedNamespaceUri);
52            echo "<p>名前空間URI '<code>" . htmlspecialchars($fixedNamespaceUri) . "</code>' のプレフィックス: <strong>" . ($fixedPrefix ?? 'なし') . "</strong></p>";
53        }
54    } else {
55        echo "<p>DOMルート要素の取得に失敗しました。</p>";
56    }
57}
58
59// 関数を実行して、DOM名前空間の検索デモンストレーションを開始
60demonstrateDomNamespaceLookup();
61
62?>

PHPのDom\Node::lookupPrefixメソッドは、XMLドキュメント内で指定された名前空間URIに対応するプレフィックスを検索するためのメソッドです。

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

このサンプルコードでは、名前空間を定義したXML文字列からDOMDocumentオブジェクトを作成し、DOM（Document Object Model）として扱えるようにしています。そして、URLのクエリ文字列（$_GET）から「ns_uri」というパラメータ値を取得し、これを検索対象の名前空間URIとして使用します。これは、ウェブブラウザのlocation.searchからURLパラメータを解析する動作に似ています。取得したURIをルート要素（Dom\Nodeの子孫クラス）からlookupPrefixメソッドに渡し、XMLドキュメント内でそのURIに対応するプレフィックスが存在するかどうかを調べ、その結果を表示しています。これにより、動的に名前空間を検索し、対応するプレフィックスを確認する方法を学ぶことができます。また、パラメータが指定されなかった場合の例も示されています。