mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
123 lines
3.1 KiB
XML
123 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="sphinxclient.setsortmode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>SphinxClient::setSortMode</refname>
|
|
<refpurpose>Set matches sorting mode</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>SphinxClient::setSortMode</methodname>
|
|
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>sortby</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets matches sorting mode. See available modes below.
|
|
<table>
|
|
<title>Sorting modes</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Constant</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>SPH_SORT_RELEVANCE</entry>
|
|
<entry>Sort by relevance in descending order (best matches first).</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SPH_SORT_ATTR_DESC</entry>
|
|
<entry>Sort by an attribute in descending order (bigger attribute
|
|
values first).</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SPH_SORT_ATTR_ASC</entry>
|
|
<entry>Sort by an attribute in ascending order (smaller attribute
|
|
values first).</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SPH_SORT_TIME_SEGMENTS</entry>
|
|
<entry>Sort by time segments (last hour/day/week/month) in descending
|
|
order, and then by relevance in descending order.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SPH_SORT_EXTENDED</entry>
|
|
<entry>Sort by SQL-like combination of columns in ASC/DESC order.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SPH_SORT_EXPR</entry>
|
|
<entry>Sort by an arithmetic expression.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Sorting mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>sortby</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><xref linkend="sphinxclient.setmatchmode" /></member>
|
|
<member><xref linkend="sphinxclient.setsortmode" /></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|