DOMXPath::registerPhpFunctionNS

(PHP >= 8.4.0)

DOMXPath::registerPhpFunctionNS — Регистрирует PHP-функции как XPath-функции с пространством имён

Описание

public DOMXPath::registerPhpFunctionNS(string $namespaceURI, string $name, callable $callable): void

Метод разрешает вызывать PHP-функцию как с XPath-функцию с пространством имён внутри XPath-выражений.

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

namespaceURI: URI-идентификатор пространства имён.
name: Локальное название функции внутри пространства имён.
callable: PHP-функция, которую требуется вызвать при вызове XPath-функции внутри XPath-выражения. Список узлов передаётся в callback-функцию в виде массива, элементы которого соответствуют DOM-узлам.

Ошибки

Метод выбрасывает ошибку ValueError, если название callback-функции недопустимо.
Метод выбрасывает ошибку ValueError, если аргумент options содержит недопустимые параметры.
Метод выбрасывает ошибку ValueError, если в аргументе overrideEncoding передали неизвестную кодировку.
Метод выбрасывает ошибку TypeError, если значение для обратного вызова не принадлежит типу callable.

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

Функция не возвращает значения после выполнения.

Примеры

Пример #1 Пример регистрации XPath-функции в пространстве имён и вызова этой функции из XPath-выражения

<?php

$xml = <<<EOB
<books>
<book>
 <title>PHP Basics</title>
 <author>Jim Smith</author>
 <author>Jane Smith</author>
</book>
<book>
 <title>PHP Secrets</title>
 <author>Jenny Smythe</author>
</book>
<book>
 <title>XML basics</title>
 <author>Joe Black</author>
</book>
</books>
EOB;

$doc = new DOMDocument();
$doc->loadXML($xml);

$xpath = new DOMXPath($doc);

// Обязательная регистрация пространства имён с префиксом 'my'
$xpath->registerNamespace("my", "urn:my.ns");

// Регистрация PHP-функции
$xpath->registerPHPFunctionNS(
    'urn:my.ns',
    'substring',
    fn (array $arg1, int $start, int $length) => substr($arg1[0]->textContent, $start, $length)
);

// Вызов функции substr на названии книги
$nodes = $xpath->query('//book[my:substring(title, 0, 3) = "PHP"]');

echo "Функция нашла {$nodes->length} книги, название которых начинается с 'PHP':\n";
foreach ($nodes as $node) {
   $title  = $node->getElementsByTagName("title")->item(0)->nodeValue;
   $author = $node->getElementsByTagName("author")->item(0)->nodeValue;
   echo "$title by $author\n";
}

?>

Вывод приведённого примера будет похож на:

Функция нашла 2 книги, название которых начинается с 'PHP':
PHP Basics by Jim Smith
PHP Secrets by Jenny Smythe

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

DOMXPath::registerNamespace() - Регистрирует пространство имён с объектом DOMXPath
DOMXPath::query() - Вычисляет XPath-выражение
DOMXPath::evaluate() - Вычисляет XPath-выражение и возвращает типизированный результат, если возможно
XSLTProcessor::registerPHPFunctions() - Разрешает вызывать PHP-функции как XSLT-функции
XSLTProcessor::registerPHPFunctionNS() - Регистрирует PHP-функцию как XSLT-функцию с пространством имён