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

Copy
1<?php
2
3/**
4 * Dom\CharacterData::lookupPrefix メソッドの使用例を示します。
5 * このメソッドは、指定された名前空間URIに対応するプレフィックスを、
6 * 現在のノード（ここでは Dom\Text）から親要素を遡って検索します。
7 * Dom\CharacterData は抽象クラスのため、その具体的な子クラスである Dom\Text を使用します。
8 */
9function demonstrateLookupPrefix(): void
10{
11    // 1. 新しいDOMドキュメントを作成します。
12    $dom = new Dom\Document('1.0', 'UTF-8');
13    $dom->formatOutput = true; // XML出力を見やすく整形します。
14
15    // 2. 名前空間を持つルート要素を作成し、ドキュメントに追加します。
16    // 例: <rns:root xmlns:rns="http://example.com/root_ns">
17    $rootNamespaceUri = 'http://example.com/root_ns';
18    $rootPrefix = 'rns';
19    $rootElement = $dom->createElementNS($rootNamespaceUri, "{$rootPrefix}:root");
20    $dom->appendChild($rootElement);
21
22    // 3. 別の名前空間を持つ子要素を作成し、ルート要素に追加します。
23    // 例: <cns:child xmlns:cns="http://example.com/child_ns">
24    $childNamespaceUri = 'http://example.com/child_ns';
25    $childPrefix = 'cns';
26    $childElement = $dom->createElementNS($childNamespaceUri, "{$childPrefix}:child");
27    $rootElement->appendChild($childElement);
28
29    // 4. 子要素内にテキストノード（Dom\CharacterDataの具体的なインスタンス）を作成し、追加します。
30    $textNode = $dom->createTextNode('これは名前空間付き要素内のテキストノードです。');
31    $childElement->appendChild($textNode);
32
33    // 生成されたXMLドキュメントを出力し、構造を確認します。
34    echo "--- 生成されたXMLドキュメント ---\n";
35    echo $dom->saveXML();
36    echo "\n----------------------------\n\n";
37
38    // 5. Dom\CharacterData のインスタンス（$textNode）から lookupPrefix メソッドを呼び出します。
39    echo "Dom\\CharacterData::lookupPrefix メソッドの実行例:\n";
40
41    // 子要素の名前空間URIでプレフィックスを検索します。
42    $searchUri1 = $childNamespaceUri;
43    echo "URI '{$searchUri1}' のプレフィックスを検索中...\n";
44    $prefix1 = $textNode->lookupPrefix($searchUri1);
45    if ($prefix1 !== null) {
46        echo "  見つかったプレフィックス: '{$prefix1}'\n";
47    } else {
48        echo "  このURIのプレフィックスは見つかりませんでした。\n";
49    }
50
51    echo "\n";
52
53    // 親要素の名前空間URIでプレフィックスを検索します。
54    $searchUri2 = $rootNamespaceUri;
55    echo "URI '{$searchUri2}' のプレフィックスを検索中...\n";
56    $prefix2 = $textNode->lookupPrefix($searchUri2);
57    if ($prefix2 !== null) {
58        echo "  見つかったプレフィックス: '{$prefix2}'\n";
59    } else {
60        echo "  このURIのプレフィックスは見つかりませんでした。\n";
61    }
62
63    echo "\n";
64
65    // 存在しない名前空間URIでプレフィックスを検索します。
66    $searchUri3 = 'http://example.com/non_existent_ns';
67    echo "URI '{$searchUri3}' (存在しない) のプレフィックスを検索中...\n";
68    $prefix3 = $textNode->lookupPrefix($searchUri3);
69    if ($prefix3 !== null) {
70        echo "  見つかったプレフィックス: '{$prefix3}'\n";
71    } else {
72        echo "  このURIのプレフィックスは見つかりませんでした。\n";
73    }
74}
75
76// 関数を実行してデモンストレーションを開始します。
77demonstrateLookupPrefix();

PHPのDom\CharacterData::lookupPrefixメソッドは、XMLドキュメント内で指定された名前空間URIに対応するプレフィックスを検索するために使用されます。Dom\CharacterDataはテキストノードやコメントノードなどの基底となる抽象クラスですが、このサンプルコードでは具体的なインスタンスとしてDom\Textノードを例に挙げています。

このメソッドは、引数として指定されたstring $namespace（検索したい名前空間URI）を受け取ります。そして、メソッドが呼び出されたノード（この例ではテキストノード）から始まり、その親要素を順に遡りながら、その名前空間URIに割り当てられたプレフィックスを探します。

サンプルコードでは、まず複数の名前空間を持つXMLドキュメントを作成し、テキストノードをその中に配置しています。そのテキストノードからlookupPrefixを呼び出し、子要素の名前空間URIや、さらに上位の親要素の名前空間URIを指定すると、それぞれに対応するプレフィックスがstring型で返されます。これにより、メソッドがノードの階層を辿ってプレフィックスを探索する様子がわかります。しかし、ドキュメント内に存在しない名前空間URIを指定した場合は、対応するプレフィックスが見つからないため、戻り値はnullとなります。この機能は、XMLドキュメント内で名前空間URIからプレフィックスを効率的に特定する際に役立ちます。