sort.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 734ddd27ada5fdc8fbd2724e4c9e08881649dec1 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="solrdocument.sort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SolrDocument::sort</refname>
  <refpurpose>Trie les champs du document</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>SolrDocument::sort</methodname>
   <methodparam><type>int</type><parameter>sortOrderBy</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>sortDirection</parameter><initializer>SolrDocument::SORT_ASC</initializer></methodparam>
  </methodsynopsis>
  <para>
 <![CDATA[
   Les champs sont triés suivant les critères spécifiés et la direction de tri
   
   Les champs peuvent être triés par leurs valeurs, leurs noms ou leurs nombres de valeurs.
   
   Le paramètre sortOrderBy peut être une constante parmi :
   
   * SolrDocument::SORT_FIELD_NAME
   * SolrDocument::SORT_FIELD_BOOST_VALUE
   * SolrDocument::SORT_FIELD_VALUE_COUNT
   
   sortDirection peut être une constante parmi :
   
   * SolrDocument::SORT_DEFAULT
   * SolrDocument::SORT_ASC
   * SolrDocument::SORT_DESC
   
   La direction par défaut est ASC.
]]>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>sortOrderBy</parameter></term>
     <listitem>
      <para>
       Le critère de tri.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sortDirection</parameter></term>
     <listitem>
      <para>
       La direction du tri.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

</refentry>

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