PHP DOM: использование XPath

Вы уже видели, как функционирует count() . Давайте использовать функцию id() чтобы вернуть названия книг с указанными номерами ISBN. Вы должны использовать выражение XPath:

  id ("isbn1234 isbn1235") / название 

Обратите внимание, что значения, которые вы ищете, заключены в кавычки и разделены пробелом; нет необходимости использовать запятую для разделения терминов.

 <?php public function findBooksByISBNs(array $isbns) { $ids = join(" ", $isbns); $query = "id('$ids')/title"; $xpath = new DOMXPath($this->domDocument); $result = $xpath->query($query); $books = array(); foreach ($result as $node) { $book = array("title" => $booknode->nodeValue); $books[] = $book; } return $books; } 

Выполнение сложных функций в XPath относительно просто; Хитрость заключается в том, чтобы ознакомиться с доступными функциями.

Использование функций PHP с XPath

Иногда вы можете обнаружить, что вам нужны более широкие функциональные возможности, которые стандартные функции XPath не могут предоставить. К счастью, PHP DOM также позволяет вам включать собственные функции PHP в запрос XPath.

Давайте рассмотрим возвращение количества слов в названии книги. В его простейшей функции мы могли бы написать метод следующим образом:

 <?php public function getNumberOfWords($isbn) { $query = "//library/book[@isbn = '$isbn']"; $xpath = new DOMXPath($this->domDocument); $result = $xpath->query($query); $title = $result->item(0)->getElementsByTagName("title") ->item(0)->nodeValue; return str_word_count($title); } 

Но мы также можем включить функцию str_word_count() непосредственно в запрос XPath. Есть несколько шагов, которые необходимо выполнить, чтобы сделать это. Прежде всего, мы должны зарегистрировать пространство имен с объектом XPath. PHP-функциям в запросах XPath предшествует «php: functionString», а затем имя функции, которую вы хотите использовать, заключено в скобки. Кроме того, пространство имен, которое должно быть определено, является http://php.net/xpath . Пространство имен должно быть установлено на это; любые другие значения приведут к ошибкам. Затем нам нужно вызвать registerPHPFunctions() который сообщает PHP, что всякий раз, когда он сталкивается с пространством имен функции с расширением «php:», это должен обрабатывать PHP.

Фактический синтаксис для вызова функции:

  php: functionString ("nameoffunction", arg, arg ...) 

Объединение всего этого приводит к следующей переопределению getNumberOfWords() :

 <?php public function getNumberOfWords($isbn) { $xpath = new DOMXPath($this->domDocument); //register the php namespace $xpath->registerNamespace("php", "http://php.net/xpath"); //ensure php functions can be called within xpath $xpath->registerPHPFunctions(); $query = "php:functionString('str_word_count',(//library/book[@isbn = '$isbn']/title))"; return $xpath->evaluate($query); } 

Обратите внимание, что вам не нужно вызывать функцию XPath text() для предоставления текста узла. Метод registerPHPFunctions() делает это автоматически. Однако следующее также верно:

  php: functionString ('str_word_count', (// библиотека / книга [@isbn = '$ isbn'] / title [text ()])) 

Регистрация функций PHP не ограничивается функциями, которые поставляются с PHP. Вы можете определять свои собственные функции и предоставлять их в XPath. Единственное отличие состоит в том, что при определении функции вы используете «php: function», а не «php: functionString». Кроме того, можно предоставлять только функции самостоятельно или статическими методами. Вызов методов экземпляра не поддерживается.

Давайте использовать обычную функцию, которая выходит за рамки класса, чтобы продемонстрировать основные функциональные возможности. Функция, которую мы будем использовать, будет возвращать только книги Джорджа Оруэлла. Он должен возвращать true для каждого узла, который вы хотите включить в запрос.

 <?php function compare($node) { return $node[0]->nodeValue == "George Orwell"; } 

Аргумент, переданный функции, является массивом элементов DOMElement . Функция выполняет итерацию по массиву и определяет, следует ли возвращать проверяемый узел в DOMNodeList . В этом примере проверяется узел /book и мы используем /author для определения.

Теперь мы можем создать метод getGeorgeOrwellBooks() :

 <?php public function getGeorgeOrwellBooks() { $xpath = new DOMXPath($this->domDocument); $xpath->registerNamespace("php", "http://php.net/xpath"); $xpath->registerPHPFunctions(); $query = "//library/book[php:function('compare', author)]"; $result = $xpath->query($query); $books = array(); foreach($result as $node) { $books[] = $node->getElementsByTagName("title") ->item(0)->nodeValue; } return $books; } 

Если compare() был статический метод, вам нужно было бы изменить запрос XPath так, чтобы он читался следующим образом:

  // библиотека / книга [php: function ('Библиотека :: сравнить', автор)] 

По правде говоря, все эти функции можно легко кодировать только с помощью XPath, но пример показывает, как можно расширить запросы XPath, чтобы сделать их более сложными.

Вызов метода объекта невозможен в XPath. Если вы обнаружите, что вам нужен доступ к некоторым свойствам объекта или методам для выполнения запроса XPath, лучшим решением будет сделать то, что вы можете с XPath, а затем по мере необходимости работать с результирующим DOMNodeList с любыми методами или свойствами объекта.

Резюме

XPath — это отличный способ сократить объем кода, который необходимо написать, и ускорить выполнение кода при работе с данными XML. Хотя это и не является частью официальной спецификации DOM, дополнительная функциональность, предоставляемая PHP DOM, позволяет расширять обычные функции XPath пользовательскими функциями. Это очень мощная функция, и с ростом вашего знакомства с функциями XPath вы можете все меньше и меньше полагаться на это.

Изображение через Fotolia