solrquery.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.solrquery" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SolrQuery class</title>
 <titleabbrev>SolrQuery</titleabbrev>

 <partintro>

<!-- {{{ SolrQuery intro -->
  <section xml:id="solrquery.intro">
   &reftitle.intro;
   <para>
    Represents a collection of name-value pairs sent to the Solr server during a request.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="solrquery.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>SolrQuery</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>SolrQuery</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>SolrModifiableParams</classname>
     </ooclass>
     
     <oointerface>
      <interfacename>Serializable</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrquery.constants.order-asc">SolrQuery::ORDER_ASC</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrquery.constants.order-desc">SolrQuery::ORDER_DESC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrquery.constants.facet-sort-index">SolrQuery::FACET_SORT_INDEX</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrquery.constants.facet-sort-count">SolrQuery::FACET_SORT_COUNT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrquery.constants.terms-sort-index">SolrQuery::TERMS_SORT_INDEX</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrquery.constants.terms-sort-count">SolrQuery::TERMS_SORT_COUNT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>

    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrquery')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrquery')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrquery')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])"/>
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrmodifiableparams')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])"/>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrmodifiableparams')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[1])"/>

   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ SolrQuery constants -->
  <section xml:id="solrquery.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="solrquery.constants.order-asc">
     <term><constant>SolrQuery::ORDER_ASC</constant></term>
     <listitem>
      <para>Used to specify that the sorting should be in acending order</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrquery.constants.order-desc">
     <term><constant>SolrQuery::ORDER_DESC</constant></term>
     <listitem>
      <para>Used to specify that the sorting should be in descending order</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrquery.constants.facet-sort-index">
     <term><constant>SolrQuery::FACET_SORT_INDEX</constant></term>
     <listitem>
      <para>Used to specify that the facet should sort by index</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrquery.constants.facet-sort-count">
     <term><constant>SolrQuery::FACET_SORT_COUNT</constant></term>
     <listitem>
      <para>Used to specify that the facet should sort by count</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrquery.constants.terms-sort-index">
     <term><constant>SolrQuery::TERMS_SORT_INDEX</constant></term>
     <listitem>
      <para>Used in the TermsComponent</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrquery.constants.terms-sort-count">
     <term><constant>SolrQuery::TERMS_SORT_COUNT</constant></term>
     <listitem>
      <para>Used in the TermsComponent</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.solr.entities.solrquery;

</reference>

<!-- 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
-->