DOMXPath::query

(PHP 5, PHP 7, PHP 8)

DOMXPath::query — 与えられた XPath 式を評価する

説明

public DOMXPath::query(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed

与えられた XPath 式 expression を評価します。

パラメータ

expression: 実行する XPath 式。
contextNode: 相対 XPath クエリを実行する場合に、オプションで基準ノードを指定することが可能です。デフォルトでは、クエリは root 要素に対する相対パスとなります。
registerNodeNS: コンテキストノードのスコープ内の名前空間を、DOMXPath オブジェクトに自動登録するかどうか。このオプションを使うと、スコープ内の名前空間ごとに、手動で DOMXPath::registerNamespace() をコールする必要がなくなります。名前空間のプレフィックスが衝突した場合は、直近の子孫の名前空間プレフィックスのみが登録されます。

戻り値

与えられた XPath 式 expression にマッチするすべてのノードを含む DOMNodeList を返します。ノードを返さない式の場合は、空の DOMNodeList を返します。

expression が不正な形式な場合や contextNode が無効な場合は、 DOMXPath::query() は false を返します。

エラー / 例外

PHP のコールバックを呼び出す式を使う際は、以下のエラーが発生する可能性があります。

PHP のコールバックを呼び出しているのにコールバックが登録されていなかったり、名前付きコールバックが登録されていない場合、 Error がスローされます。
php:function を使っていて、ハンドラ名が文字列でない場合、 TypeError がスローされます。
DOM でないオブジェクトがコールバックから返された場合、 Error がスローされます。

例

例1 すべての英語の書籍を取得する

<?php

$doc = new DOMDocument;

// 空白に悩まされたくはありません
$doc->preserveWhiteSpace = false;

$doc->load('examples/book-docbook.xml');

$xpath = new DOMXPath($doc);

// root 要素から開始します
$query = '//book/chapter/para/informaltable/tgroup/tbody/row/entry[. = "en"]';

$entries = $xpath->query($query);

foreach ($entries as $entry) {
    echo "Found {$entry->previousSibling->previousSibling->nodeValue}," .
         " by {$entry->previousSibling->nodeValue}\n";
}
?>

上の例の出力は以下となります。

Found The Grapes of Wrath, by John Steinbeck
Found The Pearl, by John Steinbeck

式を短くするため、contextNode パラメータを使用することも可能です。

<?php

$doc = new DOMDocument;
$doc->preserveWhiteSpace = false;

$doc->load('examples/book-docbook.xml');

$xpath = new DOMXPath($doc);

$tbody = $doc->getElementsByTagName('tbody')->item(0);

// tbody ノードからの相対クエリです
$query = 'row/entry[. = "en"]';

$entries = $xpath->query($query, $tbody);

foreach ($entries as $entry) {
    echo "Found {$entry->previousSibling->previousSibling->nodeValue}," .
         " by {$entry->previousSibling->nodeValue}\n";
}
?>

参考

DOMXPath::evaluate() - 与えられた XPath 式を評価し、可能であれば結果を返す