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 передали недопустимый узел.

Ошибки

При работе с выражением, в котором вызывают PHP-функции обратного вызова, возникают следующие ошибки:

Метод выбрасывает ошибку Error, если в выражении вызвали PHP-функцию обратного вызова, но ни одной callback-функции не регистрировали, или если callback-функцию с таким названием не зарегистрировали.
Метод выбрасывает ошибку TypeError, если при вызове функции из XPath-выражения синтаксисом php:function вместо строкового названия обработчика передают значение другого типа.
Метод выбрасывает ошибку Error, если callback-функция вместо DOM-объекта возвращает значение другого типа.

Примеры

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

<?php

$doc = new DOMDocument();

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

$doc->load('examples/book-docbook.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('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 "Метод нашёл книгу {$entry->previousSibling->previousSibling->nodeValue}," .
         " автор {$entry->previousSibling->nodeValue}\n"
    ;
}

?>

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

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