PHP - Manual: DOMXPath

2024-12-21

DOMXPath::__construct »

« DOMText::splitText

The DOMXPath class

(PHP 5, PHP 7, PHP 8)

简介

Supports XPath 1.0

类摘要

class DOMXPath {

/* 属性 */

public readonly DOMDocument $document;

public bool $registerNodeNamespaces;

/* 方法 */

public __construct(DOMDocument $document, bool $registerNodeNS = true)

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

public query(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed

public registerNamespace(string $prefix, string $namespace): bool

public registerPhpFunctions(string|array|null $restrict = null): void

}

属性

document
registerNodeNamespaces: When set to true, namespaces in the node are registered.

更新日志

版本	说明
8.0.0	The `registerNodeNamespaces` property has been added.

DOMXPath::__construct — Creates a new DOMXPath object
DOMXPath::evaluate — Evaluates the given XPath expression and returns a typed result if possible
DOMXPath::query — Evaluates the given XPath expression
DOMXPath::registerNamespace — Registers the namespace with the DOMXPath object
DOMXPath::registerPhpFunctions — Register PHP functions as XPath functions

add a note

User Contributed Notes 7 notes

down

Mark Omohundro, ajamyajax dot com ¶

13 years ago


<?php
// to retrieve selected html data, try these DomXPath examples:

$file = $DOCUMENT_ROOT. "test.html";
$doc = new DOMDocument();
$doc->loadHTMLFile($file);

$xpath = new DOMXpath($doc);

// example 1: for everything with an id
//$elements = $xpath->query("//*[@id]");

// example 2: for node data in a selected id
//$elements = $xpath->query("/html/body/div[@id='yourTagIdHere']");

// example 3: same as above with wildcard
$elements = $xpath->query("*/div[@id='yourTagIdHere']");

if (!is_null($elements)) {
  foreach ($elements as $element) {
    echo "<br/>[". $element->nodeName. "]";

    $nodes = $element->childNodes;
    foreach ($nodes as $node) {
      echo $node->nodeValue. "\n";
    }
  }
}
?>

down

TechNyquist ¶

2 years ago


When working with XML (as a strict format) might be very important to give a namespace to XPath object in order to make it work properly.


I was experiencing "query" always returning empty node lists, it could not find anything. Only a broad "//*" was able to show off only the root element.


Then found out that registering the namespace reported in the "xmlns" attribute of the root element in the XPath object, and writing the namespace near the elements name, made it work properly.


So for an XML like this (from a sitemap):


<?xml version="1.0" encoding="UTF-8"?>

<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">

    <url>

        <loc>http://example.com/index.php</loc>

        <lastmod>2005-01-01</lastmod>

        <changefreq>monthly</changefreq>

        <priority>0.5</priority>

    </url>

</urlset>


I needed the following XPath configuration:


<?php


    $doc = new DOMDocument;

    $doc->load("sitemap.xml");

    $xpath = new DOMXPath($doc);

    $xpath->registerNamespace('ns', 'http://www.sitemaps.org/schemas/sitemap/0.9');

    $nodes = $xpath->query('//ns:urlset/ns:url');


?>



Then again, that "xmlns" could be provided dynamically from the root element attribute of course.

down

peter at softcoded dot com ¶

5 years ago


Using XPath expressions can save a lot of programming
and allow you to home in on only the nodes you want.
Suppose you want to delete all empty <p> tags.
If you create a query using the following XPath expression,
you can find <p> tags that do not have any text
(other than spaces), any attributes,
any children or comments:

$expression = "//p[not(@*)  
   and not(*) 
   and not(./comment())
   and normalize-space(text())='']";
   
This expression will only find para tags that look like:

<p>[any number of spaces]</p>
<p></p>

Imagine the code you would have to add if you used
DOMDocument::getElementsByTagName("p") instead.

down

peter at softcoded dot com ¶

5 years ago


You may not always know at runtime whether your file has
a namespace or not. This can make it difficult to create
XPath queries. Use the seriously underdocumented
"namespaceURI" property of the documentElement of a
DOMDocument to determine if there is a namespace.
Use code such as the following:

$doc = new DOMDocument();
$doc->load($file);
$xpath = new DOMXPath($doc);
$ns = $doc->documentElement->namespaceURI;
if($ns) {
  $xpath->registerNamespace("ns", $ns);
  $nodes = $xpath->query("//ns:em[@class='glossterm']");
} else {
  $nodes = $xpath->query("//em[@class='glossterm']");
}
//look at nodes here

down

-3

archimedix32783262 at mailinator dot com ¶

7 years ago


Note that evaluate() will use the same encoding as the XML document.

So if you have a UTF-16 XML, you will have to query using UTF-16 strings.

You can use iconv() to convert from your code's encoding to the target encoding for better legibility.

down

-25

dhz ¶

11 years ago


I just spent far too much time chasing this one....

When running an xpath query on a table be careful about table internal nodes (ie: <tr></tr>, and <td></td>).  If the master <table> tag is missing, then query() (and likely evaluate() also) will return unexpected results.

I had a DOMNode with a structure like this:

<td>
    <table></table>
    <table>
        <tr>
            <td></td>
        </tr>
        <tr>
            <td></td>
            <td></td>
        </tr>
    </table>
</td>

Upon which I was trying to do a relative query (ie: <?php $xpath_obj->query('my/x/path', $relative_node); ?>).

But because of the lone outer <td></td> tags, the inner tags were being invalidated, while the nodes were still recognized.  Meaning that the following query would work:

<?php $xpath_obj->query('*[2]/*[*[2]]', $relative_node); ?>

But when replacing any of the "*" tokens with the corresponding (and valid) "table", "tr", or "td" tokens the query would inexplicably break.

down

-57

david at lionhead dot nl ¶

12 years ago


When using DOMXPath and having a default namespace. Consider using an intermediate function to add the default namespace to all queries:


<?php

// The default namespace: x:xmlns="http://..."

$path="/Book/Title";

$path=preg_replace("\/([a-zA-Z])","/x:$1",$path);


// Result: /x:Book/x:Title

?>

add a note

官方地址：https://www.php.net/manual/en/class.domxpath.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络数据库 JAVA 面试 NoSQL C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 PHP 8.1 adodb手册 ADORecordSet对象 opcache预加载 Composer的Packagist资源 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet mysql面试题 PHP json解析（json_decode）页面工具支持php7的性能采集扩展 [原创]诡异的php-fpm超时问题 Packagist / Composer 中国全量镜像 php中几种注释规范纯php实现DES以及TripleDES加密算法 php 修改图片大小

略微加速

PHP官方手册 - 互联网笔记

The DOMXPath class

简介

类摘要

属性

更新日志

目录

User Contributed Notes 7 notes