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

Copy
1<?php
2
3// このサンプルコードは、PHPのDOM拡張機能を使用してXML文書を操作し、
4// Dom\Text::lookupPrefix メソッドの動作を示すものです。
5// Dom\Text::lookupPrefix は、指定された名前空間URIに対応するXMLプレフィックスを検索します。
6
7// 1. 新しい DOMDocument インスタンスを作成します。
8$dom = new DOMDocument('1.0', 'UTF-8');
9$dom->formatOutput = true; // XML出力を見やすく整形します。
10
11// 2. ルート要素を作成し、名前空間を定義します。
12//    ここでは 'doc' というプレフィックスで 'http://example.com/document' 名前空間を宣言しています。
13$rootElement = $dom->createElementNS('http://example.com/document', 'doc:root');
14// ルート要素に名前空間の宣言を追加します。
15// 'xmlns:data' は 'http://example.com/data' に関連付けられます。
16$rootElement->setAttributeNS(
17    'http://www.w3.org/2000/xmlns/', // xmlns属性の名前空間URI
18    'xmlns:data',                    // 属性名 (xmlns:プレフィックス)
19    'http://example.com/data'        // 名前空間URI
20);
21$dom->appendChild($rootElement);
22
23// 3. 名前空間を持つ子要素を作成し、ルート要素に追加します。
24//    'data:item' という要素名は、'data' プレフィックスとURIが紐付けられていることを示します。
25$childElement = $dom->createElementNS('http://example.com/data', 'data:item');
26$rootElement->appendChild($childElement);
27
28// 4. テキストノードを作成し、子要素に追加します。
29//    Dom\Text::lookupPrefix メソッドはこのテキストノードに対して呼び出されます。
30$textNode = $dom->createTextNode('これはDOMテキストノードのコンテンツです。');
31$childElement->appendChild($textNode);
32
33echo "--- 生成されたXMLドキュメント ---\n";
34echo $dom->saveXML(); // 生成されたXMLドキュメントを表示します。
35echo "-------------------------------\n\n";
36
37// 5. Dom\Text::lookupPrefix を使用して、指定された名前空間URIに対応するプレフィックスを検索します。
38//    検索はテキストノードのコンテキスト（親要素から継承される名前空間情報）から行われます。
39
40// 検索したい名前空間URI。
41$targetNamespaceUri = 'http://example.com/data';
42
43// テキストノードからプレフィックスを検索します。
44// 見つかればstring、見つからなければnullが返ります。
45$prefix = $textNode->lookupPrefix($targetNamespaceUri);
46
47if ($prefix !== null) {
48    echo "名前空間URI '{$targetNamespaceUri}' に対応するプレフィックスが見つかりました: '{$prefix}'\n";
49} else {
50    echo "エラー: 名前空間URI '{$targetNamespaceUri}' に対応するプレフィックスが見つかりませんでした。\n";
51}
52
53echo "\n--- 別の名前空間URIで試す (見つからない場合) ---\n";
54$nonExistentNamespaceUri = 'http://example.com/nonexistent';
55
56$prefixNotFound = $textNode->lookupPrefix($nonExistentNamespaceUri);
57
58if ($prefixNotFound !== null) {
59    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックスが見つかりました: '{$prefixNotFound}'\n";
60} else {
61    echo "名前空間URI '{$nonExistentNamespaceUri}' に対応するプレフィックスは見つかりませんでした (期待される結果)。\n";
62}
63
64?>

このサンプルコードは、PHPのDOM拡張機能を用いてXML文書を操作し、Dom\Textクラスに属するlookupPrefixメソッドの動作を解説します。このメソッドは、XML文書中の特定の名前空間URIに対応するプレフィックスを検索する際に活用されます。

Dom\Text::lookupPrefixメソッドは、現在のテキストノードを基準として、そのノードが属するコンテキスト（親要素や祖先要素で定義された名前空間宣言）をたどり、引数string $namespaceで指定された名前空間URIに紐づくプレフィックスを探します。検索が成功し、対応するプレフィックスが見つかった場合は、そのプレフィックスを示す文字列が戻り値として返されます。もし見つからなかった場合はnullが戻り値として返されます。

サンプルコードでは、まずDOMDocumentを生成し、http://example.com/documentをdocプレフィックスに、http://example.com/dataをdataプレフィックスに関連付けたXML構造を構築しています。このXML文書内のテキストノードに対してlookupPrefix('http://example.com/data')を実行すると、親要素で定義されているdataというプレフィックスが正確に取得できることを示しています。また、存在しない名前空間URIを指定した場合にはnullが返されることも確認でき、このメソッドがXMLの名前空間情報を適切に解決する仕組みを理解できます。この機能は、XML文書の内容を動的に解析したり、名前空間を考慮して要素を生成したりする際に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Text::lookupPrefix メソッドの使用例。
5 *
6 * この関数は、指定された名前空間URIに対応するプレフィックスを、
7 * Dom\Textノードのコンテキストで検索する方法を示します。
8 *
9 * キーワード「php location.search」を考慮し、検索対象の名前空間URIを
10 * URLのクエリパラメータ（$_GET）から取得するシナリオを組み込んでいます。
11 * (例: http://localhost/script.php?target_ns=http://example.com/ns1)
12 */
13function demonstrateDomTextLookupPrefixWithUrlParam(): void
14{
15    // 1. URLクエリパラメータから名前空間URIを取得
16    // JavaScriptのlocation.search（URLの?以降の部分）をPHPで扱う場合は、
17    // $_GET スーパーグローバル変数を使用します。
18    // 例として、`script.php?target_ns=http://example.com/ns1` のようにアクセスした場合、
19    // `target_ns` の値が取得されます。
20    // パラメータが指定されていない場合は、デフォルトの名前空間URIを使用します。
21    $targetNamespaceUri = $_GET['target_ns'] ?? 'http://example.com/ns1';
22    echo "検索対象の名前空間URI (URLパラメータ 'target_ns' から取得): " . htmlspecialchars($targetNamespaceUri) . PHP_EOL . PHP_EOL;
23
24    // 2. 名前空間を含むXMLドキュメントの文字列を定義
25    // ここでは、`ns1` と `ns2` というプレフィックスを持つ名前空間を定義しています。
26    $xmlString = <<<XML
27<?xml version="1.0" encoding="UTF-8"?>
28<root xmlns:ns1="http://example.com/ns1" xmlns:ns2="http://example.com/ns2">
29    <ns1:element1>テキスト1</ns1:element1>
30    <ns2:element2>テキスト2</ns2:element2>
31    <element3>名前空間なし</element3>
32</root>
33XML;
34
35    // 3. DOMDocumentを作成し、XMLを読み込む
36    $dom = new DOMDocument();
37    $dom->loadXML($xmlString);
38
39    // 4. 特定の要素（ここでは <ns1:element1>）とそのテキストノードを取得
40    // Dom\Text::lookupPrefix は Dom\Text オブジェクトのメソッドですが、
41    // テキストノード自体に名前空間は直接関連付けられていません。
42    // 通常は、親要素の名前空間をコンテキストとしてプレフィックスが検索されます。
43    $element = $dom->getElementsByTagNameNS('http://example.com/ns1', 'element1')->item(0);
44
45    if ($element && $element->firstChild instanceof Dom\Text) {
46        $textNode = $element->firstChild;
47
48        echo "対象のテキストノードのコンテンツ: " . htmlspecialchars($textNode->textContent) . PHP_EOL;
49
50        // 5. Dom\Text::lookupPrefix を使用してプレフィックスを検索
51        // URLパラメータから取得した名前空間URIを引数に渡します。
52        $prefix = $textNode->lookupPrefix($targetNamespaceUri);
53
54        if ($prefix !== null) {
55            echo "名前空間URI '" . htmlspecialchars($targetNamespaceUri) . "' に対応するプレフィックス: " . htmlspecialchars($prefix) . PHP_EOL;
56        } else {
57            echo "名前空間URI '" . htmlspecialchars($targetNamespaceUri) . "' に対応するプレフィックスは見つかりませんでした。" . PHP_EOL;
58        }
59
60        echo PHP_EOL . "--- 別の名前空間URIで試行 ---" . PHP_EOL;
61        // 現在のコンテキスト（<ns1:element1>のテキストノード）では存在しない名前空間URIで検索を試みます。
62        $anotherNamespaceUri = 'http://example.com/ns2';
63        echo "検索対象の名前空間URI: " . htmlspecialchars($anotherNamespaceUri) . PHP_EOL;
64        $anotherPrefix = $textNode->lookupPrefix($anotherNamespaceUri);
65        if ($anotherPrefix !== null) {
66            echo "見つかったプレフィックス: " . htmlspecialchars($anotherPrefix) . PHP_EOL;
67        } else {
68            echo "指定された名前空間URIに対応するプレフィックスは見つかりませんでした。" . PHP_EOL;
69        }
70
71    } else {
72        echo "指定された要素またはテキストノードが見つかりませんでした。XML構造を確認してください。" . PHP_EOL;
73    }
74}
75
76// 関数を実行
77demonstrateDomTextLookupPrefixWithUrlParam();
78
79?>

PHP 8のDom\Text::lookupPrefixメソッドは、XMLドキュメント内で特定の名前空間URIに対応するプレフィックスを検索する際に使用されます。XMLにおいて、名前空間URIは要素や属性の集合を一意に識別するためのもので、プレフィックスはそのURIに紐付けられた短い別名です。

このメソッドは、string $namespaceという引数を受け取ります。これは検索したい名前空間のURIを指定するものです。戻り値は?string型で、指定された名前空間URIに対応するプレフィックスが見つかった場合はその文字列を返します。対応するプレフィックスが存在しない場合はnullを返します。検索は、メソッドを呼び出したDom\Textノードが属するXMLドキュメントのコンテキストで行われます。

サンプルコードでは、まずURLのクエリパラメータから検索対象の名前空間URIを取得しています。JavaScriptのlocation.searchがURLのクエリ部分を扱うように、PHPでは$_GETスーパーグローバル変数を使用することで、script.php?target_ns=...のような形式で渡された値を取得できます。その後、名前空間を持つXMLドキュメントを読み込み、特定の要素のテキストノードを取得します。このテキストノードのコンテキストでlookupPrefixメソッドを呼び出し、URLパラメータで指定された名前空間URIに対するプレフィックスを検索し、その結果を出力しています。これにより、XMLの名前空間とプレフィックスの関係性を動的に確認する方法を学ぶことができます。