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

<phpdoc:classref xml:id="class.solrdocument" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SolrDocument class</title>
 <titleabbrev>SolrDocument</titleabbrev>

 <partintro>

<!-- {{{ SolrDocument intro -->
  <section xml:id="solrdocument.intro">
   &reftitle.intro;
   <para>
    Represents a Solr document retrieved from a query response.
   </para>
  </section>
<!-- }}} -->

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

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

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>SolrDocument</classname>
     </ooclass>
     
     <oointerface>
      <interfacename>ArrayAccess</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Iterator</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Serializable</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrdocument.constants.sort-default">SolrDocument::SORT_DEFAULT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrdocument.constants.sort-asc">SolrDocument::SORT_ASC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrdocument.constants.sort-desc">SolrDocument::SORT_DESC</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrdocument.constants.sort-field-name">SolrDocument::SORT_FIELD_NAME</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrdocument.constants.sort-field-value-count">SolrDocument::SORT_FIELD_VALUE_COUNT</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="solrdocument.constants.sort-field-boost-value">SolrDocument::SORT_FIELD_BOOST_VALUE</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrdocument')/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.solrdocument')/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.solrdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])"/>
   </classsynopsis>
<!-- }}} -->

  </section>

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

    <varlistentry xml:id="solrdocument.constants.sort-default">
     <term><constant>SolrDocument::SORT_DEFAULT</constant></term>
     <listitem>
      <para>Default mode for sorting fields within the document.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrdocument.constants.sort-asc">
     <term><constant>SolrDocument::SORT_ASC</constant></term>
     <listitem>
      <para>Sorts the fields in ascending order</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrdocument.constants.sort-desc">
     <term><constant>SolrDocument::SORT_DESC</constant></term>
     <listitem>
      <para>Sorts the fields in descending order</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrdocument.constants.sort-field-name">
     <term><constant>SolrDocument::SORT_FIELD_NAME</constant></term>
     <listitem>
      <para>Sorts the fields by field name.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrdocument.constants.sort-field-value-count">
     <term><constant>SolrDocument::SORT_FIELD_VALUE_COUNT</constant></term>
     <listitem>
      <para>Sorts the fields by number of values in each field.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="solrdocument.constants.sort-field-boost-value">
     <term><constant>SolrDocument::SORT_FIELD_BOOST_VALUE</constant></term>
     <listitem>
      <para>Sorts the fields by thier boost values.</para>
     </listitem>
    </varlistentry>

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


 </partintro>

 &reference.solr.entities.solrdocument;

</phpdoc:classref>

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