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

Дополнительный параметр contextNode указывают для выполнения относительных XPath-запросов. По умолчанию запросы выполняются относительно корневого элемента.

registerNodeNS

Регистрировать ли автоматически префиксы пространства имён в области видимости контекстного узла для объекта DOMXPath. Параметр помогает избегать ручного вызова метода DOMXPath::registerNamespace() для каждого пространства имён в области видимости. Когда префиксы пространства имён конфликтуют, регистрируется только префикс пространства имён близлежащего потомка.

Возвращаемые значения

Метод возвращает объект DOMNodeList, который содержит узлы, которые соответствуют XPath-выражению expression. Выражение, которое не возвращает узлы, вернёт пустой объект DOMNodeList.

Метод DOMXPath::query() вернёт false, если выражение expression построили неправильно или аргумент contextNode содержит неверное значение.

Примеры

Пример #1 Пример получения списка книг на английском

<?php

$doc
= new DOMDocument();

// Не хотим возиться с пробелами
$doc->preserveWhiteSpace = false;

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

$xpath = new DOMXPath($doc);

// Начинаем с корневого элемента
$query = '//book/chapter/para/informaltable/tgroup/tbody/row/entry[. = "en"]';

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

foreach (
$entries as $entry) {
echo
"Метод нашёл книгу {$entry->previousSibling->previousSibling->nodeValue}," .
" автор {$entry->previousSibling->nodeValue}\n"
;
}

?>

Результат выполнения приведённого примера:

Метод нашёл книгу The Grapes of Wrath, автор John Steinbeck
Метод нашёл книгу The Pearl, автор 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
"Найдена книга {$entry->previousSibling->previousSibling->nodeValue}," .
" автор {$entry->previousSibling->nodeValue}\n"
;
}

?>

Смотрите также

  • DOMXPath::evaluate() - Вычисляет переданное выражение XPath и возвращает типизированный результат, если возможно