php-doc-en/reference/swish/classes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="swish.classes" xmlns="http://docbook.org/ns/docbook">
 &reftitle.classes;
  <section>
   &reftitle.classes;
   <section xml:id="swish.class.swish">
    <title><classname>Swish</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swish.properties">
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>
        <property>indexes</property> - the array of indexes used and their properties. Certain
        list of properties depends on Swish-e version.
       </para>
      </listitem>
     </itemizedlist>
    </section>
    <section xml:id="swish.class.swish.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swish.construct" /> - constructs new
        <classname>Swish</classname> object. 
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swish.prepare" /> - prepares and returns
        <classname>SwishSearch</classname> object.
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swish.query" /> - executes the query and
        returns <classname>SwishResults</classname> object.
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
      <listitem>
       <para><xref linkend="swish.getmetalist" /> - returns an array
       of meta entries for the given index file.</para>
      </listitem>
      <listitem>
       <para><xref linkend="swish.getpropertylist" /> - returns an array
       of properties for the given index file.</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishsearch">
    <title><classname>SwishSearch</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swishsearch.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swishsearch.setstructure" /> - sets the
        structure flag in the search object. This flag is used to limit search
        to certain parts of HTML documents.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.setphrasedelimiter" /> - sets
        the phrase delimiter character. The default delimiter is double-quotes.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.setsort" /> - sets the sort
        order of the results.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.setlimit" /> - sets the limits
        for the search.
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.resetlimit" /> - resets the
        limits.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.execute" /> - executes the
        query and returns <classname>SwishResults</classname> object.
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishresults">
    <title><classname>SwishResults</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swishresults.properties">
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>
        <property>hits</property> - the number of results in this
        <classname>SwishResults</classname> object.
       </para>
      </listitem>
      <listitem>
       <para>
        <property>indexes</property> - the array of indexes used in the search.
       </para>
      </listitem>
     </itemizedlist>
    </section>
    <section xml:id="swish.class.swishresults.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swishresults.nextresult" /> - returns
        next <classname>SwishResult</classname> object or &false; if no
        more results are available.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresults.seekresult" /> - sets the
        current seek position in the <classname>SwishResults</classname>
        object.
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresults.getparsedwords" /> -
        returns an array of words in the query with stopwords removed.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresults.getremovedstopwords" /> -
        returns an array of removed stopwords.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishresult">
    <title><classname>SwishResult</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swishresult.properties">
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>Properties list depends on Swish-e version, see examples.</para>
      </listitem>
     </itemizedlist>
    </section>
    <section xml:id="swish.class.swishresult.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swishresult.getmetalist" /> - returns
        an array of meta entries for the index used in this result.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresult.stem" /> - stems the word
        and returns result as an array of strings.
        Throws <classname>SwishException</classname> on error.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishexception">
    <title><classname>SwishException</classname></title>
    <para>
     <classname>SwishException</classname> extends the built in
     <classname>Exception</classname> class and possesses the same set of 
     properties and methods. See <xref
      linkend="language.exceptions.extending"/> for more details.
    </para>
   </section>
  </section>
</section>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->