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

Copy
1<?php
2
3/**
4 * DOMXPath::registerNamespace メソッドを使用して、XPathクエリで
5 * 名前空間プレフィックスを登録し、名前空間付きのXML要素を検索するサンプルです。
6 */
7
8// 検索対象となるXML文字列を定義します。
9// 'my_ns' というプレフィックスで 'http://example.com/my_namespace' 名前空間が定義されています。
10$xmlString = <<<XML
11<?xml version="1.0" encoding="UTF-8"?>
12<root xmlns:my_ns="http://example.com/my_namespace">
13    <my_ns:item id="item1">これは名前空間付きのアイテムです。</my_ns:item>
14    <item id="item2">これは名前空間なしのアイテムです。</item>
15    <my_ns:item id="item3">これも名前空間付きのアイテムです。</my_ns:item>
16</root>
17XML;
18
19// DOMDocumentオブジェクトを作成し、XML文字列をロードします。
20$dom = new DOMDocument();
21$dom->loadXML($xmlString);
22
23// DOMXPathオブジェクトを作成します。これを使ってXPathクエリを実行します。
24$xpath = new DOMXPath($dom);
25
26// XPathクエリで使用するための名前空間プレフィックスとURIを定義します。
27// ここで登録するプレフィックス('custom_ns')はXML内のプレフィックス('my_ns')と異なっていても構いません。
28$prefixToRegister = 'custom_ns'; // XPathクエリ内で使用する任意のプレフィックス名
29$namespaceURI = 'http://example.com/my_namespace'; // XMLで定義されている名前空間のURI
30
31// DOMXPath::registerNamespace メソッドで名前空間を登録します。
32// このメソッドは登録が成功すると true を返します。
33if ($xpath->registerNamespace($prefixToRegister, $namespaceURI)) {
34    echo "名前空間 '{$prefixToRegister}' (URI: '{$namespaceURI}') を正常に登録しました。\n";
35} else {
36    echo "名前空間の登録に失敗しました。\n";
37    exit(1); // 登録に失敗した場合は処理を終了します。
38}
39
40// 登録したプレフィックスを使って、名前空間付きの要素を検索するXPathクエリを構築します。
41$queryWithNamespace = "//{$prefixToRegister}:item";
42echo "\n--- クエリ: '{$queryWithNamespace}' を実行 --- \n";
43
44// XPathクエリを実行し、結果のDOMNodeListを取得します。
45$nodesWithNamespace = $xpath->query($queryWithNamespace);
46
47// 検索結果を出力します。
48if ($nodesWithNamespace->length > 0) {
49    echo "見つかった名前空間付きのアイテム:\n";
50    foreach ($nodesWithNamespace as $node) {
51        echo "- " . $node->nodeValue . " (ID: " . $node->getAttribute('id') . ")\n";
52    }
53} else {
54    echo "指定された名前空間を持つアイテムは見つかりませんでした。\n";
55}
56
57// 比較のために、名前空間プレフィックスを使用しないクエリも実行してみます。
58$queryWithoutNamespace = "//item";
59echo "\n--- クエリ: '{$queryWithoutNamespace}' (名前空間なしの要素を検索) を実行 --- \n";
60$nodesWithoutNamespace = $xpath->query($queryWithoutNamespace);
61
62if ($nodesWithoutNamespace->length > 0) {
63    echo "見つかった名前空間なしのアイテム:\n";
64    foreach ($nodesWithoutNamespace as $node) {
65        echo "- " . $node->nodeValue . " (ID: " . $node->getAttribute('id') . ")\n";
66    }
67} else {
68    echo "指定されたアイテムは見つかりませんでした。\n";
69}
70
71?>

PHPのDom\XPath::registerNamespaceメソッドは、XML文書からXPathクエリを使って特定の名前空間に属する要素を検索する際に、その名前空間をXPathエンジンに登録するために使用されます。XML文書では、異なるXML要素の衝突を避けるためにURIで識別される名前空間が使われます。このメソッドは、Dom\XPathオブジェクトを作成した後に呼び出すことで、XPathクエリが名前空間を正しく理解し、対象の要素を正確に識別できるようになります。

引数には二つの文字列を指定します。一つ目の$prefixは、XPathクエリ内で名前空間付き要素を指定する際に使う任意のプレフィックス名です。このプレフィックス名は、元のXML文書で定義されているプレフィックスと異なっていても問題ありません。二つ目の$namespaceURIは、XML文書で実際に使われている名前空間のURIを正確に指定します。メソッドは、登録が成功するとtrueを、失敗するとfalseをブール値で返します。

サンプルコードでは、my_nsプレフィックスで名前空間が定義されたXML文書をロードし、DOMXPathオブジェクトを作成しています。その後、registerNamespaceメソッドを使って、http://example.com/my_namespaceというURIにcustom_nsというプレフィックスを割り当てて登録しています。この登録により、XPathクエリ//custom_ns:itemを実行すると、XML内の<my_ns:item>要素が、登録されたcustom_nsプレフィックスを通じて正しく検索され、内容が取得されることを示しています。このように、名前空間を適切に登録することで、複雑なXML文書から目的のデータを正確かつ効率的に抽出することが可能になります。

Copy
1<?php
2
3/**
4 * Dom\XPath::registerNamespace メソッドの使用例。
5 *
6 * このメソッドは、XML ドキュメント内で XPath クエリに XML 名前空間プレフィックスを登録します。
7 * これは PHP 言語の `namespace` キーワード（コードの論理的なグループ化に使用されるもの）とは異なる、
8 * XML ドキュメント内の要素や属性を一意に識別するための「XML名前空間」を扱います。
9 * システムエンジニアを目指す初心者が、DOMDocumentとXPathを使って
10 * XML名前空間を含むデータを操作する基本を理解するのに役立ちます。
11 */
12function searchXmlWithNamespace(): void
13{
14    // 1. XMLドキュメントを文字列として準備します。
15    // 'bk' というプレフィックスで 'http://www.example.com/books' というXML名前空間が定義されています。
16    $xmlString = <<<EOT
17<?xml version="1.0" encoding="UTF-8"?>
18<bookstore xmlns:bk="http://www.example.com/books">
19    <bk:book id="bk101">
20        <bk:author>Gambardella, Matthew</bk:author>
21        <bk:title>XML Developer's Guide</bk:title>
22        <bk:genre>Computer</bk:genre>
23        <bk:price>44.95</bk:price>
24        <bk:publish_date>2000-10-01</bk:publish_date>
25        <bk:description>An in-depth look at creating applications with XML.</bk:description>
26    </bk:book>
27    <bk:book id="bk102">
28        <bk:author>Ralls, Kim</bk:author>
29        <bk:title>Midnight Rain</bk:title>
30        <bk:genre>Fantasy</bk:genre>
31        <bk:price>5.95</bk:price>
32        <bk:publish_date>2000-12-16</bk:publish_date>
33        <bk:description>A former architect battles an evil sorceress.</bk:description>
34    </bk:book>
35</bookstore>
36EOT;
37
38    // 2. DOMDocument オブジェクトを初期化し、XMLをロードします。
39    $dom = new DOMDocument();
40    // エラーが発生しないように内部エラーを無効にします。
41    libxml_use_internal_errors(true);
42    if (!$dom->loadXML($xmlString)) {
43        echo "XMLのロードに失敗しました。\n";
44        // エラー情報を表示するが、ここでは簡潔のため省略
45        libxml_clear_errors();
46        return;
47    }
48    libxml_use_internal_errors(false);
49
50    // 3. Dom\XPath オブジェクトを初期化します。
51    $xpath = new Dom\XPath($dom);
52
53    // 4. Dom\XPath::registerNamespace を使用して、XML名前空間プレフィックスを登録します。
54    // これにより、XPathクエリで 'bk:' プレフィックスを使用できるようになります。
55    $registered = $xpath->registerNamespace('bk', 'http://www.example.com/books');
56
57    if ($registered) {
58        echo "XML名前空間プレフィックス 'bk' が正常に登録されました。\n\n";
59
60        // 5. 登録されたプレフィックスを使用して、名前空間付きの要素をXPathで検索します。
61        // ここではすべての書籍のタイトルを取得します。
62        $query = '//bk:book/bk:title';
63        $titles = $xpath->query($query);
64
65        if ($titles === false) {
66            echo "XPathクエリの実行に失敗しました: " . $query . "\n";
67            return;
68        }
69
70        echo "検索結果:\n";
71        if ($titles->length > 0) {
72            foreach ($titles as $titleNode) {
73                echo "- " . $titleNode->nodeValue . "\n";
74            }
75        } else {
76            echo "該当するタイトルは見つかりませんでした。\n";
77        }
78    } else {
79        echo "XML名前空間プレフィックス 'bk' の登録に失敗しました。\n";
80    }
81}
82
83// 関数を実行します。
84searchXmlWithNamespace();

Dom\XPath::registerNamespaceメソッドは、XMLドキュメント内でXPathクエリにXML名前空間プレフィックスを登録するために使用します。これは、PHP言語がコードを論理的にグループ化するために用いるnamespaceキーワードとは異なり、XMLドキュメント内の要素や属性を一意に識別するための「XML名前空間」を扱うためのものです。

このメソッドは、XPathクエリで使用したい名前空間の短縮名である$prefix（文字列）と、そのプレフィックスが指し示す一意のURIである$namespaceURI（文字列）の二つの引数を取ります。メソッドの実行結果として、登録が成功した場合はtrue、失敗した場合はfalseのブール値が戻り値として返されます。

サンプルコードでは、まずxmlns:bk="http://www.example.com/books"というXML名前空間が定義されたXMLドキュメントを準備し、DOMDocumentとDom\XPathオブジェクトを初期化しています。その後、$xpath->registerNamespace('bk', 'http://www.example.com/books')を呼び出すことで、XPathエンジンにbkというプレフィックスが特定のURIを示すことを登録します。これにより、続くXPathクエリ//bk:book/bk:titleのように、XMLドキュメント内で定義された名前空間プレフィックスを正確に使用して、名前空間付きの要素を検索できるようになります。この登録は、XML名前空間を持つデータを適切に処理し、XPathで要素を効率的に見つけるための重要なステップです。