php-doc-en/reference/sphinx/sphinxclient/setmatchmode.xml
Torben Wilson af4410a7e1 Normalized the sgml-default-dtd-file local-variable line for those
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
2009-09-25 07:04:39 +00:00

118 lines
3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sphinxclient.setmatchmode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SphinxClient::setMatchMode</refname>
<refpurpose>Set full-text query matching mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SphinxClient::setMatchMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Sets full-text query matching mode. <parameter>mode</parameter> is one of
the constants listed below.
<table>
<title>Match modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>SPH_MATCH_ALL</entry>
<entry>Match all query words (default mode).</entry>
</row>
<row>
<entry>SPH_MATCH_ANY</entry>
<entry>Match any of query words.</entry>
</row>
<row>
<entry>SPH_MATCH_PHRASE</entry>
<entry>Match query as a phrase, requiring perfect match.</entry>
</row>
<row>
<entry>SPH_MATCH_BOOLEAN</entry>
<entry>Match query as a boolean expression.</entry>
</row>
<row>
<entry>SPH_MATCH_EXTENDED</entry>
<entry>Match query as an expression in Sphinx internal query language.</entry>
</row>
<row>
<entry>SPH_MATCH_FULLSCAN</entry>
<entry>Enables fullscan.</entry>
</row>
<row>
<entry>SPH_MATCH_EXTENDED2</entry>
<entry>The same as <constant>SPH_MATCH_EXTENDED</constant> plus ranking
and quorum searching support.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Matching mode.
</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.setrankingmode" /></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
-->