【PHP8.x】lookupNamespaceURIメソッドの使い方

lookupNamespaceURIメソッドは、PHPのDOMAttrオブジェクトが表す属性に関連付けられた名前空間URI（Uniform Resource Identifier）を特定して取得するメソッドです。XMLドキュメントにおいては、同じ名前の要素や属性が異なる文脈で使われる際に、それらの名前が衝突しないように名前空間という仕組みが用いられます。このメソッドは、特定の属性がどの名前空間に属しているかをプログラムから正確に識別するために利用されます。

具体的には、現在のDOMAttrオブジェクトが持つ属性名や、その属性が所属する要素の祖先要素で宣言されている名前空間の定義をたどり、その属性のプレフィックスに対応する名前空間URIを検索します。属性に直接名前空間プレフィックスが付いていない場合や、デフォルトの名前空間に属している場合でも、DOMツリーを遡って関連する名前空間URIを適切に解決しようとします。

このメソッドは、XMLドキュメントの解析や操作を行う際に、属性の正確な名前空間をプログラムで識別する必要がある場合に特に役立ちます。例えば、特定の名前空間に属する属性のみを抽出し、その属性値に応じて異なる処理を実行するといったシナリオで利用できます。名前空間URIが見つかった場合はそのURIを文字列として返し、見つからなかった場合はnullを返します。これにより、複雑なXML構造の中から目的の属性を正確に識別し、適切な処理を適用することが可能になります。

Copy
1<?php
2// DOMDocumentを作成
3$dom = new DOMDocument('1.0', 'UTF-8');
4$dom->formatOutput = true;
5
6// 名前空間 'http://example.com/mynamespace' を持つ要素 'ns:myElement' を作成
7$element = $dom->createElementNS('http://example.com/mynamespace', 'ns:myElement');
8// 名前空間 'http://example.com/myattribute_ns' を持つ属性 'attr:myAttribute' を追加
9$element->setAttributeNS('http://example.com/myattribute_ns', 'attr:myAttribute', 'someValue');
10$dom->appendChild($element);
11
12// 'attr:myAttribute' の DOMAttr オブジェクトを取得
13$attr = $element->getAttributeNodeNS('http://example.com/myattribute_ns', 'myAttribute');
14
15if ($attr) {
16    // DOMAttr::lookupNamespaceURI メソッドを使用して、属性プレフィックス 'attr' に対応する名前空間URIを検索
17    $namespaceURI = $attr->lookupNamespaceURI('attr');
18
19    // 結果を出力 (見つかればURI文字列、見つからなければ null)
20    echo "Namespace URI for prefix 'attr': " . ($namespaceURI ?? 'null') . "\n";
21
22    // 存在しないプレフィックスを検索した場合の例
23    $nonExistentURI = $attr->lookupNamespaceURI('nonexistent');
24    echo "Namespace URI for prefix 'nonexistent': " . ($nonExistentURI ?? 'null') . "\n";
25}
26?>

?string $prefix

• ?string $prefix: 名前空間のURIを検索する対象となるプレフィックス（接頭辞）を指定します。null の場合はデフォルトの名前空間を検索します。

string|null

指定された要素の要素名空間URI（namespace URI）を文字列として返します。要素が名前空間に属していない場合は、null を返します。