Source of: /manual/en/function.hwapi-find.php


<?php

include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';

$TOC = array();

$PARENTS = array();

include_once dirname(__FILE__) ."/toc/ref.hwapi.inc";

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.hwapi-find.php',

    1 => 'hw_api->find',

  ),

  'up' => 

  array (

    0 => 'ref.hwapi.php',

    1 => 'Hyperwave API Functions',

  ),

  'prev' => 

  array (

    0 => 'function.hwapi-error-reason.php',

    1 => 'hw_api_error->reason',

  ),

  'next' => 

  array (

    0 => 'function.hwapi-ftstat.php',

    1 => 'hw_api->ftstat',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.hwapi-find" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">hw_api-&gt;find</h1>

  <p class="verinfo">(PHP 4, PHP 5 &lt; 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api-&gt;find</span> &mdash; <span class="dc-title">Search for objects</span></p>



 </div>

 

 <a name="function.hwapi-find.description"></a><div class="refsect1 description">

  <h3 class="title">Description</h3>

  <div class="classsynopsis">

   <div class="ooclass"><b class="classname">hw_api</b></div>

   <div class="methodsynopsis dc-description">

    <span class="type">array</span> <span class="methodname"><b>find</b></span>

     ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$parameter</tt></span>

    )</div>



  </div>

  <p class="para">

   This functions searches for objects either by executing a key or/and full

   text query. The found objects can further be filtered by an optional

   object query. They are sorted by their importance. The second search

   operation is relatively slow and its result can be limited to a certain

   number of hits. This allows to perform an incremental search, each

   returning just a subset of all found documents, starting at a given

   index. 

  </p>

 </div>





 <a name="function.hwapi-find.parameters"></a><div class="refsect1 parameters">

  <h3 class="title">Parameters</h3>

  <p class="para">

   </p><dl>



    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">parameter</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The parameter array contains the &#039;keyquery&#039; or/and &#039;fulltextquery&#039;

       depending on who you would like to search. Optional parameters are

       &#039;objectquery&#039;, &#039;scope&#039;, &#039;languages&#039; and &#039;attributeselector&#039;. In case

       of an incremental search the optional parameters &#039;startIndex&#039;,

       &#039;numberOfObjectsToGet&#039; and &#039;exactMatchUnit&#039; can be passed.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





 <a name="function.hwapi-find.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="para">

   

  </p>

 </div>





</div><?php manual_footer(); ?>
Our source is open

Source of: /manual/en/function.hwapi-find.php
