PHP の関数を XPath 関数として登録する

# DOMXPath::registerPhpFunctions

(PHP 5 >= 5.3.0, PHP 7)

DOMXPath::registerPhpFunctions — PHP の関数を XPath 関数として登録する

### 説明

public DOMXPath::registerPhpFunctions ([ mixed `$restrict` ] ) : void

このメソッドは、PHP の関数を XPath 式の中で使えるようにします。

### パラメータ

`restrict`

  このパラメータを使って、特定の関数のみを XPath からコールできるように制限することができます。

  このパラメータには、文字列 (関数名) あるいは関数名の配列を指定します。

### 返り値

値を返しません。

### 例

次の例では、以下のような内容の book.xml を使います。

例1 book.xml

    <?xml version="1.0" encoding="UTF-8"?>
    <books>
     <book>
      <title>PHP Basics</title>
      <author>Jim Smith</author>
      <author>Jane Smith</author>
     </book>
     <book>
      <title>PHP Secrets</title>
      <author>Jenny Smythe</author>
     </book>
     <book>
      <title>XML basics</title>
      <author>Joe Black</author>
     </book>
    </books>

例2 DOMXPath::registerPHPFunctions() と php:functionString の例

`<?php
$doc = new DOMDocument;
$doc->load('book.xml');
$xpath = new DOMXPath($doc);
// 名前空間 php: を登録します (必須)
$xpath->registerNamespace("php", "http://php.net/xpath");
// PHP の関数を登録します (無制限)
$xpath->registerPHPFunctions();
// substr 関数を book の title に適用します
$nodes = $xpath->query('//book[php:functionString("substr", title, 0, 3) = "PHP"]');
echo "Found {$nodes->length} books starting with 'PHP':\n";
foreach ($nodes as $node) {
$title = $node->getElementsByTagName("title")->item(0)->nodeValue;
$author = $node->getElementsByTagName("author")->item(0)->nodeValue;
echo "$title by $author\n";
}
?>`

上の例の出力は、 たとえば以下のようになります。

    Found 2 books starting with 'PHP':
    PHP Basics by Jim Smith
    PHP Secrets by Jenny Smythe

例3 DOMXPath::registerPHPFunctions() と php:function の例

`<?php
$doc = new DOMDocument;
$doc->load('book.xml');
$xpath = new DOMXPath($doc);
// 名前空間 php: を登録します (必須)
$xpath->registerNamespace("php", "http://php.net/xpath");
// PHP の関数を登録します (has_multiple 限定)
$xpath->registerPHPFunctions("has_multiple");
function has_multiple($nodes) {
// author が複数ある場合に true を返します
return count($nodes) > 1;
}
// 複数の author がいる book のみを取り出します
$books = $xpath->query('//book[php:function("has_multiple", author)]');
echo "Books with multiple authors:\n";
foreach ($books as $book) {
echo $book->getElementsByTagName("title")->item(0)->nodeValue . "\n";
}
?>`

上の例の出力は、 たとえば以下のようになります。

    Books with multiple authors:
    PHP Basics

### 参考

- DOMXPath::registerNamespace() - DOMXPath オブジェクトの名前空間を登録する
- DOMXPath::query() - 与えられた XPath 式を評価する
- DOMXPath::evaluate() - 与えられた XPath 式を評価し、可能であれば結果を返す