<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Evaluates the given XPath expression</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="domxpath.evaluate.html">DOMXPath::evaluate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="domxpath.registernamespace.html">DOMXPath::registerNamespace</a></div>
<div class="up"><a href="class.domxpath.html">DOMXPath</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="domxpath.query" class="refentry">
<div class="refnamediv">
<h1 class="refname">DOMXPath::query</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">DOMXPath::query</span> — <span class="dc-title">
Evaluates the given XPath expression
</span></p>
</div>
<div class="refsect1 description" id="refsect1-domxpath.query-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.domnodelist.html" class="type DOMNodeList">DOMNodeList</a></span> <span class="methodname"><strong>DOMXPath::query</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$expression</code></span>
[, <span class="methodparam"><span class="type"><a href="class.domnode.html" class="type DOMNode">DOMNode</a></span> <code class="parameter">$contextnode</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$registerNodeNS</code><span class="initializer"> = true</span></span>
]] )</div>
<p class="para rdfs-comment">
Executes the given XPath <em><code class="parameter">expression</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-domxpath.query-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">expression</code></em></span>
<dd>
<p class="para">
The XPath expression to execute.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">contextnode</code></em></span>
<dd>
<p class="para">
The optional <em><code class="parameter">contextnode</code></em> can be specified for
doing relative XPath queries. By default, the queries are relative to
the root element.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">registerNodeNS</code></em></span>
<dd>
<p class="para">
The optional <em><code class="parameter">registerNodeNS</code></em> can be specified to
disable automatic registration of the context node.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-domxpath.query-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a <a href="class.domnodelist.html" class="classname">DOMNodeList</a> containing all nodes matching
the given XPath <em><code class="parameter">expression</code></em>. Any expression which
does not return nodes will return an empty
<a href="class.domnodelist.html" class="classname">DOMNodeList</a>.
</p>
<p class="para">
If the <em><code class="parameter">expression</code></em> is malformed or the
<em><code class="parameter">contextnode</code></em> is invalid,
<span class="methodname"><strong>DOMXPath::query()</strong></span> returns <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-domxpath.query-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.3.3</td>
<td>
The <em><code class="parameter">registerNodeNS</code></em> parameter was added.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-domxpath.query-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5434">
<p><strong>Example #1 Getting all the english books</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$doc </span><span style="color: #007700">= new </span><span style="color: #0000BB">DOMDocument</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// We don't want to bother with white spaces<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">preserveWhiteSpace </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">Load</span><span style="color: #007700">(</span><span style="color: #DD0000">'book.xml'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$xpath </span><span style="color: #007700">= new </span><span style="color: #0000BB">DOMXPath</span><span style="color: #007700">(</span><span style="color: #0000BB">$doc</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// We starts from the root element<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">'//book/chapter/para/informaltable/tgroup/tbody/row/entry[. = "en"]'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$entries </span><span style="color: #007700">= </span><span style="color: #0000BB">$xpath</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$entries </span><span style="color: #007700">as </span><span style="color: #0000BB">$entry</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Found </span><span style="color: #007700">{</span><span style="color: #0000BB">$entry</span><span style="color: #007700">-></span><span style="color: #0000BB">previousSibling</span><span style="color: #007700">-></span><span style="color: #0000BB">previousSibling</span><span style="color: #007700">-></span><span style="color: #0000BB">nodeValue</span><span style="color: #007700">}</span><span style="color: #DD0000">," </span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">" by </span><span style="color: #007700">{</span><span style="color: #0000BB">$entry</span><span style="color: #007700">-></span><span style="color: #0000BB">previousSibling</span><span style="color: #007700">-></span><span style="color: #0000BB">nodeValue</span><span style="color: #007700">}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Found The Grapes of Wrath, by John Steinbeck
Found The Pearl, by John Steinbeck
</pre></div>
</div>
<div class="example-contents"><p>
We can also use the <em><code class="parameter">contextnode</code></em> parameter to shorten
our expression:
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$doc </span><span style="color: #007700">= new </span><span style="color: #0000BB">DOMDocument</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">preserveWhiteSpace </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">load</span><span style="color: #007700">(</span><span style="color: #DD0000">'book.xml'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$xpath </span><span style="color: #007700">= new </span><span style="color: #0000BB">DOMXPath</span><span style="color: #007700">(</span><span style="color: #0000BB">$doc</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$tbody </span><span style="color: #007700">= </span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">getElementsByTagName</span><span style="color: #007700">(</span><span style="color: #DD0000">'tbody'</span><span style="color: #007700">)-></span><span style="color: #0000BB">item</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// our query is relative to the tbody node<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">'row/entry[. = "en"]'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$entries </span><span style="color: #007700">= </span><span style="color: #0000BB">$xpath</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">, </span><span style="color: #0000BB">$tbody</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$entries </span><span style="color: #007700">as </span><span style="color: #0000BB">$entry</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Found </span><span style="color: #007700">{</span><span style="color: #0000BB">$entry</span><span style="color: #007700">-></span><span style="color: #0000BB">previousSibling</span><span style="color: #007700">-></span><span style="color: #0000BB">previousSibling</span><span style="color: #007700">-></span><span style="color: #0000BB">nodeValue</span><span style="color: #007700">}</span><span style="color: #DD0000">," </span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">" by </span><span style="color: #007700">{</span><span style="color: #0000BB">$entry</span><span style="color: #007700">-></span><span style="color: #0000BB">previousSibling</span><span style="color: #007700">-></span><span style="color: #0000BB">nodeValue</span><span style="color: #007700">}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-domxpath.query-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="domxpath.evaluate.html" class="methodname" rel="rdfs-seeAlso">DOMXPath::evaluate()</a> - Evaluates the given XPath expression and returns a typed result if possible</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="domxpath.evaluate.html">DOMXPath::evaluate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="domxpath.registernamespace.html">DOMXPath::registerNamespace</a></div>
<div class="up"><a href="class.domxpath.html">DOMXPath</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
