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

Copy
1<?php
2
3/**
4 * DOMNode::lookupNamespaceURI メソッドの利用例。
5 *
6 * この関数は、XML要素 (DOMNode) から特定のプレフィックスに対応する名前空間URIを検索する方法を示します。
7 * 'php namespace ルート' のキーワードに合わせて、XMLドキュメントのルート要素からの名前空間URIのルックアップに焦点を当てています。
8 */
9function demonstrateLookupNamespaceURI(): void
10{
11    // 名前空間が宣言されたXML文字列を定義します。
12    // 'xmlns' はデフォルトの名前空間、'xmlns:pref' は 'pref' プレフィックスに紐づく名前空間です。
13    $xmlString = <<<XML
14<root xmlns="http://example.com/default_namespace" xmlns:pref="http://example.com/prefix_namespace">
15    <child pref:attribute="value">
16        データ
17    </child>
18</root>
19XML;
20
21    // DOMDocument オブジェクトを作成します。これはXMLドキュメント全体を扱います。
22    $dom = new DOMDocument();
23
24    // XML文字列をDOMDocumentにロードします。
25    // loadXML() は成功した場合に true を返しますが、ここでは簡潔にするためエラーチェックは省略しています。
26    $dom->loadXML($xmlString);
27
28    // ドキュメントのルート要素を取得します。
29    // DOMNode::lookupNamespaceURI は DOMNode のメソッドなので、DOMElement であるルート要素に対して呼び出します。
30    $rootElement = $dom->documentElement;
31
32    if ($rootElement === null) {
33        echo "エラー: XMLのルート要素が見つかりませんでした。\n";
34        return;
35    }
36
37    echo "--- ルート要素からの名前空間URIルックアップ ---\n";
38
39    // 1. デフォルト名前空間のURIを検索します。
40    // プレフィックスが null または空文字列の場合、デフォルト名前空間 (xmlns) を探します。
41    $defaultNamespaceURI = $rootElement->lookupNamespaceURI(null);
42    echo "デフォルト名前空間URI (プレフィックスなし): " . ($defaultNamespaceURI ?: "(見つかりません)") . "\n";
43
44    // 2. 'pref' プレフィックスに対応する名前空間URIを検索します。
45    $prefixNamespaceURI = $rootElement->lookupNamespaceURI('pref');
46    echo "'pref' プレフィックスの名前空間URI: " . ($prefixNamespaceURI ?: "(見つかりません)") . "\n";
47
48    // 3. XML内で宣言されていない 'unknown' プレフィックスの名前空間URIを検索します。
49    // 存在しないプレフィックスの場合、null が返されます。
50    $unknownNamespaceURI = $rootElement->lookupNamespaceURI('unknown');
51    echo "'unknown' プレフィックスの名前空間URI: " . ($unknownNamespaceURI ?: "(見つかりません)") . "\n";
52
53    echo "\nDOMNode::lookupNamespaceURI メソッドは、指定されたノードのスコープ内で、\n";
54    echo "特定のプレフィックスがどの名前空間URIにマッピングされているかを調べることができます。\n";
55    echo "指定されたプレフィックスが見つからない場合、null を返します。\n";
56}
57
58// 関数を実行して、DOMNode::lookupNamespaceURI の動作を確認します。
59demonstrateLookupNamespaceURI();
60
61?>

PHPのDOMNode::lookupNamespaceURIメソッドは、XMLドキュメント内の特定のノードにおいて、指定されたプレフィックスがどの名前空間URIにマッピングされているかを検索する際に使用されます。このメソッドはDOMNodeクラスに属しており、XMLドキュメントのルート要素など、任意のXMLノードから呼び出すことができます。

引数$prefixには、検索したい名前空間のプレフィックスを文字列として指定します。もしnullまたは空文字列を渡した場合、そのノードのスコープ内で宣言されているデフォルトの名前空間（プレフィックスを持たないxmlns宣言）のURIが検索されます。

メソッドの戻り値は?string型で、指定されたプレフィックスに対応する名前空間URIが見つかった場合はそのURI文字列を返します。しかし、対応する名前空間が見つからない場合はnullを返します。

サンプルコードでは、デフォルトの名前空間とprefプレフィックスに紐づく名前空間が宣言されたXMLを用意し、DOMDocumentで読み込んでいます。そして、XMLのルート要素 ($dom->documentElement) を取得し、その要素に対してlookupNamespaceURIメソッドを適用しています。具体的には、nullを渡してデフォルト名前空間URIを、'pref'を渡してprefプレフィックスの名前空間URIをそれぞれ検索しています。また、XML内で宣言されていない'unknown'プレフィックスを検索した場合はnullが返されることが示されており、名前空間の検索結果の有無を確認するのに役立ちます。

Copy
1<?php
2
3/**
4 * DOMNode::lookupNamespaceURI() メソッドの使用例を示します。
5 * 特定のノードスコープで名前空間のURIを検索し、
6 * プレフィックスが見つからない場合の挙動をデモンストレーションします。
7 *
8 * @param string $xmlString 処理するXML文字列
9 * @return void
10 */
11function demonstrateLookupNamespaceURI(string $xmlString): void
12{
13    // DOMDocument オブジェクトを初期化
14    $dom = new DOMDocument();
15    // XML文字列を読み込む
16    $dom->loadXML($xmlString);
17
18    // ドキュメントのルート要素を取得
19    // DOMElement は DOMNode を継承しているので、lookupNamespaceURI() メソッドが利用可能です。
20    $rootElement = $dom->documentElement;
21
22    echo "ルート要素のノード名: " . $rootElement->nodeName . "\n";
23    echo "--------------------------------------------------\n";
24
25    // 存在するプレフィックス 'prefix1' の名前空間URIを検索
26    $uri1 = $rootElement->lookupNamespaceURI('prefix1');
27    echo "プレフィックス 'prefix1' の名前空間URI: " . ($uri1 ?? 'null (見つかりません)') . "\n";
28
29    // 存在するプレフィックス 'prefix2' の名前空間URIを検索
30    $uri2 = $rootElement->lookupNamespaceURI('prefix2');
31    echo "プレフィックス 'prefix2' の名前空間URI: " . ($uri2 ?? 'null (見つかりません)') . "\n";
32
33    // デフォルト名前空間 (プレフィックスが指定されていない場合) の名前空間URIを検索
34    $uriDefault = $rootElement->lookupNamespaceURI(null);
35    echo "デフォルト名前空間のURI (プレフィックスなし): " . ($uriDefault ?? 'null (見つかりません)') . "\n";
36
37    // 存在しないプレフィックス 'nonexistent' の名前空間URIを検索
38    // この場合、PHPの「名前空間が見つかりません」という概念に類似して、nullが返されます。
39    $uriNotFound = $rootElement->lookupNamespaceURI('nonexistent');
40    echo "プレフィックス 'nonexistent' の名前空間URI: " . ($uriNotFound ?? 'null (見つかりません)') . "\n";
41
42    echo "--------------------------------------------------\n";
43
44    // 子要素を取得し、そのスコープでの名前空間の解決も確認
45    $childElement = $rootElement->getElementsByTagName('child')->item(0);
46    if ($childElement) {
47        echo "子要素 '" . $childElement->nodeName . "' のノード名: " . $childElement->nodeName . "\n";
48
49        // 子要素から見た 'prefix1' の名前空間URI
50        $childUri1 = $childElement->lookupNamespaceURI('prefix1');
51        echo "子要素から見た 'prefix1' の名前空間URI: " . ($childUri1 ?? 'null (見つかりません)') . "\n";
52
53        // 子要素から見た 'prefix2' の名前空間URI (同じく継承されるため見つかるはず)
54        $childUri2 = $childElement->lookupNamespaceURI('prefix2');
55        echo "子要素から見た 'prefix2' の名前空間URI: " . ($childUri2 ?? 'null (見つかりません)') . "\n";
56
57        // 子要素から見た存在しないプレフィックス 'another_nonexistent'
58        $childUriNotFound = $childElement->lookupNamespaceURI('another_nonexistent');
59        echo "子要素から見た 'another_nonexistent' の名前空間URI: " . ($childUriNotFound ?? 'null (見つかりません)') . "\n";
60    }
61}
62
63// サンプルXMLデータ
64$sampleXml = <<<XML
65<root xmlns="http://example.com/default_namespace"
66      xmlns:prefix1="http://example.com/namespace1"
67      xmlns:prefix2="http://example.com/namespace2">
68    <prefix1:child id="item1">
69        <subchild>テキスト</subchild>
70    </prefix1:child>
71    <another_child xmlns:prefix3="http://example.com/namespace3">
72        <prefix3:item/>
73    </another_child>
74</root>
75XML;
76
77// 関数を実行してデモンストレーション
78demonstrateLookupNamespaceURI($sampleXml);
79
80?>

PHP 8のDOMNode::lookupNamespaceURI()メソッドは、XMLドキュメント内の特定のノードを基準として、指定された名前空間プレフィックスに対応するURIを検索します。このメソッドはDOMNodeクラスに属し、XMLの名前空間の解決に利用されます。

引数$prefixには、検索したい名前空間のプレフィックスを文字列で指定します。nullを渡した場合は、そのノードスコープにおけるデフォルトの名前空間URIを検索します。

戻り値は、指定されたプレフィックスに対応するURIが見つかった場合にそのURIを文字列として返します。見つからなかった場合はnullを返します。このnullが返される挙動は、PHPで名前空間が「見つかりません」という状況に似ています。

サンプルコードでは、XML文字列をDOMDocumentに読み込み、ルート要素や子要素などのDOMNodeオブジェクトを取得しています。その後、lookupNamespaceURI()メソッドを使って、存在するプレフィックス（prefix1、prefix2）、デフォルト名前空間、そして存在しないプレフィックス（nonexistentなど）のURIを検索しています。結果として、存在する名前空間にはURIが、存在しない名前空間にはnullが返されることが確認でき、XMLの名前空間がノードのスコープでどのように解決され、継承されるかが具体的に示されています。