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

Copy
1<?php
2
3// XML文字列を定義します。このXMLは 'bk' というプレフィックスを持つ名前空間を使用しています。
4// 名前空間URI (URI) は "http://www.example.com/books" です。
5$xmlString = <<<XML
6<?xml version="1.0" encoding="UTF-8"?>
7<bookstore xmlns:bk="http://www.example.com/books">
8    <bk:book id="php-book-1">
9        <bk:title>PHP Programming with Namespace</bk:title>
10        <bk:author>John Doe</bk:author>
11    </bk:book>
12    <book id="plain-book-2">
13        <title>Another Plain Book</title>
14        <author>Jane Smith</author>
15    </book>
16</bookstore>
17XML;
18
19// SimpleXMLElementオブジェクトをXML文字列から作成します。
20$xml = new SimpleXMLElement($xmlString);
21
22echo "--- 名前空間登録前のXPathクエリ ---" . PHP_EOL;
23
24// 名前空間プレフィックス 'bk' を登録せずに、'bk:book' 要素をXPathで検索します。
25// 'bk' プレフィックスが SimpleXMLElement に関連付けられていないため、
26// 名前空間を持つ要素は正しく検索されません（結果は0件になるはずです）。
27$booksBeforeRegistration = $xml->xpath('//bk:book');
28
29if (count($booksBeforeRegistration) === 0) {
30    echo "  'bk:book' を検索しましたが、結果は見つかりませんでした。(期待通り)" . PHP_EOL;
31} else {
32    echo "  'bk:book' が見つかりました。(予期しない動作)" . PHP_EOL;
33}
34
35echo PHP_EOL . "--- registerXPathNamespace を使用して名前空間を登録 ---" . PHP_EOL;
36
37// SimpleXMLElement::registerXPathNamespace メソッドを使って、
38// XPathクエリで利用するための名前空間プレフィックス 'bk' を
39// 名前空間URI "http://www.example.com/books" に関連付けます。
40// このメソッドは成功した場合に true を返します。
41$isRegistered = $xml->registerXPathNamespace('bk', 'http://www.example.com/books');
42
43if ($isRegistered) {
44    echo "  名前空間プレフィックス 'bk' が正常に登録されました。" . PHP_EOL;
45} else {
46    echo "  名前空間プレフィックス 'bk' の登録に失敗しました。" . PHP_EOL;
47    exit(1); // 登録に失敗した場合はスクリプトを終了します
48}
49
50echo PHP_EOL . "--- 名前空間登録後のXPathクエリ ---" . PHP_EOL;
51
52// 名前空間プレフィックス 'bk' が登録されたので、再度 'bk:book' 要素をXPathで検索します。
53// 今度は名前空間が正しく解決され、対応する要素が見つかるはずです。
54$booksAfterRegistration = $xml->xpath('//bk:book');
55
56if (count($booksAfterRegistration) > 0) {
57    echo "  'bk:book' が " . count($booksAfterRegistration) . " 件見つかりました。" . PHP_EOL;
58    foreach ($booksAfterRegistration as $book) {
59        // 見つかった bk:book 要素の属性や子要素にアクセスします。
60        // SimpleXMLElement は名前空間を自動的に扱うため、通常通りプロパティとしてアクセスできます。
61        echo "    - ID: " . $book['id'] . ", Title: " . $book->title . ", Author: " . $book->author . PHP_EOL;
62    }
63} else {
64    echo "  'bk:book' を検索しましたが、結果が見つかりませんでした。(予期しない動作)" . PHP_EOL;
65}
66
67echo PHP_EOL . "--- 名前空間を持たない要素のXPathクエリ (比較のため) ---" . PHP_EOL;
68
69// registerXPathNamespace は特定の名前空間プレフィックスの登録に影響するため、
70// 名前空間を持たない通常の 'book' 要素のクエリには影響しません。
71$plainBooks = $xml->xpath('//book');
72
73if (count($plainBooks) > 0) {
74    echo "  名前空間を持たない 'book' が " . count($plainBooks) . " 件見つかりました。" . PHP_EOL;
75    foreach ($plainBooks as $book) {
76        echo "    - ID: " . $book['id'] . ", Title: " . $book->title . ", Author: " . $book->author . PHP_EOL;
77    }
78} else {
79    echo "  名前空間を持たない 'book' を検索しましたが、結果が見つかりませんでした。" . PHP_EOL;
80}
81

SimpleXMLElement::registerXPathNamespaceメソッドは、PHPでXML文書内の名前空間付き要素をXPathクエリで正確に検索するために使用されます。XML文書では、同じタグ名でも異なる名前空間に属する要素を区別するために、プレフィックスとURIの組み合わせで名前空間を定義します。しかし、SimpleXMLElementがXPathクエリを実行するだけでは、この名前空間の関連付けが自動的に行われないため、事前に登録が必要です。

このメソッドには二つの引数があります。第一引数$prefixにはXPathクエリで使用したい名前空間のプレフィックス（例: bk）を、第二引数$namespaceにはそのプレフィックスが示す名前空間URI（例: http://www.example.com/books）を指定します。メソッドは処理が成功すればtrueを、失敗すればfalseを返します。

サンプルコードでは、まずbkというプレフィックスを持つ名前空間付きのXMLを扱います。registerXPathNamespaceを呼び出して名前空間を登録する前は、//bk:bookというXPathクエリでは目的の要素が見つかりません。しかし、registerXPathNamespace('bk', 'http://www.example.com/books')を呼び出して名前空間を登録すると、その後の//bk:bookクエリで名前空間付きのbk:book要素が正しく検索され、取得できるようになります。この登録は、名前空間を持たない通常の要素の検索には影響しません。これにより、複雑なXML構造でも特定の名前空間の要素を正確に操作できるようになります。

Copy
1<?php
2
3// XMLデータ文字列を定義します。このXMLは名前空間 'book' を使用しています。
4$xmlString = <<<XML
5<?xml version="1.0" encoding="UTF-8"?>
6<library xmlns:book="http://example.com/books">
7    <book:item>
8        <book:title>PHP入門</book:title>
9        <book:author>山田 太郎</book:author>
10    </book:item>
11    <book:item>
12        <book:title>実践PHP開発</book:title>
13        <book:author>田中 花子</book:author>
14    </book:item>
15    <magazine>Web開発のヒント</magazine>
16</library>
17XML;
18
19// SimpleXMLElementオブジェクトを作成し、XMLデータを読み込みます。
20$sxe = new SimpleXMLElement($xmlString);
21
22// XPathクエリで名前空間を使用するために、名前空間プレフィックスを登録します。
23// 最初の引数 'book' は、XPathクエリ内で使用するプレフィックスです。
24// 2番目の引数 'http://example.com/books' は、XML内で定義されている名前空間URIです。
25$registered = $sxe->registerXPathNamespace('book', 'http://example.com/books');
26
27// 名前空間の登録が成功したかを確認します。
28if ($registered) {
29    echo "名前空間プレフィックス 'book' が正常に登録されました。\n\n";
30
31    // 登録された名前空間プレフィックス 'book' を使用して、
32    // XPathクエリで<book:title>要素を検索します。
33    // 名前空間が登録されていない場合、このXPathクエリでは要素が見つかりません。
34    $titles = $sxe->xpath('//book:title');
35
36    if ($titles) {
37        echo "見つかった書籍のタイトル:\n";
38        foreach ($titles as $title) {
39            // 見つかった要素の内容を表示します。
40            echo "- " . (string)$title . "\n";
41        }
42    } else {
43        echo "指定された名前空間を持つ書籍のタイトルは見つかりませんでした。\n";
44    }
45
46} else {
47    echo "名前空間プレフィックス 'book' の登録に失敗しました。\n";
48}
49

このPHPコードは、XMLデータから特定の情報を抽出する際に、名前空間が定義されている場合に必要となるSimpleXMLElement::registerXPathNamespaceメソッドの使い方を初心者向けに示しています。

まず、名前空間bookを持つXMLデータをSimpleXMLElementオブジェクトとして読み込みます。次に、registerXPathNamespaceメソッドを呼び出し、XPathクエリで利用するプレフィックスを登録します。このメソッドの第一引数$prefixにはXPathで使う短い名前（例: 'book'）を指定し、第二引数$namespaceにはXML内で定義されている名前空間のURI（例: 'http://example.com/books'）を正確に渡します。これにより、両者が関連付けられます。メソッドの戻り値は`bool`型で、登録が成功した場合は`true`、失敗した場合は`false`を返します。

サンプルコードでは、'book'というプレフィックスを登録した後、//book:titleというXPathクエリを使用して、book名前空間に属する全ての書籍タイトルを検索し、その内容を表示しています。このregisterXPathNamespaceによる登録がなければ、名前空間を持つ要素はXPathクエリでは見つけられないため、このメソッドはXML処理において重要な役割を果たします。