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

Copy
1<?php
2
3// Dom\XMLDocument クラスは PHP 8.1 以降で利用可能です。
4// このサンプルコードは、PHP 8.1 以降の環境で動作することを想定しています。
5
6/**
7 * XMLドキュメントから名前空間URIを検索する例を示します。
8 * 特に、ルート要素のデフォルト名前空間や、特定のプレフィックスの名前空間を扱います。
9 */
10function demonstrateXmlNamespaceLookup(): void
11{
12    // XML 文字列を定義します。
13    // ルート要素には、以下の2つの名前空間が定義されています。
14    // 1. デフォルト名前空間 (xmlns属性のみで、プレフィックスなし)
15    // 2. プレフィックス 'ex' に紐づく名前空間 (xmlns:ex属性)
16    $xmlString = <<<XML
17<root xmlns="http://example.com/default-ns" xmlns:ex="http://example.com/prefix-ns">
18    <ex:item>プレフィックス付きアイテム</ex:item>
19    <anotherItem>デフォルト名前空間のアイテム</anotherItem>
20</root>
21XML;
22
23    try {
24        // Dom\XMLDocument オブジェクトを作成し、XML文字列をロードします。
25        $document = new Dom\XMLDocument();
26        $document->loadXML($xmlString);
27
28        echo "--- 名前空間の検索 ---" . PHP_EOL;
29
30        // 1. デフォルト名前空間 (プレフィックスなし) を検索します。
31        //    'php namespace ルート' の「ルート」は、XMLではルート要素に定義された
32        //    デフォルト名前空間を指すことが多いです。
33        //    lookupNamespaceURIに null を渡すことで、このデフォルト名前空間を取得できます。
34        $defaultNamespaceUri = $document->lookupNamespaceURI(null);
35        echo "1. デフォルト名前空間 (nullプレフィックス): " . ($defaultNamespaceUri ?? "見つかりませんでした") . PHP_EOL;
36
37        // 2. プレフィックス 'ex' に対応する名前空間URIを検索します。
38        //    XML内で 'ex' というプレフィックスがどのURIに対応しているかを確認します。
39        $prefixNamespaceUri = $document->lookupNamespaceURI('ex');
40        echo "2. プレフィックス 'ex' の名前空間: " . ($prefixNamespaceUri ?? "見つかりませんでした") . PHP_EOL;
41
42        // 3. 存在しないプレフィックス ('nonexistent') に対応する名前空間URIを検索します。
43        //    存在しない場合は null が返されます。
44        $nonExistentNamespaceUri = $document->lookupNamespaceURI('nonexistent');
45        echo "3. プレフィックス 'nonexistent' の名前空間: " . ($nonExistentNamespaceUri ?? "見つかりませんでした") . PHP_EOL;
46
47    } catch (Throwable $e) {
48        // XMLのパースエラーなど、処理中に例外が発生した場合のハンドリング
49        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
50    }
51}
52
53// 関数を実行して、名前空間の検索結果を表示します。
54demonstrateXmlNamespaceLookup();
55

Dom\XMLDocument::lookupNamespaceURIメソッドは、PHP 8.1以降で利用可能で、XMLドキュメント内で定義されている名前空間URIを検索するために使用されます。このメソッドを利用すると、XML要素や属性に付与されたプレフィックスが、実際にどの名前空間URIに対応しているかを確認できます。

引数$prefixには、検索したい名前空間のプレフィックスを文字列で渡します。もしnullを渡した場合、XMLのルート要素などで定義されているデフォルト名前空間、つまりプレフィックスなしの名前空間のURIを検索します。「php namespace ルート」というキーワードは、多くの場合、このルート要素のデフォルト名前空間を指し、lookupNamespaceURI(null)でそのURIを取得できます。

戻り値は、指定されたプレフィックスに対応する名前空間URIが見つかれば、そのURIを表す文字列を返します。もし該当する名前空間が見つからない場合はnullが返されます。

サンプルコードでは、まずXMLのデフォルト名前空間をnullプレフィックスで検索し、「http://example.com/default-ns」というURIが取得されることを示しています。次に、`ex`というプレフィックスに対応するURI「http://example.com/prefix-ns」を検索しています。存在しないプレフィックスに対しては`null`が返される挙動も確認でき、XMLの名前空間をプログラムから扱う際に非常に役立つメソッドです。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::lookupNamespaceURI の使用例。
5 *
6 * この関数は、XMLドキュメントから指定されたプレフィックスに対応する名前空間URIを検索します。
7 * プレフィックスが見つからない場合に `null` を返す挙動を特に示し、
8 * 「php namespace not found」という状況を表現します。
9 *
10 * 注: Dom\XMLDocument クラスは PHP 8 以降で利用可能です。
11 */
12function demonstrateLookupNamespaceURI(): void
13{
14    // 名前空間を持つシンプルなXML文字列
15    $xmlString = <<<XML
16<root xmlns:ns1="http://example.com/ns1" xmlns:ns2="http://example.com/ns2">
17    <ns1:item id="item1"/>
18    <ns2:item id="item2"/>
19    <item id="item3"/>
20</root>
21XML;
22
23    try {
24        // Dom\XMLDocument インスタンスを初期化し、XML文字列を読み込む
25        $document = new Dom\XMLDocument();
26        $document->loadXML($xmlString);
27
28        echo "--- 名前空間URIの検索結果 ---\n";
29
30        // 1. 存在するプレフィックスの検索
31        $existingPrefix = 'ns1';
32        $uriExisting = $document->lookupNamespaceURI($existingPrefix);
33        if ($uriExisting !== null) {
34            echo "プレフィックス '{$existingPrefix}' に対応するURI: {$uriExisting}\n";
35        } else {
36            echo "エラー: プレフィックス '{$existingPrefix}' のURIが見つかりませんでした。\n";
37        }
38
39        // 2. 存在しないプレフィックスの検索 (キーワード「php namespace not found」に最も関連)
40        $nonExistingPrefix = 'nonexistent';
41        $uriNonExisting = $document->lookupNamespaceURI($nonExistingPrefix);
42        if ($uriNonExisting === null) {
43            echo "プレフィックス '{$nonExistingPrefix}' のURIは見つかりませんでした (nullが返されました)。これは想定された結果です。\n";
44        } else {
45            echo "エラー: プレフィックス '{$nonExistingPrefix}' のURI: {$uriNonExisting} (予期せぬ結果)。\n";
46        }
47
48        // 3. デフォルト名前空間 (プレフィックスなし) の検索
49        // 引数に null を渡すと、デフォルト名前空間のURIを検索します。
50        // このXMLにはデフォルト名前空間が定義されていないため、nullが返るはずです。
51        $defaultPrefix = null;
52        $uriDefault = $document->lookupNamespaceURI($defaultPrefix);
53        if ($uriDefault === null) {
54            echo "デフォルト名前空間 (プレフィックスなし) のURIは見つかりませんでした (nullが返されました)。これも想定された結果です。\n";
55        } else {
56            echo "デフォルト名前空間のURI: {$uriDefault}\n";
57        }
58
59    } catch (Throwable $e) {
60        // XMLの読み込み失敗など、処理中に発生したエラーを捕捉
61        echo "処理中にエラーが発生しました: " . $e->getMessage() . "\n";
62    }
63}
64
65// 関数を実行
66demonstrateLookupNamespaceURI();

PHP 8で利用可能なDom\XMLDocument::lookupNamespaceURIメソッドは、XMLドキュメント内で指定されたプレフィックスに対応する名前空間URIを検索するために使用されます。このメソッドは、XMLデータをプログラムで処理する際に、要素や属性が属する名前空間を特定するのに役立ちます。

引数$prefixには、検索したい名前空間のプレフィックスを文字列で指定します。例えば、XMLにxmlns:myprefix="http://example.com/ns"と定義されている場合、myprefixを渡します。もしnullを渡すと、XMLドキュメントで定義されているデフォルト名前空間（プレフィックスを持たない名前空間）のURIを検索します。

このメソッドの戻り値は、対応する名前空間URIが見つかった場合はそのURIを文字列で返します。しかし、指定されたプレフィックスがXMLドキュメント内で見つからない場合や、デフォルト名前空間が定義されていない場合はnullを返します。このnullが返される状況は、「php namespace not found」として扱われ、名前空間が見つからなかったことをプログラムで確認できます。

サンプルコードでは、存在するプレフィックスに対するURIの取得、存在しないプレフィックスが指定された場合にnullが返される挙動、そしてデフォルト名前空間が定義されていない場合にnullが返される挙動を具体的に示し、このメソッドの利用方法と結果の処理について詳しく解説しています。