与えられた XPath 式を評価する

# DOMXPath::query

(PHP 5, PHP 7)

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

### 説明

public DOMXPath::query ( string `$expression` [, DOMNode `$contextnode` [, bool `$registerNodeNS` = true ]] ) : DOMNodeList

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

### パラメータ

`expression`

  実行する XPath 式。

`contextnode`

  相対 XPath クエリを実行する場合に、オプションで基準ノードを指定することが可能です。 デフォルトでは、クエリは root 要素に対する相対パスとなります。

`registerNodeNS`

  オプションの `registerNodeNS` で、 コンテキストノードの自動登録を無効にすることができます。

### 返り値

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

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

### 変更履歴

バージョン | 説明
--- | ---
5.3.3 | `registerNodeNS` パラメータが追加されました。

### 例

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

`<?php
$doc = new DOMDocument;
// 空白に悩まされたくはありません
$doc->preserveWhiteSpace = false;
$doc->Load('book.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('book.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 式を評価し、可能であれば結果を返す