【PHP8.x】Dom\XPath::registerNodeNamespacesプロパティの使い方

『registerNodeNamespacesプロパティは、XPathクエリ実行時にコンテキストノードの名前空間を自動的に登録するかどうかを示す真偽値を保持するプロパティです。このプロパティのデフォルト値はtrueに設定されています。trueの場合、Dom\XPath::query()やDom\XPath::evaluate()メソッドが呼び出されると、クエリの基準となるノード（コンテキストノード）で定義されている名前空間が自動的にXPathエンジンに登録されます。この機能により、開発者はregisterNamespace()メソッドを使用して手動で名前空間を一つずつ登録する手間を省くことができ、XPath式内でXML文書が持つ名前空間接頭辞を直接利用することが可能になります。一方、このプロパティにfalseを設定すると、自動登録機能は無効となり、PHP 8.0より前のバージョンと同じ挙動になります。その場合、XPath式で名前空間を利用するには、registerNamespace()メソッドを使って明示的にすべての名前空間接頭辞とそのURIを登録する必要があります。名前空間の扱いをより簡潔にしたいか、あるいは厳密に手動で管理したいかに応じてこのプロパティの値を変更します。』

Copy
1<?php
2
3// 名前空間を持つXMLデータ
4$xmlString = <<<XML
5<?xml version="1.0" encoding="UTF-8"?>
6<root xmlns:app="http://example.com/app" xmlns:user="http://example.com/user">
7  <app:info>Application Information</app:info>
8  <user:details>
9    <user:name>Taro</user:name>
10  </user:details>
11</root>
12XML;
13
14// DOMDocumentオブジェクトを作成し、XMLを読み込む
15$document = new Dom\Document();
16$document->loadXML($xmlString);
17
18// DOMXPathオブジェクトを作成する
19$xpath = new Dom\XPath($document);
20
21// ドキュメントのルート要素から再帰的に名前空間を登録する
22// 構文: public Dom\XPath::registerNodeNamespaces(DOMNode $node, bool $recursive = true): bool
23$xpath->registerNodeNamespaces($document->documentElement, true);
24
25// 登録した名前空間プレフィックスを使用して要素を取得する
26$userInfo = $xpath->query('//user:name')->item(0);
27
28if ($userInfo) {
29    echo $userInfo->nodeValue; // "Taro" を出力
30}
31
32?>

引数なし

引数はありません

bool

このメソッドは、XPathクエリ内で使用される名前空間を登録します。登録が成功した場合は true を、失敗した場合は false を返します。