文字

SimpleXMLElement::xpath

(PHP 5 >= 5.2.0)

SimpleXMLElement::xpathRuns XPath query on XML data

说明

public array SimpleXMLElement::xpath ( string $path )

The xpath method searches the SimpleXML node for children matching the XPath path.

参数

path

An XPath path

返回值

Returns an array of SimpleXMLElement objects or FALSE in case of an error.

范例

Example #1 Xpath

<?php
$string 
= <<<XML
<a>
 <b>
  <c>text</c>
  <c>stuff</c>
 </b>
 <d>
  <c>code</c>
 </d>
</a>
XML;

$xml  = new  SimpleXMLElement ( $string );


$result  $xml -> xpath ( '/a/b/c' );

while(list( , 
$node ) =  each ( $result )) {
    echo 
'/a/b/c: ' , $node , "\n" ;
}


$result  $xml -> xpath ( 'b/c' );

while(list( , 
$node ) =  each ( $result )) {
    echo 
'b/c: ' , $node , "\n" ;
}
?>

以上例程会输出:

/a/b/c: text
/a/b/c: stuff
b/c: text
b/c: stuff

Notice that the two results are equal.

参见

  • SimpleXMLElement::registerXPathNamespace() - Creates a prefix/ns context for the next XPath query
  • SimpleXMLElement::getDocNamespaces() - Returns namespaces declared in document
  • SimpleXMLElement::getNamespaces() - Returns namespaces used in document
  • Basic SimpleXML usage

用户评论:

[#1] Anonymous [2015-01-30 05:30:36]

As mentioned already xpath will fail is the default namespace 'xmlns' is used like in:

<?php

$xmlstring 
$string = <<<XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
<fileVersion appName="xl" />
</workbook>
XML;
?>

xpath cannot search through the xml without explicitly specifying a namespace.
There are 2 options :
1. rename the 'xmlns' into something else to trick xpath into believing that no default namespace is defined.
2. register a string as the default namespace and use that string in all your queries. Unfortunatly, an empty space will not work.
No other option currently exist until XPath2.0 becomes the default library.

[#2] leonjanzen at gmail dot com [2014-10-19 19:48:47]

To run an xpath query on an XML document that has a namespace, the namespace must be registered with SimpleXMLElement::registerXPathNamespace() before running the query. If the XML document namespace does not include a prefix, you must make up an arbitrary one, and then use it in your query.

<?php
$strXml
= <<<XML
<?xml version="1.0" encoding="UTF-8"?>

<mydoc xmlns="http://www.url.com/myns">
    <message>Test message</message>
</mydoc>
XML;

$xmlDoc=new \SimpleXMLElement($strXml);

foreach($xmlDoc->getDocNamespaces() as $strPrefix => $strNamespace) {
    if(strlen($strPrefix)==0) {
        $strPrefix="a"; //Assign an arbitrary namespace prefix.
    }
    $xmlDoc->registerXPathNamespace($strPrefix,$strNamespace);
}

print($xmlDoc->xpath("//a:message")[0]); //Use the arbitrary namespace prefix in the query.
?>

This will output:

Test message

[#3] BenjaminBeck at gmx dot de [2014-09-13 13:36:43]

If you want to search multiple values from xml on the behalf or one value then this code can be helpfull to you. 

if there is: 
<Record> 
  <country>Pakistan</country> 
  <code>+92</code> 
  <Value>100<Value> 
</Record> 

then try this one: 
<?php 
$sxe 
=  simplexml_load_file("countries.XML"); 
foreach(
$sxe->xpath('//RECORD') as $item) { 

    
$v $row->xpath('./country[. ="Pakistan"]'); 
    if(
$v[0]){ 
        print 
$item->country
        print 
$item->code
        print 
$item->value
    } 
    

?>

[#4] yetihehe at yetihehe dot com [2011-01-12 02:21:58]

Xpath actually knows which element is root regardless of element on which you execute it. Example:

<?php

$string 
= <<<XML
<a>
 <b>
  <c>text</c>
  <c>stuff</c>
 </b>
 <b>
  <c>code</c>
 </b>
</a>
XML;

header('content-type: text/plain');

$xml = new SimpleXMLElement($string);

//relative to root
$b0=$xml->b[0]->xpath('//c');
while(list( , 
$node) = each($b0)) {
    echo 
'b[0]: //c: ',$node,"\n";
}

$b1=$xml->b[1]->xpath('//c');
while(list( , 
$node) = each($b1)) {
    echo 
'b[1]: //c: ',$node,"\n";
}

echo 
"\n";

//relative to current element
$b0=$xml->b[0]->xpath('.//c');
while(list( , 
$node) = each($b0)) {
    echo 
'b[0]: .//c: ',$node,"\n";
}

$b1=$xml->b[1]->xpath('.//c');
while(list( , 
$node) = each($b1)) {
    echo 
'b[1]: .//c: ',$node,"\n";
}

?>


Will return:
b[0]: //c: text
b[0]: //c: stuff
b[0]: //c: code
b[1]: //c: text
b[1]: //c: stuff
b[1]: //c: code

b[0]: .//c: text
b[0]: .//c: stuff
b[1]: .//c: code

[#5] stefan at efectos dot nl [2010-11-09 02:33:32]

Having problems selecting information through xpath when there are namespaces in the XML? 

Try this quick and dirty solution, but it works:

<?php
$objImageXml 
= new SimpleXMLElement($objImageXml->asXML());
?>

[#6] grummfy at gmail dot com [2010-02-11 04:08:32]

On a xml that have namespace you need to do this before your xpath request (or empty array will be return) :

<?php
$string 
str_replace('xmlns=''ns='$string); //$string is a string that contains xml...
?>

[#7] DrupalFocus at earthlink dot net [2009-12-02 12:27:55]

Looks like the relative path is relative to the SimpleXMLElement object that you call the Xpath() method on.  Basically chopping off the root element.

<?php
$string 
= <<<XML
<foo>
  <bar>
    <a>
     <b>
      <c>text</c>
      <c>stuff</c>
     </b>
     <d>
      <c>code</c>
     </d>
    </a>
  </bar>
</foo>
XML;

$xml = new SimpleXMLElement($string);

$result $xml->xpath('a/b/c');
if (
$result
foreach(
$result as $node) {
    
drupal_set_message(t('a/b/c: @node.', array('@node' => $node)));
}
else
  
drupal_set_message(t('a/b/c: failed.'));
                     

$bar $xml->bar;
$result $bar->xpath('a/b/c');
foreach(
$result as $node) {
    
drupal_set_message(t('bar->a/b/c: @node.', array('@node' => $node)));
}
?>


results in :
#
# a/b/c: failed.
# bar->a/b/c: text.
# bar->a/b/c: stuff.

[#8] behnam@zwnj [2009-09-24 13:34:43]

Seems like this function cannot return the result of XPath string() [1] function.  For example if you query xpath("string(a/@b)") you will get bool(false) although the node "a" may have the attribute "b" set to a non-empty string.

[1] http://www.w3.org/TR/xpath#section-String-Functions

[#9] Anti Veeranna [2009-06-17 03:50:22]

Whether it returns a false or empty array for a non-existing path seems to depend on libxml version.

I tried the following code:

<?php
$data 
'<foo><bar></bar></foo>';
$xml simplexml_load_string($data);
print 
gettype($xml->xpath('/first/second'));
?>


On a machine with libxml 2.6.16 and PHP 5.2.8 I got back boolean. On a different machine with libxml 2.7.3 and PHP 5.2.8/5.2.9 I got back empty array.

You can check the libxml version from command line by executing: php --ri libxml

or simply look at phpinfo() output

[#10] arealzone-czernobyl at yahoo dot de [2009-06-11 15:23:51]

The simplest way to count nodes in a XML doc:

<?php
$xml 
= new SimpleXMLElement($xmlstr);

$xmlNode $xml->xpath('root/yourNodeName');
$nodeCount count($xmlNode);

echo 
$nodeCount;
?>

[#11] anemik [2008-07-02 15:46:39]

If you want to find easly all records satisfying some condition in XML data like 

....
   <book id="bk101">
      <author>Gambardella, Matthew</author>
      <title>XML Developer's Guide</title>
      <genre>Computer</genre>
      <price>44.95</price>
   </book>
   <book id="bk102">
      <author>Ralls, Kim</author>
      <title>Midnight Rain</title>
      <genre>Fantasy</genre>
      <price>5.95</price>
   </book>
...

try example below

<?php

$xmlStr 
file_get_contents('data/books.xml');
$xml = new SimpleXMLElement($xmlStr);
// seach records by tag value:
// find all book records with price higher than 40$
$res $xml->xpath("book/price[.>'40']/parent::*");
print_r($res);

?>


You will see response like:
Array (
[0] => SimpleXMLElement Object
        (
            [@attributes] => Array
                (
                    [id] => bk101
                )

            [author] => Gambardella, Matthew
            [title] => XML Developer's Guide
            [genre] => Computer
            [price] => 44.95
            [publish_date] => 2000-10-01
            [description] => An in-depth look at creating applications 
      with XML.
        )
...

[#12] paul at pmtlogic dot com [2008-06-18 12:17:44]

xpath doesn't seem to be able to handle single quotes embedded in the query itself. For instance, I want to find geo coordinates in an xml file based on country name. 

xml snippet:

<zones>
<zone country="Cote d'Ivoire" fullName="Yamoussoukro" geo="6.82,-5.28" id="1050"><url prefix="1001" value="fiji.html" /><url prefix="1002" value="C" /></zone>
</zones>

The following code does not work:

<?php
$xml 
simplexml_load_file("my.xml");
$result $xml->xpath("//zone[@country='Cote d\'Ivoire']");

foreach ( 
$result[0]->attributes() as $key => $val ) {
    print 
"<div class='coords'>$key$val</div>\n";
}
?>


I have tried many variations on the embedded single quote (i.e. escape codes) but with no result. W3C offers no explanation either. 

In addition, there doesn't seem to be any way of embedding wildcards in the attribute value (you can embed wildcards in the attribute name). Otherwise the following might be a reasonable substitute in this context:

<?php $result = $xml->xpath("//zone[@country='Cote d*Ivoire']"); ?>

[#13] canuemail at gmail dot com [2008-05-05 05:05:48]

If you want to search multiple values from xml on the behalf or one value then this code can be helpfull to you.

if there is:
<Record>
  <country>Pakistan</country>
  <code>+92</code>
  <Value>100<Value>
</Record>

then try this one:
<?php
$sxe 
=  simplexml_load_file("countries.XML");
foreach(
$sxe->xpath('//RECORD') as $item) {

    
$row simplexml_load_string($item->asXML());
    
$v $row->xpath('//country[. ="Pakistan"]');
    if(
$v[0]){
        print 
$item->country;
        print 
$item->code;
        print 
$item->value;
    }
    
}
?>

[#14] Hugh [2005-12-18 15:23:19]

Note that this function does not ALWAYS return an array. It seems that if the specified path is not found in the document, it will return false. You need to check for the false value before using foreach, if you wish to avoid a warning (and often to handle errors or control program flow in this situation).

[#15] drewish at katherinehouse dot com [2005-07-10 18:16:03]

xpath() can also be used to select elements by their attributes. For a good XPath reference check out: http://www.w3schools.com/xpath/xpath_syntax.asp

<?php
$string 
= <<<XML
<sizes>
    <size label="Square" width="75" height="75" />
    <size label="Thumbnail" width="100" height="62" />
    <size label="Small" width="112" height="69" />
    <size label="Large" width="112" height="69" />
</sizes>
XML;

$xml simplexml_load_string($string);
$result $xml->xpath("//size[@label='Large']");

// print the first (and only) member of the array
echo $result[0]->asXml();
?>


The script would print: 
<size label="Large" width="112" height="69"/>

上一篇: 下一篇: