<!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>Sends a query to the server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.ping.html">SolrClient::ping</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.request.html">SolrClient::request</a></div>
<div class="up"><a href="class.solrclient.html">SolrClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrclient.query" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrClient::query</h1>
<p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrClient::query</span> — <span class="dc-title">Sends a query to the server</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrclient.query-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.solrqueryresponse.html" class="type SolrQueryResponse">SolrQueryResponse</a></span> <span class="methodname"><strong>SolrClient::query</strong></span>
( <span class="methodparam"><span class="type"><a href="class.solrparams.html" class="type SolrParams">SolrParams</a></span> <code class="parameter">$query</code></span>
)</div>
<p class="para rdfs-comment">
Sends a query to the server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrclient.query-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">query</code></dt>
<dd>
<p class="para">
A <span class="type"><a href="class.solrparams.html" class="type SolrParams">SolrParams</a></span> object. It is recommended to use <span class="type"><a href="class.solrquery.html" class="type SolrQuery">SolrQuery</a></span> for advanced queries.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrclient.query-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a <span class="type"><a href="class.solrqueryresponse.html" class="type SolrQueryResponse">SolrQueryResponse</a></span> object on success and throws an exception on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-solrclient.query-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.solrclientexception.html" class="classname">SolrClientException</a> if the client had failed, or there was a connection issue.
</p>
<p class="para">
Throws <a href="class.solrserverexception.html" class="classname">SolrServerException</a> if the Solr Server had failed to satisfy the query.
</p>
</div>
<div class="refsect1 examples" id="refsect1-solrclient.query-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5882">
<p><strong>Example #1 <span class="methodname"><strong>SolrClient::query()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$options </span><span style="color: #007700">= array<br />(<br /> </span><span style="color: #DD0000">'hostname' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'login' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'username'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'password' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'password'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'port' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'8983'</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrClient</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrQuery</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$query</span><span style="color: #007700">-></span><span style="color: #0000BB">setQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'lucene'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query</span><span style="color: #007700">-></span><span style="color: #0000BB">setStart</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query</span><span style="color: #007700">-></span><span style="color: #0000BB">setRows</span><span style="color: #007700">(</span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query</span><span style="color: #007700">-></span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'cat'</span><span style="color: #007700">)-></span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'features'</span><span style="color: #007700">)-></span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'id'</span><span style="color: #007700">)-></span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'timestamp'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query_response </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</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 /></span><span style="color: #0000BB">$response </span><span style="color: #007700">= </span><span style="color: #0000BB">$query_response</span><span style="color: #007700">-></span><span style="color: #0000BB">getResponse</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
SolrObject Object
(
[responseHeader] => SolrObject Object
(
[status] => 0
[QTime] => 3
[params] => SolrObject Object
(
[fl] => cat,features,id,timestamp
[indent] => on
[start] => 0
[q] => lucene
[wt] => xml
[version] => 2.2
[rows] => 50
)
)
[response] => SolrObject Object
(
[numFound] => 1
[start] => 0
[docs] => Array
(
[0] => SolrObject Object
(
[id] => SOLR1000
[cat] => Array
(
[0] => software
[1] => search
)
[features] => Array
(
[0] => Advanced Full-Text Search Capabilities using Lucene
[1] => Optimized for High Volume Web Traffic
[2] => Standards Based Open Interfaces - XML and HTTP
[3] => Comprehensive HTML Administration Interfaces
[4] => Scalability - Efficient Replication to other Solr Search Servers
[5] => Flexible and Adaptable with XML configuration and Schema
[6] => Good unicode support: héllo (hello with an accent over the e)
)
)
)
)
)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.ping.html">SolrClient::ping</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.request.html">SolrClient::request</a></div>
<div class="up"><a href="class.solrclient.html">SolrClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
