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

Copy
1<?php
2
3// XML文書を文字列として定義します。
4// ここでは 'myns' というプレフィックスが 'http://example.com/myns' という名前空間URIに
5// 関連付けられています。
6$xmlString = <<<EOT
7<root xmlns:myns="http://example.com/myns">
8    <myns:element>これはテキストノードのコンテンツです。</myns:element>
9</root>
10EOT;
11
12// DOMDocumentオブジェクトを作成し、XML文字列をロードします。
13$dom = new DOMDocument();
14$dom->loadXML($xmlString);
15
16// DOMTextノードを見つけます。
17// 上記XMLでは、<myns:element>タグの子ノードがテキストノードになります。
18$elements = $dom->getElementsByTagName('element');
19$textNode = null;
20
21// <myns:element>に該当する要素を探します。
22foreach ($elements as $element) {
23    if ($element->namespaceURI === 'http://example.com/myns') {
24        // その要素の最初の子ノードがDOMTextインスタンスであることを確認します。
25        if ($element->firstChild instanceof DOMText) {
26            $textNode = $element->firstChild;
27            break;
28        }
29    }
30}
31
32if ($textNode) {
33    echo "DOMTextノードのコンテンツ: '" . $textNode->nodeValue . "'\n";
34
35    // lookupPrefixメソッドを使用して、指定された名前空間URIに対応するプレフィックスを検索します。
36    // XMLで定義した名前空間URIを指定します。
37    $namespaceUriToLookup = 'http://example.com/myns';
38    $prefix = $textNode->lookupPrefix($namespaceUriToLookup);
39
40    if ($prefix !== null) {
41        echo "名前空間URI '{$namespaceUriToLookup}' に対応するプレフィックスは '{$prefix}' です。\n";
42    } else {
43        echo "名前空間URI '{$namespaceUriToLookup}' に対応するプレフィックスは見つかりませんでした。\n";
44    }
45
46    echo "\n";
47
48    // 存在しない名前空間URIを検索する例
49    $nonExistentNamespaceUri = 'http://example.com/nonexistent';
50    $prefixNonExistent = $textNode->lookupPrefix($nonExistentNamespaceUri);
51    if ($prefixNonExistent === null) {
52        echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックスは見つかりませんでした。(期待通りの結果)\n";
53    }
54} else {
55    echo "XMLドキュメントからDOMTextノードが見つかりませんでした。\n";
56}
57

DOMText::lookupPrefixメソッドは、XML文書内で特定の名前空間URIに対応するプレフィックスを検索するために使用されます。XMLにおいて、名前空間は要素や属性の定義元を示すURIで、プレフィックスはそのURIを短く参照するための別名です。このメソッドは、指定された名前空間URIに対して、そのURIと関連付けられたプレフィックスを取得する役割を持ちます。

サンプルコードでは、まずXML文字列を定義し、それをPHPのDOMDocumentオブジェクトにロードしています。このXML文字列には、mynsというプレフィックスがhttp://example.com/mynsという名前空間URIに関連付けられた要素が含まれています。次に、このXMLから<myns:element>タグ内のテキストコンテンツを表すDOMTextノードを取得します。

取得したDOMTextノードに対してlookupPrefixメソッドを呼び出します。引数には検索したい名前空間URI（例: 'http://example.com/myns'）を文字列で渡します。メソッドは、指定された名前空間URIに合致するプレフィックスがXML文書内で見つかれば、そのプレフィックス名（例: 'myns'）を文字列で返します。もし対応するプレフィックスが見つからない場合はnullが返されます。

サンプルでは、実際に定義された名前空間URIを検索して正しいプレフィックスが取得できること、そして存在しない名前空間URIを検索した場合にはnullが返されることを示しています。これにより、XML文書構造における名前空間とプレフィックスの関係性を動的にプログラムで確認する方法を理解できます。

Copy
1<?php
2
3/**
4 * このスクリプトは、URLのクエリパラメータから名前空間URIを取得し、
5 * XMLドキュメント内のDOMTextノードがそのURIに対応するプレフィックスを
6 * 見つけられるかを示すサンプルです。
7 *
8 * PHPで `location.search` に相当する機能（URLクエリパラメータの処理）と、
9 * `DOMText::lookupPrefix` の使い方を組み合わせています。
10 *
11 * 実行例:
12 * - プレフィックスが見つかる場合: http://localhost/your_script.php?ns_uri=http://www.example.com/ns
13 * - プレフィックスが見つからない場合: http://localhost/your_script.php?ns_uri=http://www.another.com/ns
14 */
15
16// URLクエリから名前空間URIを取得（php location.search に相当する処理）
17// $_GET['ns_uri'] が存在しない場合は、デフォルトでXMLドキュメント内に存在しないURIを使用し、
18// プレフィックスが見つからないケースも示せるようにします。
19$searchNamespaceUri = $_GET['ns_uri'] ?? 'http://www.another.com/ns';
20
21// 新しいDOMDocumentを作成
22$dom = new DOMDocument('1.0', 'UTF-8');
23$dom->formatOutput = true; // 出力整形を有効に
24
25// XMLドキュメントを文字列で定義
26// ここでは 'ex' というプレフィックスを 'http://www.example.com/ns' にバインドしています。
27$xmlString = <<<XML
28<root xmlns:ex="http://www.example.com/ns">
29    <plainElement>
30        これは名前空間を持たない要素内のテキストノードです。
31    </plainElement>
32    <ex:namespacedElement>
33        これは 'ex' 名前空間内の要素にあるテキストノードです。
34    </ex:namespacedElement>
35</root>
36XML;
37
38// DOMDocumentにXML文字列をロード
39$dom->loadXML($xmlString);
40
41// ターゲットとなるDOMTextノードを見つける
42// ここでは <ex:namespacedElement> 内のテキストノードを対象とします。
43$targetTextNode = null;
44$elements = $dom->getElementsByTagNameNS('http://www.example.com/ns', 'namespacedElement');
45if ($elements->length > 0) {
46    $elementInNamespace = $elements->item(0);
47    if ($elementInNamespace->hasChildNodes()) {
48        foreach ($elementInNamespace->childNodes as $node) {
49            if ($node instanceof DOMText) {
50                $targetTextNode = $node;
51                break;
52            }
53        }
54    }
55}
56
57// HTML形式で結果を出力
58echo "<h1>DOMText::lookupPrefix のサンプル</h1>";
59echo "<p>現在のURLクエリから取得した名前空間URI (検索対象): <code>" . htmlspecialchars($searchNamespaceUri) . "</code></p>";
60echo "<hr>";
61
62if ($targetTextNode) {
63    echo "<h2>検索対象のテキストノードとその親要素:</h2>";
64    // 親要素を含めてXMLスニペットを出力
65    echo "<pre>" . htmlspecialchars($targetTextNode->parentNode->ownerDocument->saveXML($targetTextNode->parentNode)) . "</pre>";
66
67    // DOMText::lookupPrefix を使用してプレフィックスを検索
68    // DOMTextノードのスコープ（この場合、親要素である <ex:namespacedElement>）で、
69    // 指定された名前空間URIに対応するプレフィックスを探します。
70    $foundPrefix = $targetTextNode->lookupPrefix($searchNamespaceUri);
71
72    echo "<h2>検索結果:</h2>";
73    if ($foundPrefix !== null) {
74        echo "<p>名前空間URI <code>" . htmlspecialchars($searchNamespaceUri) . "</code> に対応するプレフィックスは <code><strong>" . htmlspecialchars($foundPrefix) . "</strong></code> です。</p>";
75        echo "<p>これは、XMLドキュメント内でプレフィックス <code>ex</code> がこのURI (<code>http://www.example.com/ns</code>) に対応しているためです。</p>";
76    } else {
77        echo "<p>名前空間URI <code>" . htmlspecialchars($searchNamespaceUri) . "</code> に対応するプレフィックスは見つかりませんでした。</p>";
78        echo "<p>これは、XMLドキュメントのこのスコープ内で、指定されたURIに対応するプレフィックスが定義されていないためです。</p>";
79    }
80} else {
81    echo "<p>ターゲットとなるDOMTextノードが見つかりませんでした。</p>";
82}
83
84echo "<hr>";
85echo "<h2>生成されたXMLドキュメント全体:</h2>";
86echo "<pre>" . htmlspecialchars($dom->saveXML()) . "</pre>";
87
88?>

このPHPサンプルコードは、DOMTextクラスのlookupPrefixメソッドと、URLクエリパラメータの処理方法を組み合わせて説明しています。DOMText::lookupPrefixは、XMLドキュメント内の特定のテキストノードのスコープ（親要素など）において、引数string $namespaceで指定された名前空間URIに対応するプレフィックスを検索するメソッドです。

このメソッドは、指定された名前空間URIに対応するプレフィックスが見つかった場合はそのプレフィックス名を文字列として返します。もし見つからなかった場合はnullを返します。

コードの流れとしては、まずPHPのスーパーグローバル変数$_GETを使用して、URLのクエリパラメータns_uriから検索対象の名前空間URIを取得します。これは、JavaScriptのlocation.searchでURLパラメータを取得するのと同様の役割を果たします。次に、DOMDocumentオブジェクトを生成し、xmlns:ex="http://www.example.com/ns"のように、プレフィックスexと名前空間URIを関連付けたXML文字列をロードします。

その後、特定の要素内のテキストノードをターゲットとして取得し、そのDOMTextノードに対してlookupPrefixメソッドを呼び出しています。実行例として、URLに?ns_uri=http://www.example.com/nsを指定すると、XML内で定義されたプレフィックスexが見つかり、?ns_uri=http://www.another.com/nsのような未定義のURIを指定するとnullが返される挙動を確認できます。これにより、XMLの名前空間とプレフィックスの解決メカニズムが理解できるようになっています。