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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SphinxClient" namespace="" name="SphinxClient">
<method name="addQuery" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add query to multi-query batch"/>
<return type="int"/>
</docblock>
<parameter name="query" optional="false" byreference="false" type="string"/>
<parameter name="index" optional="true" byreference="false" type="string"/>
<parameter name="comment" optional="true" byreference="false" type="string"/>
</method>
<method name="buildExcerpts" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Build text snippets"/>
<return type="array"/>
</docblock>
<parameter name="docs" optional="false" byreference="false" type="object" class="array"/>
<parameter name="index" optional="false" byreference="false" type="string"/>
<parameter name="words" optional="false" byreference="false" type="string"/>
<parameter name="opts" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="buildKeywords" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Extract keywords from query"/>
<return type="array"/>
</docblock>
<parameter name="query" optional="false" byreference="false" type="string"/>
<parameter name="index" optional="false" byreference="false" type="string"/>
<parameter name="hits" optional="false" byreference="false" type="object" class="bool"/>
</method>
<method name="close" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Closes previously opened persistent connection"/>
<return type="bool"/>
</docblock>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a new SphinxClient object"/>
<return type="void"/>
</docblock>
</constructor>
<method name="escapeString" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Escape special characters"/>
<return type="string"/>
</docblock>
<parameter name="string" optional="false" byreference="false" type="string"/>
</method>
<method name="getLastError" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the last error message"/>
<return type="string"/>
</docblock>
</method>
<method name="getLastWarning" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the last warning"/>
<return type="string"/>
</docblock>
</method>
<method name="open" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Opens persistent connection to the server"/>
<return type="bool"/>
</docblock>
</method>
<method name="query" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Execute search query"/>
<return type="array"/>
</docblock>
<parameter name="query" optional="false" byreference="false" type="string"/>
<parameter name="index" optional="true" byreference="false" type="string"/>
<parameter name="comment" optional="true" byreference="false" type="string"/>
</method>
<method name="resetFilters" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clear all filters"/>
<return type="void"/>
</docblock>
</method>
<method name="resetGroupBy" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clear all group-by settings"/>
<return type="void"/>
</docblock>
</method>
<method name="runQueries" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Run a batch of search queries"/>
<return type="array"/>
</docblock>
</method>
<method name="setArrayResult" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change the format of result set array"/>
<return type="bool"/>
</docblock>
<parameter name="array_result" optional="false" byreference="false" type="object" class="bool"/>
</method>
<method name="setConnectTimeout" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set connection timeout"/>
<return type="bool"/>
</docblock>
<parameter name="timeout" optional="false" byreference="false" type="object" class="float"/>
</method>
<method name="setFieldWeights" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set field weights">Binds per-field weights by name.</description>
<return type="bool"/>
</docblock>
<parameter name="weights" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="setFilter" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add new integer values set filter"/>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="string"/>
<parameter name="values" optional="false" byreference="false" type="object" class="array"/>
<parameter name="exclude" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="setFilterFloatRange" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add new float range filter"/>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="string"/>
<parameter name="min" optional="false" byreference="false" type="object" class="float"/>
<parameter name="max" optional="false" byreference="false" type="object" class="float"/>
<parameter name="exclude" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="setFilterRange" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add new integer range filter"/>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="string"/>
<parameter name="min" optional="false" byreference="false" type="int"/>
<parameter name="max" optional="false" byreference="false" type="int"/>
<parameter name="exclude" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="setGeoAnchor" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set anchor point for a geosphere distance calculations">Sets anchor point for a geosphere distance (geodistance) calculations and enables them.</description>
<return type="bool"/>
</docblock>
<parameter name="attrlat" optional="false" byreference="false" type="string"/>
<parameter name="attrlong" optional="false" byreference="false" type="string"/>
<parameter name="latitude" optional="false" byreference="false" type="object" class="float"/>
<parameter name="longitude" optional="false" byreference="false" type="object" class="float"/>
</method>
<method name="setGroupBy" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set grouping attribute">Sets grouping attribute, function, and group sorting mode, and enables grouping.</description>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="string"/>
<parameter name="func" optional="false" byreference="false" type="int"/>
<parameter name="groupsort" optional="true" byreference="false" type="string"/>
</method>
<method name="setGroupDistinct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set attribute name for per-group distinct values count calculations"/>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="string"/>
</method>
<method name="setIDRange" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a range of accepted document IDs"/>
<return type="bool"/>
</docblock>
<parameter name="min" optional="false" byreference="false" type="int"/>
<parameter name="max" optional="false" byreference="false" type="int"/>
</method>
<method name="setIndexWeights" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set per-index weights"/>
<return type="bool"/>
</docblock>
<parameter name="weights" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="setLimits" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set offset and limit of the result set"/>
<return type="bool"/>
</docblock>
<parameter name="offset" optional="false" byreference="false" type="int"/>
<parameter name="limit" optional="false" byreference="false" type="int"/>
<parameter name="max_matches" optional="true" byreference="false" type="int"/>
<parameter name="cutoff" optional="true" byreference="false" type="int"/>
</method>
<method name="setMatchMode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set full-text query matching mode"/>
<return type="bool"/>
</docblock>
<parameter name="mode" optional="false" byreference="false" type="int"/>
</method>
<method name="setMaxQueryTime" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set maximum query time"/>
<return type="bool"/>
</docblock>
<parameter name="qtime" optional="false" byreference="false" type="int"/>
</method>
<method name="setOverride" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets temporary per-document attribute value overrides"/>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="string"/>
<parameter name="type" optional="false" byreference="false" type="int"/>
<parameter name="values" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="setRankingMode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set ranking mode"/>
<return type="bool"/>
</docblock>
<parameter name="ranker" optional="false" byreference="false" type="int"/>
</method>
<method name="setRetries" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set retry count and delay">Sets distributed retry count and delay.</description>
<return type="bool"/>
</docblock>
<parameter name="count" optional="false" byreference="false" type="int"/>
<parameter name="delay" optional="true" byreference="false" type="int"/>
</method>
<method name="setSelect" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set select clause"/>
<return type="bool"/>
</docblock>
<parameter name="clause" optional="false" byreference="false" type="string"/>
</method>
<method name="setServer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set searchd host and port"/>
<return type="bool"/>
</docblock>
<parameter name="server" optional="false" byreference="false" type="string"/>
<parameter name="port" optional="false" byreference="false" type="int"/>
</method>
<method name="setSortMode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set matches sorting mode"/>
<return type="bool"/>
</docblock>
<parameter name="mode" optional="false" byreference="false" type="int"/>
<parameter name="sortby" optional="true" byreference="false" type="string"/>
</method>
<method name="status" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Queries searchd status"/>
<return type="array"/>
</docblock>
</method>
<method name="updateAttributes" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Update document attributes"/>
<return type="int"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="string"/>
<parameter name="attributes" optional="false" byreference="false" type="object" class="array"/>
<parameter name="values" optional="false" byreference="false" type="object" class="array"/>
<parameter name="mva" optional="true" byreference="false" type="object" class="bool"/>
</method>
</class>
|
