<!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>Execute a query and return results object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="swish.prepare.html">Swish::prepare</a></div>
<div class="next" style="text-align: right; float: right;"><a href="swishresult.getmetalist.html">SwishResult::getMetaList</a></div>
<div class="up"><a href="ref.swish.html">Swish Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="swish.query" class="refentry">
<div class="refnamediv">
<h1 class="refname">Swish::query</h1>
<p class="verinfo">(PECL swish >= 0.1.0)</p><p class="refpurpose"><span class="refname">Swish::query</span> — <span class="dc-title">Execute a query and return results object</span></p>
</div>
<div class="refsect1 description" id="refsect1-swish.query-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>Swish::query</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
<p class="para">
A quick method to execute a search with default parameters.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-swish.query-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">query</code></em></span>
<dd>
<p class="para">
Query string.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-swish.query-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong class="classname">SwishResults</strong> object.
</p>
</div>
<div class="refsect1 errors" id="refsect1-swish.query-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <strong class="classname">SwishException</strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-swish.query-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4738">
<p><strong>Example #1 Basic <span class="function"><strong>Swish::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 /></span><span style="color: #007700">try {<br /><br /> </span><span style="color: #0000BB">$swish </span><span style="color: #007700">= new </span><span style="color: #0000BB">Swish</span><span style="color: #007700">(</span><span style="color: #DD0000">"index.swish-e"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$results </span><span style="color: #007700">= </span><span style="color: #0000BB">$swish</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"test query"</span><span style="color: #007700">);<br /><br /> echo </span><span style="color: #DD0000">"Found: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$results</span><span style="color: #007700">-></span><span style="color: #0000BB">hits</span><span style="color: #007700">, </span><span style="color: #DD0000">" hits\n"</span><span style="color: #007700">;<br /><br />} catch (</span><span style="color: #0000BB">SwishException $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<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>
Found: 1 hits
</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="swish.prepare.html">Swish::prepare</a></div>
<div class="next" style="text-align: right; float: right;"><a href="swishresult.getmetalist.html">SwishResult::getMetaList</a></div>
<div class="up"><a href="ref.swish.html">Swish Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
