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

Copy
1<?php
2
3/**
4 * DOMCharacterData::lookupPrefix メソッドの使用例を示します。
5 * DOMCharacterData は、テキストノード、コメントノード、CDATAセクションノードなどの基底クラスです。
6 * lookupPrefix メソッドは、指定された名前空間URIに対応するプレフィックスを、
7 * 現在のノードのスコープ内で検索します。親要素で定義された名前空間プレフィックスを継承して見つけることができます。
8 */
9function demonstrateDomCharacterDataLookupPrefix(): void
10{
11    // 1. DOMDocument オブジェクトを作成します。
12    $dom = new DOMDocument();
13    // 出力を整形するための設定
14    $dom->preserveWhiteSpace = false;
15    $dom->formatOutput = true;
16
17    // 2. 名前空間を含むXML文字列をロードします。
18    //    'ns' プレフィックスが 'http://example.com/namespace' にマップされています。
19    $xmlString = <<<XML
20<root xmlns:ns="http://example.com/namespace">
21    <ns:element>
22        これは名前空間を持つ要素内のテキストです。
23    </ns:element>
24    <otherElement>
25        これは名前空間を持たない要素内のテキストです。
26    </otherElement>
27</root>
28XML;
29    $dom->loadXML($xmlString);
30
31    // 3. 検索対象の名前空間URIを定義します。
32    $targetNamespaceURI = 'http://example.com/namespace';
33
34    // 4. 名前空間を持つ要素 (<ns:element>) 内のテキストノードを取得し、lookupPrefix を呼び出します。
35    //    DOMText は DOMCharacterData を継承しています。
36    $elements = $dom->getElementsByTagNameNS($targetNamespaceURI, 'element');
37    if ($elements->length > 0) {
38        $nsElement = $elements->item(0);
39        // テキストノードは要素の最初の子ノードとして存在します。
40        $textNodeInNsElement = $nsElement->firstChild; 
41
42        // 取得したノードが DOMCharacterData のインスタンスであることを確認
43        if ($textNodeInNsElement instanceof DOMCharacterData) {
44            echo "--- 名前空間を持つ親要素内のテキストノード ---" . PHP_EOL;
45            echo "ノードの種類: " . get_class($textNodeInNsElement) . PHP_EOL;
46            echo "ノードの値: '" . $textNodeInNsElement->nodeValue . "'" . PHP_EOL;
47            
48            // lookupPrefix を呼び出します。親要素から名前空間プレフィックス 'ns' を見つけられるはずです。
49            $prefix = $textNodeInNsElement->lookupPrefix($targetNamespaceURI);
50            echo "URI '{$targetNamespaceURI}' に対するプレフィックス: " . ($prefix ?? 'null') . PHP_EOL . PHP_EOL;
51        }
52    }
53
54    // 5. 名前空間を持たない要素 (<otherElement>) 内のテキストノードを取得し、lookupPrefix を呼び出します。
55    $otherElements = $dom->getElementsByTagName('otherElement');
56    if ($otherElements->length > 0) {
57        $otherElement = $otherElements->item(0);
58        $textNodeInOtherElement = $otherElement->firstChild;
59
60        // 取得したノードが DOMCharacterData のインスタンスであることを確認
61        if ($textNodeInOtherElement instanceof DOMCharacterData) {
62            echo "--- 名前空間を持たない親要素内のテキストノード ---" . PHP_EOL;
63            echo "ノードの種類: " . get_class($textNodeInOtherElement) . PHP_EOL;
64            echo "ノードの値: '" . $textNodeInOtherElement->nodeValue . "'" . PHP_EOL;
65
66            // このスコープでは、指定されたURIに対するプレフィックスは定義されていないため 'null' が返されます。
67            $prefix = $textNodeInOtherElement->lookupPrefix($targetNamespaceURI);
68            echo "URI '{$targetNamespaceURI}' に対するプレフィックス: " . ($prefix ?? 'null') . PHP_EOL . PHP_EOL;
69        }
70    }
71}
72
73// 関数を実行します。
74demonstrateDomCharacterDataLookupPrefix();
75

PHP 8のDOMCharacterData::lookupPrefixメソッドは、XMLやHTMLドキュメントを扱う際に、特定の名前空間URIがどのプレフィックスで使われているかを調べるために利用されます。DOMCharacterDataはテキストノード、コメントノード、CDATAセクションノードといった文字データを扱うノードの基底クラスです。このメソッドは引数string $namespaceとして検索したい名前空間URIを受け取り、現在のノードから親を辿り、指定されたURIに対応するプレフィックスが見つかればstringでそれを返し、見つからなければnullを返します。

サンプルコードでは、名前空間http://example.com/namespaceにプレフィックスnsを割り当てたXMLをロードしています。まず、ns:element要素内のテキストノードに対してlookupPrefixを呼び出す例です。このテキストノードはDOMCharacterDataを継承しており、親要素であるns:elementでnsプレフィックスが定義されているため、lookupPrefix('http://example.com/namespace')はnsを返します。これは、ノード自身ではなく、その親要素のスコープで定義されたプレフィックスも見つけられることを示しています。次に、名前空間を持たないotherElement要素内のテキストノードで同じ検索を行うと、そのスコープでは指定のURIに対するプレフィックスが定義されていないため、nullが返されます。このメソッドは、動的にXML構造を処理する際に名前空間の解決に役立ちます。

Copy
1<?php
2
3/**
4 * DOM要素の名前空間URIからプレフィックスを検索するサンプル関数です。
5 *
6 * この関数は、XML要素を作成し、Webリクエストのクエリパラメータ
7 * (JavaScriptの `location.search` に相当するPHPの `$_GET`)
8 * から取得した名前空間URIを引数として `DOMNode::lookupPrefix` メソッドを呼び出します。
9 *
10 * `DOMCharacterData::lookupPrefix` は、`DOMNode` インターフェースから継承されたメソッドであり、
11 * 特定の名前空間URIが現在のノードのスコープ内でどのプレフィックスに対応するかを調べます。
12 * 通常、名前空間は `DOMElement` (DOMCharacterDataも継承するDOMNodeの一種) のような要素ノードに定義されるため、
13 * ここでは `DOMElement` を使用してその動作を示します。
14 *
15 * @param string|null $queryNamespace クエリパラメータとして渡される名前空間URI。
16 *                                    省略された場合はデフォルト値が使用されます。
17 * @return void
18 */
19function demonstrateLookupPrefix(?string $queryNamespace = null): void
20{
21    // DOMDocumentオブジェクトを生成します。XML文書を扱うための基盤です。
22    $dom = new DOMDocument('1.0', 'UTF-8');
23    $dom->preserveWhiteSpace = false; // 空白ノードを保持しない
24    $dom->formatOutput = true;       // 出力XMLを見やすく整形します
25
26    // 名前空間URIとプレフィックスを指定してルート要素を作成します。
27    // ここで 'data' というプレフィックスを 'http://example.com/ns/data' という
28    // 名前空間URIに関連付けています。
29    $rootNamespaceUri = 'http://example.com/ns/data';
30    $rootPrefix = 'data';
31    $root = $dom->createElementNS($rootNamespaceUri, $rootPrefix . ':root');
32    $dom->appendChild($root);
33
34    // 別の名前空間を持つ子要素を追加することもできます
35    // $childNamespaceUri = 'http://example.com/ns/config';
36    // $childPrefix = 'conf';
37    // $child = $dom->createElementNS($childNamespaceUri, $childPrefix . ':setting');
38    // $root->appendChild($child);
39
40    echo "--- 生成されたXML文書 ---\n";
41    echo $dom->saveXML();
42    echo "\n";
43
44    // Webリクエストのクエリパラメータ 'namespace' から名前空間URIを取得します。
45    // 例: http://localhost/your_script.php?namespace=http://example.com/ns/data
46    // PHPの $_GET は、JavaScriptの location.search からパースされた値に相当します。
47    // 関数引数が指定されていればそれを使用し、なければ $_GET を参照します。
48    $searchNamespace = $queryNamespace ?? ($_GET['namespace'] ?? null);
49
50    // クエリパラメータが指定されていない場合は、デフォルトでルート要素の名前空間URIを使用します。
51    if ($searchNamespace === null) {
52        $searchNamespace = $rootNamespaceUri;
53        echo "--- クエリパラメータ 'namespace' が指定されなかったため、デフォルトの名前空間URIを使用します ---\n";
54    }
55
56    echo "--- 名前空間プレフィックスの検索 ---\n";
57    echo "検索対象の名前空間URI: " . htmlspecialchars($searchNamespace) . "\n";
58
59    // DOMCharacterData::lookupPrefix は DOMNode から継承されたメソッドです。
60    // ここではルート要素 ($root は DOMElement であり、DOMNode を継承しています)
61    // に対して呼び出しています。
62    // 指定された名前空間URIに対応するプレフィックスを検索します。
63    $prefix = $root->lookupPrefix($searchNamespace);
64
65    if ($prefix !== null) {
66        echo "見つかったプレフィックス: '" . htmlspecialchars($prefix) . "'\n";
67    } else {
68        echo "指定された名前空間URI '" . htmlspecialchars($searchNamespace) . "' に対応するプレフィックスは見つかりませんでした。\n";
69    }
70
71    echo "\n";
72
73    // 存在しない名前空間URIを試して、プレフィックスが見つからないケースを示します。
74    $nonExistentNamespace = 'http://example.com/nonexistent/ns';
75    echo "--- 存在しない名前空間URIの検索 ---\n";
76    echo "検索対象の名前空間URI: " . htmlspecialchars($nonExistentNamespace) . "\n";
77    $nonExistentPrefix = $root->lookupPrefix($nonExistentNamespace);
78    if ($nonExistentPrefix !== null) {
79        echo "見つかったプレフィックス: '" . htmlspecialchars($nonExistentPrefix) . "'\n";
80    } else {
81        echo "指定された名前空間URI '" . htmlspecialchars($nonExistentNamespace) . "' に対応するプレフィックスは見つかりませんでした。\n";
82    }
83}
84
85// スクリプトが直接実行された場合にデモンストレーション関数を呼び出します。
86//
87// 実行方法:
88// 1. コマンドラインから実行:
89//    php your_script.php
90//    php your_script.php "http://example.com/ns/data"
91//
92// 2. ブラウザからアクセス (WebサーバーでPHPが動作している場合):
93//    http://localhost/your_script.php
94//    http://localhost/your_script.php?namespace=http://example.com/ns/data
95//    http://localhost/your_script.php?namespace=http://example.com/nonexistent/ns
96//
97demonstrateLookupPrefix($argv[1] ?? null);

PHPのDOMCharacterData::lookupPrefixメソッドは、XML文書のDOMツリー内で、特定のノードのスコープにおいて、指定された名前空間URIに対応するプレフィックスを検索します。このメソッドはDOMNodeインターフェースから継承されており、主にDOMElementのような要素ノードに対して使用されることで、XMLの名前空間管理に役立ちます。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、createElementNSメソッドを使ってdata:rootという要素を作成しています。この要素ではhttp://example.com/ns/dataという名前空間URIをdataというプレフィックスに関連付けています。その後、このルート要素に対してlookupPrefixメソッドを呼び出しています。

引数string $namespaceには、検索したい名前空間URIを指定します。サンプルコードでは、Webリクエストのクエリパラメータnamespaceからこの値を取得しており、これはJavaScriptのlocation.searchで得られる情報に相当し、PHPでは$_GET変数で参照できます。

メソッドの戻り値はstring|null型です。指定された名前空間URIに対応するプレフィックスがノードのスコープ内で見つかった場合はそのプレフィックス文字列を、見つからなかった場合はnullを返します。この機能は、XML文書をプログラムで操作する際に、名前空間URIからその省略形であるプレフィックスを動的に特定し、名前空間の整合性を確認する場面で特に有用です。