DOMXPath::evaluate

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

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

Описание

public 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 английских книги

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

Добавить

Примечания пользователей 5 notes

up
4
daniel at danielnorton dot com
14 years ago
Note that this method does not provide any means to distinguish between a successful result that returns FALSE and an error.For example, this will succeed and return FALSE:<?php $xpath->evaluate("1 = 0"); ?>One workaround when you know you are expecting a Boolean is to wrap the result with string(). e.g.<?php $xpath->evaluate("string(1 = 0)"); ?>This will return a string "false" on success, or the Boolean FALSE on error.
up
4
Damien Bezborodov
14 years ago
If your expression returns a node set, you will get a DOMNodeList instead of a typed result. Instead, try modifying your expression from "//node[1]" to "string(//node[1])".
up
3
yuriucsal at NOSPAM dot yahoo dot com dot br
20 years ago
this class can substitute the method evaluate while it is not validated. Made for Yuri Bastos and Jo�o Gilberto Magalh�es. 

<?php

    class XPtahQuery
    {
        // function returns a DOMNodeList from a relative xPath
        public static function selectNodes($pNode, $xPath) 
        {

            $pos = strpos(self::getFullXpath($pNode),"/",1);
            $xPathQuery = substr(self::getFullXpath($pNode),$pos);//to paste  /#document[1]/
            $xPathQueryFull = $xPathQuery. $xPath;
            $domXPath = new DOMXPath($pNode->ownerDocument);
            $rNodeList = $domXPath->query($xPathQueryFull);

                return $rNodeList;
        }
        // function returns a DOMNode from a xPath from other DOMNode
        public static function selectSingleNode($pNode, $xPath) 
        {

            $pos = strpos(self::getFullXpath($pNode),"/",1);
            $xPathQuery = substr(self::getFullXpath($pNode),$pos);//to paste  /#document[1]/
            $xPathQueryFull = $xPathQuery. $xPath;
            $domXPath = new DOMXPath($pNode->ownerDocument);
            $rNode = $domXPath->query($xPathQueryFull)->item(0);

                return $rNode;
        }
        //utilitaries functions off selectSingleNode
        private function getNodePos($pNode, $nodeName)
        {
            if($pNode == null)
                {
                        return 0;
            }
            else
            {
                $var = 0;
                    if ($pNode->previousSibling != null)
                    {
                    if ($pNode->previousSibling->nodeName == $nodeName)
                    {
                        $var = 1;
                    }
                    }
                    return self::getNodePos($pNode->previousSibling, $nodeName) + $var;
            }
        }
        //utilitaries functions off selectSingleNode
        private function getFullXpath($pNode)
        {
            if($pNode == null)
                {
                        return "";
            }
            else
            {

                return self::getFullXpath($pNode->parentNode) . "/" . $pNode->nodeName . "[" .strval(self::getNodePos($pNode, $pNode->nodeName)+1) . "]";//+1 to get the real xPath index

            }
        }
    }
?>
up
1
aazaharov81 at gmail dot com
10 years ago
To query DOMNodes by their HTML classes, use such snippet<?php// CssClassXPathSelectorfunction ccxs($class) {    return '[contains(concat(" ", normalize-space(@class), " "), " ' . $class . ' ")]';} // then just $domitems = $this->xpath("//*[@id='searchResultsRows']//a" . ccxs('listing_row'));?>
up
1
danny at webdevelopers dot eu
5 years ago
The only way how to distinguish FALSE returned value from syntax error FALSE is to re-run the XPath expression wrapped in string() function. If must return empty string. If it returns FALSE again then it is an error.<?php        $ret=$this->xp->evaluate($eval, $context);        // Error detection: DOMXPath::evaluate() returns FALSE on error         // so does DOMXPath::evaluate("boolean(/nothing)")         // @workaround webdevelopers.eu        if ($ret === false && $this->xp->evaluate("string($eval)", $context) === false) {             throw new Exception("Invalid XPath expression ".json_encode($eval), 3491);        }?>
To Top