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

『registerPhpFunctionNSメソッドは、XPathクエリ内でPHPの関数を、指定した名前空間を持つカスタム関数として使用できるように登録するメソッドです。』このメソッドを利用することで、XPathの標準機能だけでは複雑になりがちな文字列操作や計算などの処理を、使い慣れたPHPの関数で簡潔に記述できるようになります。メソッド名の「NS」が示す通り、名前空間（Namespace）を指定して関数を登録する点が特徴です。第1引数にXPath式で使う名前空間の接頭辞（プレフィックス）、第2引数にその名前空間を一意に識別するためのURI、第3引数以降に登録したいPHPの関数名を文字列として渡します。これにより、例えば php という接頭辞で関数を登録した場合、XPath式の中で php:my_function() のような形で呼び出せます。名前空間を利用することで、標準のXPath関数や他のカスタム関数との名前の衝突を確実に避けることができ、コードの可読性や保守性が向上します。この機能は、XML文書の操作において、PHPの柔軟性とXPathの強力な選択能力を組み合わせるための重要な役割を果たします。

Copy
1<?php
2
3// 評価対象のXMLドキュメントを作成
4$xmlString = <<<XML
5<users>
6    <user>Alice</user>
7    <user>BOB</user>
8    <user>Charlie</user>
9</users>
10XML;
11
12$dom = new \Dom\Document();
13$dom->loadXML($xmlString);
14$xpath = new \Dom\XPath($dom);
15
16// XPath式から呼び出すためのPHP関数を定義します
17function to_lower(string $text): string
18{
19    return strtolower($text);
20}
21
22// "myfunc"というプレフィックスでPHPの関数をXPathに登録します
23// 第1引数: XPath式で使う名前空間のプレフィックス
24// 第2引数: 名前空間を識別するための一意なURI
25// 第3引数: 登録するPHPの関数名
26$xpath->registerPhpFunctionNS('myfunc', 'http://example.com/php/functions', 'to_lower');
27
28// 登録した関数 myfunc:to_lower() を使ってクエリを実行し、
29// テキストノードを小文字に変換して "bob" と一致するuser要素を検索します
30$query = '//user[myfunc:to_lower(.) = "bob"]';
31$userNode = $xpath->query($query)->item(0);
32
33// "BOB" という値を持つノードが取得されます
34echo $userNode->textContent;
35
36?>

string $namespaceURI, string $name, callable $callable

• string $namespaceURI: 登録するPHP関数の名前空間URIを指定する文字列
• string $name: 登録するPHP関数の名前を指定する文字列
• callable $callable: 実行するPHP関数を指定するコールバック

void

このメソッドは、PHPの関数をXPathのネームスペースに登録するために使用され、明示的な戻り値はありません。