1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 291313 $ -->
<refentry xml:id="sphinxclient.setfilterrange" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SphinxClient::setFilterRange</refname>
<refpurpose>Add new integer range filter</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SphinxClient::setFilterRange</methodname>
<methodparam><type>string</type><parameter>attribute</parameter></methodparam>
<methodparam><type>int</type><parameter>min</parameter></methodparam>
<methodparam><type>int</type><parameter>max</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>exclude</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Adds new integer range filter to the existing list of filters.
Only those documents which have <parameter>attribute</parameter>
value stored in the index between <parameter>min</parameter> and
<parameter>max</parameter> (including values that are exactly equal
to <parameter>min</parameter> or <parameter>max</parameter>) will
be matched (or rejected, if <parameter>exclude</parameter> is &true;).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
An attribute name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>min</parameter></term>
<listitem>
<para>
Minimum value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max</parameter></term>
<listitem>
<para>
Maximum value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>exclude</parameter></term>
<listitem>
<para>
If set to &true;, matching documents are excluded from the result set.
</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.setfilterfloatrange" /></member>
<member><xref linkend="sphinxclient.setfilter" /></member>
<member><xref linkend="sphinxclient.resetfilters" /></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
-->
|
