DOMXPath::evaluate
与えられた XPath 式を評価し、可能であれば結果を返す
説明
public mixed DOMXPath::evaluate(string $expression, DOMNodenull $contextNode = null, bool $registerNodeNS = true)
パラメータ
-
expression
-
実行する XPath 式。
-
contextNode
-
相対 XPath クエリを実行する場合に、オプションで基準ノードを指定することが可能です。
デフォルトでは、クエリは root 要素に対する相対パスとなります。
-
registerNodeNS
-
コンテキストノードのスコープ内の名前空間を、DOMXPath オブジェクトに自動登録するかどうか。
このオプションを使うと、スコープ内の名前空間ごとに、手動で DOMXPath::registerNamespace をコールする必要がなくなります。
名前空間のプレフィックスが衝突した場合は、直近の子孫の名前空間プレフィックスのみが登録されます。
エラー / 例外
PHP のコールバックを呼び出す式を使う際は、
以下のエラーが発生する可能性があります。
-
PHP のコールバックを呼び出しているのにコールバックが登録されていなかったり、
名前付きコールバックが登録されていない場合、
Error がスローされます。
-
php:function を使っていて、
ハンドラ名が文字列でない場合、
TypeError がスローされます。
-
DOM でないオブジェクトがコールバックから返された場合、
Error がスローされます。
戻り値
可能であれば型付けされた結果、あるいは指定された XPath 式
expression にマッチするすべてのノードを含む
DOMNodeList を返します。
expression が不正な形式な場合や
contextNode が無効な場合は、
DOMXPath::evaluate は false を返します。
例
例1 英語の書籍の数を取得する
<?php
$doc = new DOMDocument;
$doc->load('examples/book-dcobook.xml');
$xpath = new DOMXPath($doc);
$tbody = $doc->getElementsByTagName('tbody')->item(0);
// tbody ノードを基準とした相対クエリとなります
$query = 'count(row/entry[. = "en"])';
$entries = $xpath->evaluate($query, $tbody);
echo "There are $entries english books\n";
?>
There are 2 english books