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

# DOMXPath::evaluate

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

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

### Описание

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

Метод выполняет XPath-выражение `expression` и возвращает типизированный результат, если это возможно.

### Список параметров

`expression`

  Выражение в формате XPath, которое требуется выполнить.

`contextNode`

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

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

### Ошибки

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

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

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

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

Метод DOMXPath::evaluate() возвращает значение `false`, если выражение `expression` сформировали неправильно или в параметр `contextNode` передали недопустимый узел.

### Примеры

Пример #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 "Файл содержит $entries английских книги\n";

    ?>

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

    Файл содержит 2 английских книги

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

- DOMXPath::query() - Вычисляет XPath-выражение

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open