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

Copy
1<?php
2
3// Dom\Attr::lookupPrefix メソッドの使用例
4// このメソッドは、指定された名前空間URIに対応するプレフィックスを検索します。
5// 見つからない場合は null を、デフォルト名前空間の場合は空文字列を返します。
6
7// 1. DOMDocument オブジェクトを新規作成します。
8$dom = new DOMDocument('1.0', 'UTF-8');
9$dom->formatOutput = true; // 整形されたXMLを出力するための設定
10
11// 2. 名前空間を持つルート要素を作成します。
12$rootNamespaceUri = 'http://example.com/root-ns';
13$rootPrefix = 'myroot';
14// createElementNS(namespaceURI, qualifiedName) で名前空間付き要素を作成
15$rootElement = $dom->createElementNS($rootNamespaceUri, $rootPrefix . ':data');
16$dom->appendChild($rootElement);
17
18// 3. 名前空間を持つ属性をルート要素に追加します。
19$attributeNamespaceUri = 'http://example.com/attribute-ns';
20$attributePrefix = 'myattr';
21// setAttributeNS(namespaceURI, qualifiedName, value) で名前空間付き属性を設定
22$rootElement->setAttributeNS($attributeNamespaceUri, $attributePrefix . ':id', 'value-123');
23
24// 4. 作成した属性ノードを Dom\Attr オブジェクトとして取得します。
25// getAttributeNodeNS(namespaceURI, localName) で属性ノードを取得
26// PHP 8以降では Dom\Attr 型として扱われます
27$attrNode = $rootElement->getAttributeNodeNS($attributeNamespaceUri, 'id');
28
29// 5. Dom\Attr::lookupPrefix() メソッドを使用して、プレフィックスを検索します。
30if ($attrNode instanceof Dom\Attr) {
31    echo "--- 生成されたXMLの一部 ---\n";
32    // 例として、ルート要素のXML表現を出力
33    echo $dom->saveXML($rootElement);
34    echo "\n---------------------------\n\n";
35
36    echo "対象の属性ノード: " . $attrNode->nodeName . "\n";
37    echo "属性が属する名前空間URI: " . $attrNode->namespaceURI . "\n\n";
38
39    // 属性自身の名前空間URIでプレフィックスを検索
40    $targetNamespace = $attrNode->namespaceURI;
41    echo "名前空間URI '{$targetNamespace}' のプレフィックスを検索...\n";
42    $prefix = $attrNode->lookupPrefix($targetNamespace);
43
44    if ($prefix !== null) {
45        if ($prefix === '') {
46            echo "結果: 空文字列が返されました。これは、名前空間がデフォルト名前空間として宣言されている場合や、プレフィックスなしで利用されている場合を示唆します。\n";
47        } else {
48            echo "結果: プレフィックス '{$prefix}' が見つかりました。\n";
49        }
50    } else {
51        echo "結果: null が返されました。指定された名前空間URIに対応するプレフィックスは見つかりませんでした。\n";
52    }
53
54    echo "\n--- 存在しない名前空間URIで検索する例 ---\n";
55    $nonExistentNamespace = 'http://example.com/unknown-ns';
56    echo "名前空間URI '{$nonExistentNamespace}' のプレフィックスを検索...\n";
57    $prefixNotFound = $attrNode->lookupPrefix($nonExistentNamespace);
58
59    if ($prefixNotFound === null) {
60        echo "結果: null が返されました。この名前空間に対するプレフィックスは存在しません。\n";
61    } else {
62        echo "結果: プレフィックス '{$prefixNotFound}' が見つかりました。これは予期しない結果です。\n";
63    }
64
65} else {
66    echo "エラー: Dom\\Attr オブジェクトを取得できませんでした。属性ノードが存在しないか、名前空間URIとローカル名が正しくありません。\n";
67}
68

PHPのDom\Attr::lookupPrefixメソッドは、XMLの属性ノード（Dom\Attrオブジェクト）から、指定された名前空間URIに対応するプレフィックスを検索します。

引数$namespaceには、検索したい名前空間URIを文字列で指定します。戻り値は?string型です。対応するプレフィックスが見つかればその名前（文字列）を返します。名前空間がデフォルトで使用されプレフィックスがない場合は空文字列''が、見つからない場合はnullが返されます。

サンプルコードでは、名前空間を持つXML属性を作成し、lookupPrefixメソッドでプレフィックスを検索する例を示します。属性自身のURIや存在しないURIでの検索結果を確認でき、XMLの名前空間情報を正確に把握するのに役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Attr::lookupPrefix メソッドの使用例を示します。
5 * この関数は、XMLドキュメント内の属性の名前空間プレフィックスを検索します。
6 * URLのクエリパラメータ (`?ns=...`) を利用して、検索する名前空間URIを動的に指定します。
7 * これはJavaScriptの `location.search` からクエリパラメータを取得するのと同様の概念をPHPで実現する方法です。
8 *
9 * このコードを実行するには、PHPがインストールされたWebサーバー（例: Apache, Nginx）上で
10 * ブラウザからアクセスするか、PHPの組み込みウェブサーバー (`php -S localhost:8000`) を利用してください。
11 *
12 * 例:
13 * - `http://localhost/your_script.php?ns=http://example.com/my-namespace`
14 * - `http://localhost/your_script.php?ns=http://example.com/another-namespace`
15 * - `http://localhost/your_script.php` (パラメータがない場合、デフォルト値を使用)
16 */
17function demonstrateDomAttrLookupPrefixExample(): void
18{
19    // 1. 名前空間が定義されたXMLドキュメントを作成します。
20    // ここでは 'my' というプレフィックスが 'http://example.com/my-namespace' というURIに紐付けられています。
21    $xmlString = '<root xmlns:my="http://example.com/my-namespace">
22                    <my:element my:attr="Hello PHP 8 DOM!"/>
23                  </root>';
24
25    $dom = new DOMDocument();
26    // loadXML() はXML文字列をDOMオブジェクトにロードします。
27    $dom->loadXML($xmlString);
28
29    // 2. 検索対象となる Dom\Attr オブジェクト（属性）を取得します。
30    // DOM要素の属性は DOMNamedNodeMap として取得でき、その中から特定の名前空間とローカル名で属性を選択します。
31    // attributes プロパティは DOMNamedNodeMap を返し、getNamedItemNS は名前空間URIとローカル名で属性を取得します。
32    /** @var Dom\Attr|null $attr */
33    $attr = $dom->documentElement
34                ->firstChild // <my:element> を取得
35                ->attributes // <my:element> の属性リストを取得
36                ->getNamedItemNS('http://example.com/my-namespace', 'attr'); // 'http://example.com/my-namespace' 名前空間の 'attr' 属性を検索
37
38    if ($attr === null) {
39        echo "エラー: 指定された属性 'my:attr' がXMLドキュメント内で見つかりませんでした。\n";
40        return; // 属性が見つからない場合は処理を終了
41    }
42
43    // 3. lookupPrefix メソッドの引数となる名前空間URIを準備します。
44    // ここで URL のクエリパラメータを利用します。
45    // `$_GET['ns']` は、JavaScriptの `location.search` から `ns` パラメータを取得するのと同等の機能です。
46    // `??` (Null合体演算子) は、`$_GET['ns']` がセットされていない場合にデフォルト値を使用します。
47    $namespaceToLookup = $_GET['ns'] ?? 'http://example.com/my-namespace';
48
49    echo "--- Dom\\Attr::lookupPrefix のデモンストレーション ---\n";
50    echo "現在のURLのクエリパラメータから取得された検索対象の名前空間URI: '{$namespaceToLookup}'\n";
51    echo "対象の属性: '{$attr->nodeName}' (値: '{$attr->nodeValue}')\n";
52
53    // 4. Dom\Attr::lookupPrefix メソッドを呼び出し、プレフィックスを検索します。
54    // このメソッドは、指定された名前空間URIに現在この属性が存在するコンテキストで紐付けられているプレフィックスを返します。
55    $prefix = $attr->lookupPrefix($namespaceToLookup);
56
57    // 5. 検索結果を出力します。
58    if ($prefix !== null) {
59        echo "結果: 名前空間URI '{$namespaceToLookup}' に対応するプレフィックスは '{$prefix}' です。\n";
60    } else {
61        echo "結果: 名前空間URI '{$namespaceToLookup}' に対応するプレフィックスは見つかりませんでした。\n";
62        echo "これは、指定されたURIがこのコンテキストで有効なプレフィックスに紐付けられていないことを意味します。\n";
63    }
64
65    echo "\n--- 別例: 存在しない名前空間URIを検索する --- \n";
66    $nonExistentNamespace = 'http://example.com/non-existent-namespace';
67    echo "検索対象の名前空間URI: '{$nonExistentNamespace}'\n";
68    $prefixNonExistent = $attr->lookupPrefix($nonExistentNamespace);
69    if ($prefixNonExistent !== null) {
70        echo "結果: 名前空間URI '{$nonExistentNamespace}' に対応するプレフィックスは '{$prefixNonExistent}' です。\n";
71    } else {
72        echo "結果: 名前空間URI '{$nonExistentNamespace}' に対応するプレフィックスは見つかりませんでした。\n";
73    }
74}
75
76// 上記のデモンストレーション関数を実行します。
77demonstrateDomAttrLookupPrefixExample();

Dom\Attr::lookupPrefixメソッドは、PHP 8のDOM拡張機能が提供する機能の一つで、XMLドキュメント内の属性が属するコンテキストにおいて、指定された名前空間URIに対応するプレフィックスを検索する際に使用されます。このメソッドは、string $namespaceという引数に検索したい名前空間URIを指定することで、そのURIに紐付けられたプレフィックス（文字列）を返します。もし該当するプレフィックスが見つからない場合や、デフォルト名前空間の場合はnullを返します。

サンプルコードでは、名前空間が定義されたXMLドキュメントから特定の属性（Dom\Attrオブジェクト）を取得し、lookupPrefixメソッドを利用してその属性のコンテキストにおけるプレフィックスを検索します。特に、検索対象の名前空間URIは、ブラウザからアクセスするURLのクエリパラメータ（例: http://localhost/script.php?ns=...）から動的に取得しています。これは、JavaScriptでlocation.searchを使ってURLのクエリパラメータを読み取るのと同様の概念を、PHPの$_GETスーパーグローバル変数で実現する方法です。

取得した名前空間URIをlookupPrefixメソッドに渡すと、XMLドキュメント内でそのURIに対応するプレフィックスが特定され、その値が出力されます。存在しない名前空間URIを指定した場合や、現在の属性のコンテキストで紐付けられていないURIを指定した場合はnullが返され、「プレフィックスが見つかりませんでした」という結果になります。このメソッドは、XMLの構文解析や処理において、名前空間とプレフィックスの対応関係を正確に把握するために役立ちます。