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

lookupPrefixメソッドは、指定された名前空間URIに対応するプレフィックスを検索し、その文字列を返すメソッドです。このメソッドは、XMLやHTML文書内にあるコメントノードを表すDom\Commentオブジェクトから呼び出します。引数として、検索したい名前空間を一意に識別するためのURIを文字列で渡します。検索処理は、メソッドを呼び出したコメントノード自身から開始されます。もし、そのノードで対応するプレフィックスが見つからない場合は、親要素、さらにその親要素へと、文書の階層をルート要素に向かって順に遡りながら検索を続けます。そして、指定された名前空間URIに合致する定義が最初に見つかったスコープのプレフィックス（接頭辞）を返します。文書のルートまで検索しても該当するプレフィックスが存在しなかった場合には、nullが返されます。このメソッドは、XML文書を動的に解析する際、特定の名前空間がどのプレフィックスで宣言されているかを確認するために役立ちます。

Copy
1<?php
2
3$xmlString = <<<XML
4<root xmlns:ex="http://example.com/ns">
5  <!-- ここはコメントです -->
6</root>
7XML;
8
9$doc = new Dom\Document();
10$doc->loadXML($xmlString);
11
12// Dom\Comment オブジェクトを取得
13$commentNode = $doc->documentElement->firstChild;
14
15// 親のスコープにある名前空間URIからプレフィックスを検索
16$prefix = $commentNode->lookupPrefix('http://example.com/ns');
17
18var_dump($prefix); // string(2) "ex"

string $namespace

• string $namespace: 指定された名前空間のプレフィックスを検索するための名前空間URIを指定します。

?string

名前空間プレフィックスのルックアップを行います。指定されたURIに対応する名前空間プレフィックスが存在すればその文字列を、存在しなければnullを返します。