<!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 the search and get the results</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="swishresults.seekresult.html">SwishResults::seekResult</a></div> <div class="next" style="text-align: right; float: right;"><a href="swishsearch.resetlimit.html">SwishSearch::resetLimit</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="swishsearch.execute" class="refentry"> <div class="refnamediv"> <h1 class="refname">SwishSearch::execute</h1> <p class="verinfo">(PECL swish >= 0.1.0)</p><p class="refpurpose"><span class="refname">SwishSearch::execute</span> — <span class="dc-title">Execute the search and get the results</span></p> </div> <div class="refsect1 description" id="refsect1-swishsearch.execute-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><strong>SwishSearch::execute</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"> Searches the index file(s) based on the parameters set in the search object. </p> </div> <div class="refsect1 parameters" id="refsect1-swishsearch.execute-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"> The query string is an optional parameter, it can be also set using <span class="function"><a href="swish.prepare.html" class="function">Swish::prepare()</a></span> method. The query string is preserved between executions, so you can set it once, but execute the search multiple times. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-swishsearch.execute-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-swishsearch.execute-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-swishsearch.execute-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4743"> <p><strong>Example #1 Basic <span class="function"><strong>SwishSearch::execute()</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">$search </span><span style="color: #007700">= </span><span style="color: #0000BB">$swish</span><span style="color: #007700">-></span><span style="color: #0000BB">prepare</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">$results </span><span style="color: #007700">= </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(</span><span style="color: #DD0000">"query"</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"First query 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 /> </span><span style="color: #0000BB">$results </span><span style="color: #007700">= </span><span style="color: #0000BB">$search</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(</span><span style="color: #DD0000">"new OR query"</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Second query 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> First query found: 2 hits Second query found: 12 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="swishresults.seekresult.html">SwishResults::seekResult</a></div> <div class="next" style="text-align: right; float: right;"><a href="swishsearch.resetlimit.html">SwishSearch::resetLimit</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>