@@ -54,208 +54,208 @@ discard block |
||
54 | 54 | */ |
55 | 55 | class OAuth |
56 | 56 | { |
57 | - /** |
|
58 | - * @var bool |
|
59 | - */ |
|
60 | - public $debug; |
|
61 | - |
|
62 | - /** |
|
63 | - * @var bool |
|
64 | - */ |
|
65 | - public $sslChecks; |
|
66 | - |
|
67 | - /** |
|
68 | - * @var array |
|
69 | - */ |
|
70 | - public $debugInfo; |
|
71 | - |
|
72 | - /** |
|
73 | - * Create a new OAuth object |
|
74 | - * @param string $consumer_key |
|
75 | - * @param string $consumer_secret |
|
76 | - * @param string $signature_method |
|
77 | - * @param int $auth_type |
|
78 | - * @throws \OAuthException |
|
79 | - */ |
|
80 | - public function __construct($consumer_key, $consumer_secret, $signature_method = OAUTH_SIG_METHOD_HMACSHA1, $auth_type = OAUTH_AUTH_TYPE_AUTHORIZATION) {} |
|
81 | - |
|
82 | - /** |
|
83 | - * Turn off verbose debugging |
|
84 | - * @return bool |
|
85 | - */ |
|
86 | - public function disableDebug() {} |
|
87 | - |
|
88 | - /** |
|
89 | - * Turn off redirects |
|
90 | - * @return void |
|
91 | - */ |
|
92 | - public function disableRedirects() {} |
|
93 | - |
|
94 | - /** |
|
95 | - * Turn off SSL checks |
|
96 | - * @return bool |
|
97 | - */ |
|
98 | - public function disableSSLChecks() {} |
|
99 | - |
|
100 | - /** |
|
101 | - * Turn on verbose debugging |
|
102 | - * @return bool |
|
103 | - */ |
|
104 | - public function enableDebug() {} |
|
105 | - |
|
106 | - /** |
|
107 | - * Turn on redirects |
|
108 | - * @return bool |
|
109 | - */ |
|
110 | - public function enableRedirects() {} |
|
111 | - |
|
112 | - /** |
|
113 | - * Turn on SSL checks |
|
114 | - * @return bool |
|
115 | - */ |
|
116 | - public function enableSSLChecks() {} |
|
117 | - |
|
118 | - /** |
|
119 | - * Set the timeout |
|
120 | - * @param int $timeout Time in milliseconds |
|
121 | - * @return void |
|
122 | - */ |
|
123 | - public function setTimeout($timeout) {} |
|
124 | - |
|
125 | - /** |
|
126 | - * Fetch an OAuth-protected resource |
|
127 | - * @param string $protected_resource_url |
|
128 | - * @param array $extra_parameters |
|
129 | - * @param string $http_method |
|
130 | - * @param array $http_headers |
|
131 | - * @throws \OAuthException |
|
132 | - * @return mixed |
|
133 | - */ |
|
134 | - public function fetch($protected_resource_url, $extra_parameters = [], $http_method = null, $http_headers = []) {} |
|
135 | - |
|
136 | - /** |
|
137 | - * Fetch an access token |
|
138 | - * @param string $access_token_url |
|
139 | - * @param string $auth_session_handle |
|
140 | - * @param string $verifier_token |
|
141 | - * @throws \OAuthException |
|
142 | - * @return array |
|
143 | - */ |
|
144 | - public function getAccessToken($access_token_url, $auth_session_handle = null, $verifier_token = null) {} |
|
145 | - |
|
146 | - /** |
|
147 | - * Get CA information |
|
148 | - * @return array |
|
149 | - */ |
|
150 | - public function getCAPath() {} |
|
151 | - |
|
152 | - /** |
|
153 | - * Get the last response |
|
154 | - * @return string |
|
155 | - */ |
|
156 | - public function getLastResponse() {} |
|
157 | - |
|
158 | - /** |
|
159 | - * Get headers for last response |
|
160 | - * @return string|false |
|
161 | - */ |
|
162 | - public function getLastResponseHeaders() {} |
|
163 | - |
|
164 | - /** |
|
165 | - * Get HTTP information about the last response |
|
166 | - * @return array |
|
167 | - */ |
|
168 | - public function getLastResponseInfo() {} |
|
169 | - |
|
170 | - /** |
|
171 | - * Generate OAuth header string signature |
|
172 | - * @param string $http_method |
|
173 | - * @param string $url |
|
174 | - * @param mixed $extra_parameters |
|
175 | - * @return string|false |
|
176 | - */ |
|
177 | - public function getRequestHeader($http_method, $url, $extra_parameters = '') {} |
|
178 | - |
|
179 | - /** |
|
180 | - * Fetch a request token |
|
181 | - * @param string $request_token_url |
|
182 | - * @param string $callback_url |
|
183 | - * @param string $http_method |
|
184 | - * @throws \OAuthException |
|
185 | - * @return array |
|
186 | - */ |
|
187 | - public function getRequestToken($request_token_url, $callback_url = null, $http_method = 'GET') {} |
|
188 | - |
|
189 | - /** |
|
190 | - * Set authorization type |
|
191 | - * @param int $auth_type |
|
192 | - * @return bool |
|
193 | - */ |
|
194 | - public function setAuthType($auth_type) {} |
|
195 | - |
|
196 | - /** |
|
197 | - * Set CA path and info |
|
198 | - * @param string $ca_path |
|
199 | - * @param string $ca_info |
|
200 | - * @return mixed |
|
201 | - */ |
|
202 | - public function setCAPath($ca_path = null, $ca_info = null) {} |
|
203 | - |
|
204 | - /** |
|
205 | - * Set the nonce for subsequent requests |
|
206 | - * @param string $nonce |
|
207 | - * @return mixed |
|
208 | - */ |
|
209 | - public function setNonce($nonce) {} |
|
210 | - |
|
211 | - /** |
|
212 | - * @param int $reqengine |
|
213 | - * @return void |
|
214 | - */ |
|
215 | - public function setRequestEngine($reqengine) {} |
|
216 | - |
|
217 | - /** |
|
218 | - * Set the RSA certificate |
|
219 | - * @param string $cert |
|
220 | - * @return mixed |
|
221 | - */ |
|
222 | - public function setRSACertificate($cert) {} |
|
223 | - |
|
224 | - /** |
|
225 | - * Set the timestamp |
|
226 | - * @param string $timestamp |
|
227 | - * @return mixed |
|
228 | - */ |
|
229 | - public function setTimestamp($timestamp) {} |
|
230 | - |
|
231 | - /** |
|
232 | - * Set the token and secret |
|
233 | - * @param string $token |
|
234 | - * @param string $token_secret |
|
235 | - * @return bool |
|
236 | - */ |
|
237 | - public function setToken($token, $token_secret) {} |
|
238 | - |
|
239 | - /** |
|
240 | - * Set the OAuth version |
|
241 | - * @param string $version |
|
242 | - * @return bool |
|
243 | - */ |
|
244 | - public function setVersion($version) {} |
|
57 | + /** |
|
58 | + * @var bool |
|
59 | + */ |
|
60 | + public $debug; |
|
61 | + |
|
62 | + /** |
|
63 | + * @var bool |
|
64 | + */ |
|
65 | + public $sslChecks; |
|
66 | + |
|
67 | + /** |
|
68 | + * @var array |
|
69 | + */ |
|
70 | + public $debugInfo; |
|
71 | + |
|
72 | + /** |
|
73 | + * Create a new OAuth object |
|
74 | + * @param string $consumer_key |
|
75 | + * @param string $consumer_secret |
|
76 | + * @param string $signature_method |
|
77 | + * @param int $auth_type |
|
78 | + * @throws \OAuthException |
|
79 | + */ |
|
80 | + public function __construct($consumer_key, $consumer_secret, $signature_method = OAUTH_SIG_METHOD_HMACSHA1, $auth_type = OAUTH_AUTH_TYPE_AUTHORIZATION) {} |
|
81 | + |
|
82 | + /** |
|
83 | + * Turn off verbose debugging |
|
84 | + * @return bool |
|
85 | + */ |
|
86 | + public function disableDebug() {} |
|
87 | + |
|
88 | + /** |
|
89 | + * Turn off redirects |
|
90 | + * @return void |
|
91 | + */ |
|
92 | + public function disableRedirects() {} |
|
93 | + |
|
94 | + /** |
|
95 | + * Turn off SSL checks |
|
96 | + * @return bool |
|
97 | + */ |
|
98 | + public function disableSSLChecks() {} |
|
99 | + |
|
100 | + /** |
|
101 | + * Turn on verbose debugging |
|
102 | + * @return bool |
|
103 | + */ |
|
104 | + public function enableDebug() {} |
|
105 | + |
|
106 | + /** |
|
107 | + * Turn on redirects |
|
108 | + * @return bool |
|
109 | + */ |
|
110 | + public function enableRedirects() {} |
|
111 | + |
|
112 | + /** |
|
113 | + * Turn on SSL checks |
|
114 | + * @return bool |
|
115 | + */ |
|
116 | + public function enableSSLChecks() {} |
|
117 | + |
|
118 | + /** |
|
119 | + * Set the timeout |
|
120 | + * @param int $timeout Time in milliseconds |
|
121 | + * @return void |
|
122 | + */ |
|
123 | + public function setTimeout($timeout) {} |
|
124 | + |
|
125 | + /** |
|
126 | + * Fetch an OAuth-protected resource |
|
127 | + * @param string $protected_resource_url |
|
128 | + * @param array $extra_parameters |
|
129 | + * @param string $http_method |
|
130 | + * @param array $http_headers |
|
131 | + * @throws \OAuthException |
|
132 | + * @return mixed |
|
133 | + */ |
|
134 | + public function fetch($protected_resource_url, $extra_parameters = [], $http_method = null, $http_headers = []) {} |
|
135 | + |
|
136 | + /** |
|
137 | + * Fetch an access token |
|
138 | + * @param string $access_token_url |
|
139 | + * @param string $auth_session_handle |
|
140 | + * @param string $verifier_token |
|
141 | + * @throws \OAuthException |
|
142 | + * @return array |
|
143 | + */ |
|
144 | + public function getAccessToken($access_token_url, $auth_session_handle = null, $verifier_token = null) {} |
|
145 | + |
|
146 | + /** |
|
147 | + * Get CA information |
|
148 | + * @return array |
|
149 | + */ |
|
150 | + public function getCAPath() {} |
|
151 | + |
|
152 | + /** |
|
153 | + * Get the last response |
|
154 | + * @return string |
|
155 | + */ |
|
156 | + public function getLastResponse() {} |
|
157 | + |
|
158 | + /** |
|
159 | + * Get headers for last response |
|
160 | + * @return string|false |
|
161 | + */ |
|
162 | + public function getLastResponseHeaders() {} |
|
163 | + |
|
164 | + /** |
|
165 | + * Get HTTP information about the last response |
|
166 | + * @return array |
|
167 | + */ |
|
168 | + public function getLastResponseInfo() {} |
|
169 | + |
|
170 | + /** |
|
171 | + * Generate OAuth header string signature |
|
172 | + * @param string $http_method |
|
173 | + * @param string $url |
|
174 | + * @param mixed $extra_parameters |
|
175 | + * @return string|false |
|
176 | + */ |
|
177 | + public function getRequestHeader($http_method, $url, $extra_parameters = '') {} |
|
178 | + |
|
179 | + /** |
|
180 | + * Fetch a request token |
|
181 | + * @param string $request_token_url |
|
182 | + * @param string $callback_url |
|
183 | + * @param string $http_method |
|
184 | + * @throws \OAuthException |
|
185 | + * @return array |
|
186 | + */ |
|
187 | + public function getRequestToken($request_token_url, $callback_url = null, $http_method = 'GET') {} |
|
188 | + |
|
189 | + /** |
|
190 | + * Set authorization type |
|
191 | + * @param int $auth_type |
|
192 | + * @return bool |
|
193 | + */ |
|
194 | + public function setAuthType($auth_type) {} |
|
195 | + |
|
196 | + /** |
|
197 | + * Set CA path and info |
|
198 | + * @param string $ca_path |
|
199 | + * @param string $ca_info |
|
200 | + * @return mixed |
|
201 | + */ |
|
202 | + public function setCAPath($ca_path = null, $ca_info = null) {} |
|
203 | + |
|
204 | + /** |
|
205 | + * Set the nonce for subsequent requests |
|
206 | + * @param string $nonce |
|
207 | + * @return mixed |
|
208 | + */ |
|
209 | + public function setNonce($nonce) {} |
|
210 | + |
|
211 | + /** |
|
212 | + * @param int $reqengine |
|
213 | + * @return void |
|
214 | + */ |
|
215 | + public function setRequestEngine($reqengine) {} |
|
216 | + |
|
217 | + /** |
|
218 | + * Set the RSA certificate |
|
219 | + * @param string $cert |
|
220 | + * @return mixed |
|
221 | + */ |
|
222 | + public function setRSACertificate($cert) {} |
|
223 | + |
|
224 | + /** |
|
225 | + * Set the timestamp |
|
226 | + * @param string $timestamp |
|
227 | + * @return mixed |
|
228 | + */ |
|
229 | + public function setTimestamp($timestamp) {} |
|
230 | + |
|
231 | + /** |
|
232 | + * Set the token and secret |
|
233 | + * @param string $token |
|
234 | + * @param string $token_secret |
|
235 | + * @return bool |
|
236 | + */ |
|
237 | + public function setToken($token, $token_secret) {} |
|
238 | + |
|
239 | + /** |
|
240 | + * Set the OAuth version |
|
241 | + * @param string $version |
|
242 | + * @return bool |
|
243 | + */ |
|
244 | + public function setVersion($version) {} |
|
245 | 245 | } |
246 | 246 | |
247 | 247 | class OAuthException extends Exception |
248 | 248 | { |
249 | - /** |
|
250 | - * The response of the exception which occurred, if any |
|
251 | - * @var string |
|
252 | - */ |
|
253 | - public $lastResponse; |
|
254 | - |
|
255 | - /** |
|
256 | - * @var array |
|
257 | - */ |
|
258 | - public $debugInfo; |
|
249 | + /** |
|
250 | + * The response of the exception which occurred, if any |
|
251 | + * @var string |
|
252 | + */ |
|
253 | + public $lastResponse; |
|
254 | + |
|
255 | + /** |
|
256 | + * @var array |
|
257 | + */ |
|
258 | + public $debugInfo; |
|
259 | 259 | } |
260 | 260 | |
261 | 261 | ; |
@@ -265,99 +265,99 @@ discard block |
||
265 | 265 | */ |
266 | 266 | class OAuthProvider |
267 | 267 | { |
268 | - /** |
|
269 | - * @param string $req_params |
|
270 | - * @return bool |
|
271 | - */ |
|
272 | - final public function addRequiredParameter($req_params) {} |
|
273 | - |
|
274 | - /** |
|
275 | - * @return void |
|
276 | - */ |
|
277 | - public function callconsumerHandler() {} |
|
278 | - |
|
279 | - /** |
|
280 | - * @return void |
|
281 | - */ |
|
282 | - public function callTimestampNonceHandler() {} |
|
283 | - |
|
284 | - /** |
|
285 | - * @return void |
|
286 | - */ |
|
287 | - public function calltokenHandler() {} |
|
288 | - |
|
289 | - /** |
|
290 | - * @param string $uri |
|
291 | - * @param string $method |
|
292 | - * @return void |
|
293 | - */ |
|
294 | - public function checkOAuthRequest($uri = '', $method = '') {} |
|
295 | - |
|
296 | - /** |
|
297 | - * @param array $params_array |
|
298 | - */ |
|
299 | - public function __construct($params_array) {} |
|
300 | - |
|
301 | - /** |
|
302 | - * @param callable $callback_function |
|
303 | - * @return void |
|
304 | - */ |
|
305 | - public function consumerHandler($callback_function) {} |
|
306 | - |
|
307 | - /** |
|
308 | - * @param int $size |
|
309 | - * @param bool $strong |
|
310 | - * @return string |
|
311 | - */ |
|
312 | - final public static function generateToken($size, $strong = false) {} |
|
313 | - |
|
314 | - /** |
|
315 | - * @param mixed $params_array |
|
316 | - * @return void |
|
317 | - */ |
|
318 | - public function is2LeggedEndpoint($params_array) {} |
|
319 | - |
|
320 | - /** |
|
321 | - * @param bool $will_issue_request_token |
|
322 | - * @return void |
|
323 | - */ |
|
324 | - public function isRequestTokenEndpoint($will_issue_request_token) {} |
|
325 | - |
|
326 | - /** |
|
327 | - * @param string $req_params |
|
328 | - * @return bool |
|
329 | - */ |
|
330 | - final public function removeRequiredParameter($req_params) {} |
|
331 | - |
|
332 | - /** |
|
333 | - * @param string $oauthexception |
|
334 | - * @param bool $send_headers |
|
335 | - * @return string |
|
336 | - */ |
|
337 | - final public static function reportProblem($oauthexception, $send_headers = true) {} |
|
338 | - |
|
339 | - /** |
|
340 | - * @param string $param_key |
|
341 | - * @param mixed $param_val |
|
342 | - * @return bool |
|
343 | - */ |
|
344 | - final public function setParam($param_key, $param_val = null) {} |
|
345 | - |
|
346 | - /** |
|
347 | - * @param string $path |
|
348 | - * @return bool |
|
349 | - */ |
|
350 | - final public function setRequestTokenPath($path) {} |
|
351 | - |
|
352 | - /** |
|
353 | - * @param callable $callback_function |
|
354 | - * @return void |
|
355 | - */ |
|
356 | - public function timestampNonceHandler($callback_function) {} |
|
357 | - |
|
358 | - /** |
|
359 | - * @param callable $callback_function |
|
360 | - * @return void |
|
361 | - */ |
|
362 | - public function tokenHandler($callback_function) {} |
|
268 | + /** |
|
269 | + * @param string $req_params |
|
270 | + * @return bool |
|
271 | + */ |
|
272 | + final public function addRequiredParameter($req_params) {} |
|
273 | + |
|
274 | + /** |
|
275 | + * @return void |
|
276 | + */ |
|
277 | + public function callconsumerHandler() {} |
|
278 | + |
|
279 | + /** |
|
280 | + * @return void |
|
281 | + */ |
|
282 | + public function callTimestampNonceHandler() {} |
|
283 | + |
|
284 | + /** |
|
285 | + * @return void |
|
286 | + */ |
|
287 | + public function calltokenHandler() {} |
|
288 | + |
|
289 | + /** |
|
290 | + * @param string $uri |
|
291 | + * @param string $method |
|
292 | + * @return void |
|
293 | + */ |
|
294 | + public function checkOAuthRequest($uri = '', $method = '') {} |
|
295 | + |
|
296 | + /** |
|
297 | + * @param array $params_array |
|
298 | + */ |
|
299 | + public function __construct($params_array) {} |
|
300 | + |
|
301 | + /** |
|
302 | + * @param callable $callback_function |
|
303 | + * @return void |
|
304 | + */ |
|
305 | + public function consumerHandler($callback_function) {} |
|
306 | + |
|
307 | + /** |
|
308 | + * @param int $size |
|
309 | + * @param bool $strong |
|
310 | + * @return string |
|
311 | + */ |
|
312 | + final public static function generateToken($size, $strong = false) {} |
|
313 | + |
|
314 | + /** |
|
315 | + * @param mixed $params_array |
|
316 | + * @return void |
|
317 | + */ |
|
318 | + public function is2LeggedEndpoint($params_array) {} |
|
319 | + |
|
320 | + /** |
|
321 | + * @param bool $will_issue_request_token |
|
322 | + * @return void |
|
323 | + */ |
|
324 | + public function isRequestTokenEndpoint($will_issue_request_token) {} |
|
325 | + |
|
326 | + /** |
|
327 | + * @param string $req_params |
|
328 | + * @return bool |
|
329 | + */ |
|
330 | + final public function removeRequiredParameter($req_params) {} |
|
331 | + |
|
332 | + /** |
|
333 | + * @param string $oauthexception |
|
334 | + * @param bool $send_headers |
|
335 | + * @return string |
|
336 | + */ |
|
337 | + final public static function reportProblem($oauthexception, $send_headers = true) {} |
|
338 | + |
|
339 | + /** |
|
340 | + * @param string $param_key |
|
341 | + * @param mixed $param_val |
|
342 | + * @return bool |
|
343 | + */ |
|
344 | + final public function setParam($param_key, $param_val = null) {} |
|
345 | + |
|
346 | + /** |
|
347 | + * @param string $path |
|
348 | + * @return bool |
|
349 | + */ |
|
350 | + final public function setRequestTokenPath($path) {} |
|
351 | + |
|
352 | + /** |
|
353 | + * @param callable $callback_function |
|
354 | + * @return void |
|
355 | + */ |
|
356 | + public function timestampNonceHandler($callback_function) {} |
|
357 | + |
|
358 | + /** |
|
359 | + * @param callable $callback_function |
|
360 | + * @return void |
|
361 | + */ |
|
362 | + public function tokenHandler($callback_function) {} |
|
363 | 363 | } |
@@ -52,8 +52,7 @@ discard block |
||
52 | 52 | /** |
53 | 53 | * The OAuth extension provides a simple interface to interact with data providers using the OAuth HTTP specification to protect private resources. |
54 | 54 | */ |
55 | -class OAuth |
|
56 | -{ |
|
55 | +class OAuth { |
|
57 | 56 | /** |
58 | 57 | * @var bool |
59 | 58 | */ |
@@ -244,8 +243,7 @@ discard block |
||
244 | 243 | public function setVersion($version) {} |
245 | 244 | } |
246 | 245 | |
247 | -class OAuthException extends Exception |
|
248 | -{ |
|
246 | +class OAuthException extends Exception { |
|
249 | 247 | /** |
250 | 248 | * The response of the exception which occurred, if any |
251 | 249 | * @var string |
@@ -263,8 +261,7 @@ discard block |
||
263 | 261 | /** |
264 | 262 | * Manages an OAuth provider class. |
265 | 263 | */ |
266 | -class OAuthProvider |
|
267 | -{ |
|
264 | +class OAuthProvider { |
|
268 | 265 | /** |
269 | 266 | * @param string $req_params |
270 | 267 | * @return bool |
@@ -14,17 +14,17 @@ |
||
14 | 14 | */ |
15 | 15 | class SolrModifiableParams extends SolrParams implements Serializable |
16 | 16 | { |
17 | - /** |
|
18 | - * (PECL solr >= 0.9.2)<br/> |
|
19 | - * SolrModifiableParams constructor. |
|
20 | - * @link https://php.net/manual/en/solrmodifiableparams.construct.php |
|
21 | - */ |
|
22 | - public function __construct() {} |
|
17 | + /** |
|
18 | + * (PECL solr >= 0.9.2)<br/> |
|
19 | + * SolrModifiableParams constructor. |
|
20 | + * @link https://php.net/manual/en/solrmodifiableparams.construct.php |
|
21 | + */ |
|
22 | + public function __construct() {} |
|
23 | 23 | |
24 | - /** |
|
25 | - * (PECL solr >= 0.9.2)<br/> |
|
26 | - * Destructor |
|
27 | - * @link https://php.net/manual/en/solrmodifiableparams.destruct.php |
|
28 | - */ |
|
29 | - public function __destruct() {} |
|
24 | + /** |
|
25 | + * (PECL solr >= 0.9.2)<br/> |
|
26 | + * Destructor |
|
27 | + * @link https://php.net/manual/en/solrmodifiableparams.destruct.php |
|
28 | + */ |
|
29 | + public function __destruct() {} |
|
30 | 30 | } |
@@ -12,8 +12,7 @@ |
||
12 | 12 | * This class represents a collection of name-value pairs sent to the Solr server during a request. |
13 | 13 | * @link https://php.net/manual/en/class.solrmodifiableparams.php |
14 | 14 | */ |
15 | -class SolrModifiableParams extends SolrParams implements Serializable |
|
16 | -{ |
|
15 | +class SolrModifiableParams extends SolrParams implements Serializable { |
|
17 | 16 | /** |
18 | 17 | * (PECL solr >= 0.9.2)<br/> |
19 | 18 | * SolrModifiableParams constructor. |
@@ -15,336 +15,336 @@ |
||
15 | 15 | */ |
16 | 16 | class SolrDisMaxQuery extends SolrQuery implements Serializable |
17 | 17 | { |
18 | - /** |
|
19 | - * (PECL solr >= 2.1.0)<br/> |
|
20 | - * Adds a Phrase Bigram Field (pf2 parameter) |
|
21 | - * @link https://php.net/manual/en/solrdismaxquery.addbigramphrasefield.php |
|
22 | - * @param string $field <p> |
|
23 | - * Field name |
|
24 | - * </p> |
|
25 | - * @param string $boost [optional] <p> |
|
26 | - * Boost value. Boosts documents with matching terms. |
|
27 | - * </p> |
|
28 | - * @param string $slop [optional] <p> |
|
29 | - * Field Slop |
|
30 | - * </p> |
|
31 | - * @return SolrDisMaxQuery |
|
32 | - */ |
|
33 | - public function addBigramPhraseField($field, $boost, $slop) {} |
|
18 | + /** |
|
19 | + * (PECL solr >= 2.1.0)<br/> |
|
20 | + * Adds a Phrase Bigram Field (pf2 parameter) |
|
21 | + * @link https://php.net/manual/en/solrdismaxquery.addbigramphrasefield.php |
|
22 | + * @param string $field <p> |
|
23 | + * Field name |
|
24 | + * </p> |
|
25 | + * @param string $boost [optional] <p> |
|
26 | + * Boost value. Boosts documents with matching terms. |
|
27 | + * </p> |
|
28 | + * @param string $slop [optional] <p> |
|
29 | + * Field Slop |
|
30 | + * </p> |
|
31 | + * @return SolrDisMaxQuery |
|
32 | + */ |
|
33 | + public function addBigramPhraseField($field, $boost, $slop) {} |
|
34 | 34 | |
35 | - /** |
|
36 | - * (PECL solr >= 2.1.0)<br/> |
|
37 | - * Adds a boost query field with value and optional boost (bq parameter) |
|
38 | - * @link https://php.net/manual/en/solrdismaxquery.addboostquery.php |
|
39 | - * @param string $field <p> |
|
40 | - * Field name |
|
41 | - * </p> |
|
42 | - * @param string $value |
|
43 | - * @param string $boost [optional] <p> |
|
44 | - * Boost value. Boosts documents with matching terms. |
|
45 | - * </p> |
|
46 | - * @return SolrDisMaxQuery |
|
47 | - */ |
|
48 | - public function addBoostQuery($field, $value, $boost) {} |
|
35 | + /** |
|
36 | + * (PECL solr >= 2.1.0)<br/> |
|
37 | + * Adds a boost query field with value and optional boost (bq parameter) |
|
38 | + * @link https://php.net/manual/en/solrdismaxquery.addboostquery.php |
|
39 | + * @param string $field <p> |
|
40 | + * Field name |
|
41 | + * </p> |
|
42 | + * @param string $value |
|
43 | + * @param string $boost [optional] <p> |
|
44 | + * Boost value. Boosts documents with matching terms. |
|
45 | + * </p> |
|
46 | + * @return SolrDisMaxQuery |
|
47 | + */ |
|
48 | + public function addBoostQuery($field, $value, $boost) {} |
|
49 | 49 | |
50 | - /** |
|
51 | - * (PECL solr >= 2.1.0)<br/> |
|
52 | - * Adds a Phrase Field (pf parameter) |
|
53 | - * @link https://php.net/manual/en/solrdismaxquery.addphrasefield.php |
|
54 | - * @param string $field <p> |
|
55 | - * Field name |
|
56 | - * </p> |
|
57 | - * @param string $boost [optional] <p> |
|
58 | - * Boost value. Boosts documents with matching terms. |
|
59 | - * </p> |
|
60 | - * @param string $slop [optional] <p> |
|
61 | - * Field Slop |
|
62 | - * </p> |
|
63 | - * @return SolrDisMaxQuery |
|
64 | - */ |
|
65 | - public function addPhraseField($field, $boost, $slop) {} |
|
50 | + /** |
|
51 | + * (PECL solr >= 2.1.0)<br/> |
|
52 | + * Adds a Phrase Field (pf parameter) |
|
53 | + * @link https://php.net/manual/en/solrdismaxquery.addphrasefield.php |
|
54 | + * @param string $field <p> |
|
55 | + * Field name |
|
56 | + * </p> |
|
57 | + * @param string $boost [optional] <p> |
|
58 | + * Boost value. Boosts documents with matching terms. |
|
59 | + * </p> |
|
60 | + * @param string $slop [optional] <p> |
|
61 | + * Field Slop |
|
62 | + * </p> |
|
63 | + * @return SolrDisMaxQuery |
|
64 | + */ |
|
65 | + public function addPhraseField($field, $boost, $slop) {} |
|
66 | 66 | |
67 | - /** |
|
68 | - * (PECL solr >= 2.1.0)<br/> |
|
69 | - * Add a query field with optional boost (qf parameter) |
|
70 | - * @link https://php.net/manual/en/solrdismaxquery.addqueryfield.php |
|
71 | - * @param string $field <p> |
|
72 | - * Field name |
|
73 | - * </p> |
|
74 | - * @param string $boost [optional] <p> |
|
75 | - * Boost value. Boosts documents with matching terms. |
|
76 | - * </p> |
|
77 | - * @return SolrDisMaxQuery |
|
78 | - */ |
|
79 | - public function addQueryField($field, $boost) {} |
|
67 | + /** |
|
68 | + * (PECL solr >= 2.1.0)<br/> |
|
69 | + * Add a query field with optional boost (qf parameter) |
|
70 | + * @link https://php.net/manual/en/solrdismaxquery.addqueryfield.php |
|
71 | + * @param string $field <p> |
|
72 | + * Field name |
|
73 | + * </p> |
|
74 | + * @param string $boost [optional] <p> |
|
75 | + * Boost value. Boosts documents with matching terms. |
|
76 | + * </p> |
|
77 | + * @return SolrDisMaxQuery |
|
78 | + */ |
|
79 | + public function addQueryField($field, $boost) {} |
|
80 | 80 | |
81 | - /** |
|
82 | - * (PECL solr >= 2.1.0)<br/> |
|
83 | - * Adds a Trigram Phrase Field (pf3 parameter) |
|
84 | - * @link https://php.net/manual/en/solrdismaxquery.addtrigramphrasefield.php |
|
85 | - * @param string $field <p> |
|
86 | - * Field name |
|
87 | - * </p> |
|
88 | - * @param string $boost [optional] <p> |
|
89 | - * Boost value. Boosts documents with matching terms. |
|
90 | - * </p> |
|
91 | - * @param string $slop [optional] <p> |
|
92 | - * Field Slop |
|
93 | - * </p> |
|
94 | - * @return SolrDisMaxQuery |
|
95 | - */ |
|
96 | - public function addTrigramPhraseField($field, $boost, $slop) {} |
|
81 | + /** |
|
82 | + * (PECL solr >= 2.1.0)<br/> |
|
83 | + * Adds a Trigram Phrase Field (pf3 parameter) |
|
84 | + * @link https://php.net/manual/en/solrdismaxquery.addtrigramphrasefield.php |
|
85 | + * @param string $field <p> |
|
86 | + * Field name |
|
87 | + * </p> |
|
88 | + * @param string $boost [optional] <p> |
|
89 | + * Boost value. Boosts documents with matching terms. |
|
90 | + * </p> |
|
91 | + * @param string $slop [optional] <p> |
|
92 | + * Field Slop |
|
93 | + * </p> |
|
94 | + * @return SolrDisMaxQuery |
|
95 | + */ |
|
96 | + public function addTrigramPhraseField($field, $boost, $slop) {} |
|
97 | 97 | |
98 | - /** |
|
99 | - * (PECL solr >= 2.1.0)<br/> |
|
100 | - * Adds a field to User Fields Parameter (uf) |
|
101 | - * @link https://php.net/manual/en/solrdismaxquery.adduserfield.php |
|
102 | - * @param string $field <p> |
|
103 | - * Field name |
|
104 | - * </p> |
|
105 | - * @return SolrDisMaxQuery |
|
106 | - */ |
|
107 | - public function addUserField($field) {} |
|
98 | + /** |
|
99 | + * (PECL solr >= 2.1.0)<br/> |
|
100 | + * Adds a field to User Fields Parameter (uf) |
|
101 | + * @link https://php.net/manual/en/solrdismaxquery.adduserfield.php |
|
102 | + * @param string $field <p> |
|
103 | + * Field name |
|
104 | + * </p> |
|
105 | + * @return SolrDisMaxQuery |
|
106 | + */ |
|
107 | + public function addUserField($field) {} |
|
108 | 108 | |
109 | - /** |
|
110 | - * (PECL solr >= 2.1.0)<br/> |
|
111 | - * Removes phrase bigram field (pf2 parameter) |
|
112 | - * @link https://php.net/manual/en/solrdismaxquery.removebigramphrasefield.php |
|
113 | - * @param string $field <p> |
|
114 | - * Field name |
|
115 | - * </p> |
|
116 | - * @return SolrDisMaxQuery |
|
117 | - */ |
|
118 | - public function removeBigramPhraseField($field) {} |
|
109 | + /** |
|
110 | + * (PECL solr >= 2.1.0)<br/> |
|
111 | + * Removes phrase bigram field (pf2 parameter) |
|
112 | + * @link https://php.net/manual/en/solrdismaxquery.removebigramphrasefield.php |
|
113 | + * @param string $field <p> |
|
114 | + * Field name |
|
115 | + * </p> |
|
116 | + * @return SolrDisMaxQuery |
|
117 | + */ |
|
118 | + public function removeBigramPhraseField($field) {} |
|
119 | 119 | |
120 | - /** |
|
121 | - * (PECL solr >= 2.1.0)<br/> |
|
122 | - * Removes a boost query partial by field name (bq) |
|
123 | - * @link https://php.net/manual/en/solrdismaxquery.removeboostquery.php |
|
124 | - * @param string $field <p> |
|
125 | - * Field name |
|
126 | - * </p> |
|
127 | - * @return SolrDisMaxQuery |
|
128 | - */ |
|
129 | - public function removeBoostQuery($field) {} |
|
120 | + /** |
|
121 | + * (PECL solr >= 2.1.0)<br/> |
|
122 | + * Removes a boost query partial by field name (bq) |
|
123 | + * @link https://php.net/manual/en/solrdismaxquery.removeboostquery.php |
|
124 | + * @param string $field <p> |
|
125 | + * Field name |
|
126 | + * </p> |
|
127 | + * @return SolrDisMaxQuery |
|
128 | + */ |
|
129 | + public function removeBoostQuery($field) {} |
|
130 | 130 | |
131 | - /** |
|
132 | - * (PECL solr >= 2.1.0)<br/> |
|
133 | - * Removes a Phrase Field (pf parameter) |
|
134 | - * @link https://php.net/manual/en/solrdismaxquery.removephrasefield.php |
|
135 | - * @param string $field <p> |
|
136 | - * Field name |
|
137 | - * </p> |
|
138 | - * @return SolrDisMaxQuery |
|
139 | - */ |
|
140 | - public function removePhraseField($field) {} |
|
131 | + /** |
|
132 | + * (PECL solr >= 2.1.0)<br/> |
|
133 | + * Removes a Phrase Field (pf parameter) |
|
134 | + * @link https://php.net/manual/en/solrdismaxquery.removephrasefield.php |
|
135 | + * @param string $field <p> |
|
136 | + * Field name |
|
137 | + * </p> |
|
138 | + * @return SolrDisMaxQuery |
|
139 | + */ |
|
140 | + public function removePhraseField($field) {} |
|
141 | 141 | |
142 | - /** |
|
143 | - * (PECL solr >= 2.1.0)<br/> |
|
144 | - * Removes a Query Field (qf parameter) |
|
145 | - * @link https://php.net/manual/en/solrdismaxquery.removequeryfield.php |
|
146 | - * @param string $field <p> |
|
147 | - * Field name |
|
148 | - * </p> |
|
149 | - * @return SolrDisMaxQuery |
|
150 | - */ |
|
151 | - public function removeQueryField($field) {} |
|
142 | + /** |
|
143 | + * (PECL solr >= 2.1.0)<br/> |
|
144 | + * Removes a Query Field (qf parameter) |
|
145 | + * @link https://php.net/manual/en/solrdismaxquery.removequeryfield.php |
|
146 | + * @param string $field <p> |
|
147 | + * Field name |
|
148 | + * </p> |
|
149 | + * @return SolrDisMaxQuery |
|
150 | + */ |
|
151 | + public function removeQueryField($field) {} |
|
152 | 152 | |
153 | - /** |
|
154 | - * (PECL solr >= 2.1.0)<br/> |
|
155 | - * Removes a Trigram Phrase Field (pf3 parameter) |
|
156 | - * @link https://php.net/manual/en/solrdismaxquery.removetrigramphrasefield.php |
|
157 | - * @param string $field <p> |
|
158 | - * Field name |
|
159 | - * </p> |
|
160 | - * @return SolrDisMaxQuery |
|
161 | - */ |
|
162 | - public function removeTrigramPhraseField($field) {} |
|
153 | + /** |
|
154 | + * (PECL solr >= 2.1.0)<br/> |
|
155 | + * Removes a Trigram Phrase Field (pf3 parameter) |
|
156 | + * @link https://php.net/manual/en/solrdismaxquery.removetrigramphrasefield.php |
|
157 | + * @param string $field <p> |
|
158 | + * Field name |
|
159 | + * </p> |
|
160 | + * @return SolrDisMaxQuery |
|
161 | + */ |
|
162 | + public function removeTrigramPhraseField($field) {} |
|
163 | 163 | |
164 | - /** |
|
165 | - * (PECL solr >= 2.1.0)<br/> |
|
166 | - * Removes a field from The User Fields Parameter (uf) |
|
167 | - * <div> |
|
168 | - * <b>Warning</b><br/> |
|
169 | - * This function is currently not documented; only its argument list is available. |
|
170 | - * </div> |
|
171 | - * @link https://php.net/manual/en/solrdismaxquery.removeuserfield.php |
|
172 | - * @param string $field <p> |
|
173 | - * Field name |
|
174 | - * </p> |
|
175 | - * @return SolrDisMaxQuery |
|
176 | - */ |
|
177 | - public function removeUserField($field) {} |
|
164 | + /** |
|
165 | + * (PECL solr >= 2.1.0)<br/> |
|
166 | + * Removes a field from The User Fields Parameter (uf) |
|
167 | + * <div> |
|
168 | + * <b>Warning</b><br/> |
|
169 | + * This function is currently not documented; only its argument list is available. |
|
170 | + * </div> |
|
171 | + * @link https://php.net/manual/en/solrdismaxquery.removeuserfield.php |
|
172 | + * @param string $field <p> |
|
173 | + * Field name |
|
174 | + * </p> |
|
175 | + * @return SolrDisMaxQuery |
|
176 | + */ |
|
177 | + public function removeUserField($field) {} |
|
178 | 178 | |
179 | - /** |
|
180 | - * (PECL solr >= 2.1.0)<br/> |
|
181 | - * Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter |
|
182 | - * @link https://php.net/manual/en/solrdismaxquery.setbigramphrasefields.php |
|
183 | - * @param string $fields <p> |
|
184 | - * Fields boosts (slops) |
|
185 | - * </p> |
|
186 | - * @return SolrDisMaxQuery |
|
187 | - */ |
|
188 | - public function setBigramPhraseFields($fields) {} |
|
179 | + /** |
|
180 | + * (PECL solr >= 2.1.0)<br/> |
|
181 | + * Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter |
|
182 | + * @link https://php.net/manual/en/solrdismaxquery.setbigramphrasefields.php |
|
183 | + * @param string $fields <p> |
|
184 | + * Fields boosts (slops) |
|
185 | + * </p> |
|
186 | + * @return SolrDisMaxQuery |
|
187 | + */ |
|
188 | + public function setBigramPhraseFields($fields) {} |
|
189 | 189 | |
190 | - /** |
|
191 | - * (PECL solr >= 2.1.0)<br/> |
|
192 | - * Sets Bigram Phrase Slop (ps2 parameter) |
|
193 | - * @link https://php.net/manual/en/solrdismaxquery.setbigramphraseslop.php |
|
194 | - * @param string $slop <p> |
|
195 | - * A default slop for Bigram phrase fields. |
|
196 | - * </p> |
|
197 | - * @return SolrDisMaxQuery |
|
198 | - */ |
|
199 | - public function setBigramPhraseSlop($slop) {} |
|
190 | + /** |
|
191 | + * (PECL solr >= 2.1.0)<br/> |
|
192 | + * Sets Bigram Phrase Slop (ps2 parameter) |
|
193 | + * @link https://php.net/manual/en/solrdismaxquery.setbigramphraseslop.php |
|
194 | + * @param string $slop <p> |
|
195 | + * A default slop for Bigram phrase fields. |
|
196 | + * </p> |
|
197 | + * @return SolrDisMaxQuery |
|
198 | + */ |
|
199 | + public function setBigramPhraseSlop($slop) {} |
|
200 | 200 | |
201 | - /** |
|
202 | - * (PECL solr >= 2.1.0)<br/> |
|
203 | - * Sets a Boost Function (bf parameter). |
|
204 | - * @link https://php.net/manual/en/solrdismaxquery.setboostfunction.php |
|
205 | - * @param string $function <p> |
|
206 | - * Functions (with optional boosts) that will be included in the user's query to influence the score. Any function |
|
207 | - * supported natively by Solr can be used, along with a boost value. e.g.:<br/> |
|
208 | - * recip(rord(myfield),1,2,3)^1.5 |
|
209 | - * </p> |
|
210 | - * @return SolrDisMaxQuery |
|
211 | - */ |
|
212 | - public function setBoostFunction($function) {} |
|
201 | + /** |
|
202 | + * (PECL solr >= 2.1.0)<br/> |
|
203 | + * Sets a Boost Function (bf parameter). |
|
204 | + * @link https://php.net/manual/en/solrdismaxquery.setboostfunction.php |
|
205 | + * @param string $function <p> |
|
206 | + * Functions (with optional boosts) that will be included in the user's query to influence the score. Any function |
|
207 | + * supported natively by Solr can be used, along with a boost value. e.g.:<br/> |
|
208 | + * recip(rord(myfield),1,2,3)^1.5 |
|
209 | + * </p> |
|
210 | + * @return SolrDisMaxQuery |
|
211 | + */ |
|
212 | + public function setBoostFunction($function) {} |
|
213 | 213 | |
214 | - /** |
|
215 | - * (PECL solr >= 2.1.0)<br/> |
|
216 | - * Directly Sets Boost Query Parameter (bq) |
|
217 | - * @link https://php.net/manual/en/solrdismaxquery.setboostquery.php |
|
218 | - * @param string $q |
|
219 | - * @return SolrDisMaxQuery |
|
220 | - */ |
|
221 | - public function setBoostQuery($q) {} |
|
214 | + /** |
|
215 | + * (PECL solr >= 2.1.0)<br/> |
|
216 | + * Directly Sets Boost Query Parameter (bq) |
|
217 | + * @link https://php.net/manual/en/solrdismaxquery.setboostquery.php |
|
218 | + * @param string $q |
|
219 | + * @return SolrDisMaxQuery |
|
220 | + */ |
|
221 | + public function setBoostQuery($q) {} |
|
222 | 222 | |
223 | - /** |
|
224 | - * (PECL solr >= 2.1.0)<br/> |
|
225 | - * Set Minimum "Should" Match (mm) |
|
226 | - * @link https://php.net/manual/en/solrdismaxquery.setminimummatch.php |
|
227 | - * @param string $value <p> |
|
228 | - * Minimum match value/expression<br/> |
|
229 | - * Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default |
|
230 | - * query operator (q.op) is OR, then mm=0%. |
|
231 | - * </p> |
|
232 | - * @return SolrDisMaxQuery |
|
233 | - */ |
|
234 | - public function setMinimumMatch($value) {} |
|
223 | + /** |
|
224 | + * (PECL solr >= 2.1.0)<br/> |
|
225 | + * Set Minimum "Should" Match (mm) |
|
226 | + * @link https://php.net/manual/en/solrdismaxquery.setminimummatch.php |
|
227 | + * @param string $value <p> |
|
228 | + * Minimum match value/expression<br/> |
|
229 | + * Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default |
|
230 | + * query operator (q.op) is OR, then mm=0%. |
|
231 | + * </p> |
|
232 | + * @return SolrDisMaxQuery |
|
233 | + */ |
|
234 | + public function setMinimumMatch($value) {} |
|
235 | 235 | |
236 | - /** |
|
237 | - * (PECL solr >= 2.1.0)<br/> |
|
238 | - * Sets Phrase Fields and their boosts (and slops) using pf2 parameter |
|
239 | - * @link https://php.net/manual/en/solrdismaxquery.setphrasefields.php |
|
240 | - * @param string $fields <p> |
|
241 | - * Fields, boosts [, slops] |
|
242 | - * </p> |
|
243 | - * @return SolrDisMaxQuery |
|
244 | - */ |
|
245 | - public function setPhraseFields($fields) {} |
|
236 | + /** |
|
237 | + * (PECL solr >= 2.1.0)<br/> |
|
238 | + * Sets Phrase Fields and their boosts (and slops) using pf2 parameter |
|
239 | + * @link https://php.net/manual/en/solrdismaxquery.setphrasefields.php |
|
240 | + * @param string $fields <p> |
|
241 | + * Fields, boosts [, slops] |
|
242 | + * </p> |
|
243 | + * @return SolrDisMaxQuery |
|
244 | + */ |
|
245 | + public function setPhraseFields($fields) {} |
|
246 | 246 | |
247 | - /** |
|
248 | - * (PECL solr >= 2.1.0)<br/> |
|
249 | - * Sets the default slop on phrase queries (ps parameter) |
|
250 | - * @link https://php.net/manual/en/solrdismaxquery.setphraseslop.php |
|
251 | - * @param string $slop <p> |
|
252 | - * Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting). |
|
253 | - * "ps" parameter |
|
254 | - * </p> |
|
255 | - * @return SolrDisMaxQuery |
|
256 | - */ |
|
257 | - public function setPhraseSlop($slop) {} |
|
247 | + /** |
|
248 | + * (PECL solr >= 2.1.0)<br/> |
|
249 | + * Sets the default slop on phrase queries (ps parameter) |
|
250 | + * @link https://php.net/manual/en/solrdismaxquery.setphraseslop.php |
|
251 | + * @param string $slop <p> |
|
252 | + * Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting). |
|
253 | + * "ps" parameter |
|
254 | + * </p> |
|
255 | + * @return SolrDisMaxQuery |
|
256 | + */ |
|
257 | + public function setPhraseSlop($slop) {} |
|
258 | 258 | |
259 | - /** |
|
260 | - * (PECL solr >= 2.1.0)<br/> |
|
261 | - * Set Query Alternate (q.alt parameter) |
|
262 | - * @link https://php.net/manual/en/solrdismaxquery.setqueryalt.php |
|
263 | - * @param string $q <p> |
|
264 | - * Query String |
|
265 | - * </p> |
|
266 | - * @return SolrDisMaxQuery |
|
267 | - */ |
|
268 | - public function setQueryAlt($q) {} |
|
259 | + /** |
|
260 | + * (PECL solr >= 2.1.0)<br/> |
|
261 | + * Set Query Alternate (q.alt parameter) |
|
262 | + * @link https://php.net/manual/en/solrdismaxquery.setqueryalt.php |
|
263 | + * @param string $q <p> |
|
264 | + * Query String |
|
265 | + * </p> |
|
266 | + * @return SolrDisMaxQuery |
|
267 | + */ |
|
268 | + public function setQueryAlt($q) {} |
|
269 | 269 | |
270 | - /** |
|
271 | - * (PECL solr >= 2.1.0)<br/> |
|
272 | - * Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf |
|
273 | - * parameter) |
|
274 | - * @link https://php.net/manual/en/solrdismaxquery.setqueryphraseslop.php |
|
275 | - * @param string $slop <p> |
|
276 | - * Amount of slop<br/> |
|
277 | - * The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query |
|
278 | - * string with the qf parameter.<br/> |
|
279 | - * <br/> |
|
280 | - * slop refers to the number of positions one token needs to be moved in relation to another token in order to match |
|
281 | - * a phrase specified in a query. |
|
282 | - * </p> |
|
283 | - * @return SolrDisMaxQuery |
|
284 | - */ |
|
285 | - public function setQueryPhraseSlop($slop) {} |
|
270 | + /** |
|
271 | + * (PECL solr >= 2.1.0)<br/> |
|
272 | + * Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf |
|
273 | + * parameter) |
|
274 | + * @link https://php.net/manual/en/solrdismaxquery.setqueryphraseslop.php |
|
275 | + * @param string $slop <p> |
|
276 | + * Amount of slop<br/> |
|
277 | + * The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query |
|
278 | + * string with the qf parameter.<br/> |
|
279 | + * <br/> |
|
280 | + * slop refers to the number of positions one token needs to be moved in relation to another token in order to match |
|
281 | + * a phrase specified in a query. |
|
282 | + * </p> |
|
283 | + * @return SolrDisMaxQuery |
|
284 | + */ |
|
285 | + public function setQueryPhraseSlop($slop) {} |
|
286 | 286 | |
287 | - /** |
|
288 | - * (PECL solr >= 2.1.0)<br/> |
|
289 | - * Sets Tie Breaker parameter (tie parameter) |
|
290 | - * @link https://php.net/manual/en/solrdismaxquery.settiebreaker.php |
|
291 | - * @param string $tieBreaker <p> |
|
292 | - * The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in |
|
293 | - * DisMax queries. |
|
294 | - * </p> |
|
295 | - * @return SolrDisMaxQuery |
|
296 | - */ |
|
297 | - public function setTieBreaker($tieBreaker) {} |
|
287 | + /** |
|
288 | + * (PECL solr >= 2.1.0)<br/> |
|
289 | + * Sets Tie Breaker parameter (tie parameter) |
|
290 | + * @link https://php.net/manual/en/solrdismaxquery.settiebreaker.php |
|
291 | + * @param string $tieBreaker <p> |
|
292 | + * The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in |
|
293 | + * DisMax queries. |
|
294 | + * </p> |
|
295 | + * @return SolrDisMaxQuery |
|
296 | + */ |
|
297 | + public function setTieBreaker($tieBreaker) {} |
|
298 | 298 | |
299 | - /** |
|
300 | - * (PECL solr >= 2.1.0)<br/> |
|
301 | - * Directly Sets Trigram Phrase Fields (pf3 parameter) |
|
302 | - * @link https://php.net/manual/en/solrdismaxquery.settrigramphrasefields.php |
|
303 | - * @param string $fields <p> |
|
304 | - * Trigram Phrase Fields |
|
305 | - * </p> |
|
306 | - * @return SolrDisMaxQuery |
|
307 | - */ |
|
308 | - public function setTrigramPhraseFields($fields) {} |
|
299 | + /** |
|
300 | + * (PECL solr >= 2.1.0)<br/> |
|
301 | + * Directly Sets Trigram Phrase Fields (pf3 parameter) |
|
302 | + * @link https://php.net/manual/en/solrdismaxquery.settrigramphrasefields.php |
|
303 | + * @param string $fields <p> |
|
304 | + * Trigram Phrase Fields |
|
305 | + * </p> |
|
306 | + * @return SolrDisMaxQuery |
|
307 | + */ |
|
308 | + public function setTrigramPhraseFields($fields) {} |
|
309 | 309 | |
310 | - /** |
|
311 | - * (PECL solr >= 2.1.0)<br/> |
|
312 | - * Sets Trigram Phrase Slop (ps3 parameter) |
|
313 | - * @link https://php.net/manual/en/solrdismaxquery.settrigramphraseslop.php |
|
314 | - * @param string $slop <p> |
|
315 | - * Phrase slop |
|
316 | - * </p> |
|
317 | - * @return SolrDisMaxQuery |
|
318 | - */ |
|
319 | - public function setTrigramPhraseSlop($slop) {} |
|
310 | + /** |
|
311 | + * (PECL solr >= 2.1.0)<br/> |
|
312 | + * Sets Trigram Phrase Slop (ps3 parameter) |
|
313 | + * @link https://php.net/manual/en/solrdismaxquery.settrigramphraseslop.php |
|
314 | + * @param string $slop <p> |
|
315 | + * Phrase slop |
|
316 | + * </p> |
|
317 | + * @return SolrDisMaxQuery |
|
318 | + */ |
|
319 | + public function setTrigramPhraseSlop($slop) {} |
|
320 | 320 | |
321 | - /** |
|
322 | - * (PECL solr >= 2.1.0)<br/> |
|
323 | - * Sets User Fields parameter (uf) |
|
324 | - * @link https://php.net/manual/en/solrdismaxquery.setuserfields.php |
|
325 | - * @param string $fields <p> |
|
326 | - * Fields names separated by space<br/> |
|
327 | - * This parameter supports wildcards. |
|
328 | - * </p> |
|
329 | - * @return SolrDisMaxQuery |
|
330 | - */ |
|
331 | - public function setUserFields($fields) {} |
|
321 | + /** |
|
322 | + * (PECL solr >= 2.1.0)<br/> |
|
323 | + * Sets User Fields parameter (uf) |
|
324 | + * @link https://php.net/manual/en/solrdismaxquery.setuserfields.php |
|
325 | + * @param string $fields <p> |
|
326 | + * Fields names separated by space<br/> |
|
327 | + * This parameter supports wildcards. |
|
328 | + * </p> |
|
329 | + * @return SolrDisMaxQuery |
|
330 | + */ |
|
331 | + public function setUserFields($fields) {} |
|
332 | 332 | |
333 | - /** |
|
334 | - * (PECL solr >= 2.1.0)<br/> |
|
335 | - * Switch QueryParser to be DisMax Query Parser |
|
336 | - * @link https://php.net/manual/en/solrdismaxquery.usedismaxqueryparser.php |
|
337 | - * @return SolrDisMaxQuery |
|
338 | - */ |
|
339 | - public function useDisMaxQueryParser() {} |
|
333 | + /** |
|
334 | + * (PECL solr >= 2.1.0)<br/> |
|
335 | + * Switch QueryParser to be DisMax Query Parser |
|
336 | + * @link https://php.net/manual/en/solrdismaxquery.usedismaxqueryparser.php |
|
337 | + * @return SolrDisMaxQuery |
|
338 | + */ |
|
339 | + public function useDisMaxQueryParser() {} |
|
340 | 340 | |
341 | - /** |
|
342 | - * (PECL solr >= 2.1.0)<br/> |
|
343 | - * Switch QueryParser to be EDisMax<br/> |
|
344 | - * By default the query builder uses edismax, if it was switched using |
|
345 | - * SolrDisMaxQuery::useDisMaxQueryParser(), it can be switched back using this method. |
|
346 | - * @link https://php.net/manual/en/solrdismaxquery.useedismaxqueryparser.php |
|
347 | - * @return SolrDisMaxQuery |
|
348 | - */ |
|
349 | - public function useEDisMaxQueryParser() {} |
|
341 | + /** |
|
342 | + * (PECL solr >= 2.1.0)<br/> |
|
343 | + * Switch QueryParser to be EDisMax<br/> |
|
344 | + * By default the query builder uses edismax, if it was switched using |
|
345 | + * SolrDisMaxQuery::useDisMaxQueryParser(), it can be switched back using this method. |
|
346 | + * @link https://php.net/manual/en/solrdismaxquery.useedismaxqueryparser.php |
|
347 | + * @return SolrDisMaxQuery |
|
348 | + */ |
|
349 | + public function useEDisMaxQueryParser() {} |
|
350 | 350 | } |
@@ -13,8 +13,7 @@ |
||
13 | 13 | * Class SolrDisMaxQuery<br/> |
14 | 14 | * @link https://php.net/manual/en/class.solrdismaxquery.php |
15 | 15 | */ |
16 | -class SolrDisMaxQuery extends SolrQuery implements Serializable |
|
17 | -{ |
|
16 | +class SolrDisMaxQuery extends SolrQuery implements Serializable { |
|
18 | 17 | /** |
19 | 18 | * (PECL solr >= 2.1.0)<br/> |
20 | 19 | * Adds a Phrase Bigram Field (pf2 parameter) |
@@ -13,138 +13,138 @@ |
||
13 | 13 | */ |
14 | 14 | class SolrCollapseFunction |
15 | 15 | { |
16 | - /** @var string */ |
|
17 | - public const NULLPOLICY_IGNORE = 'ignore'; |
|
18 | - |
|
19 | - /** @var string */ |
|
20 | - public const NULLPOLICY_EXPAND = 'expand'; |
|
21 | - |
|
22 | - /** @var string */ |
|
23 | - public const NULLPOLICY_COLLAPSE = 'collapse'; |
|
24 | - |
|
25 | - /** |
|
26 | - * (PECL solr >= 2.2.0)<br/> |
|
27 | - * SolrCollapseFunction constructor. |
|
28 | - * @link https://php.net/manual/en/solrcollapsefunction.construct.php |
|
29 | - * @param string $field [optional] <p> |
|
30 | - * The field name to collapse on.<br/> |
|
31 | - * In order to collapse a result. The field type must be a single valued String, Int or Float. |
|
32 | - * </p> |
|
33 | - */ |
|
34 | - public function __construct($field) {} |
|
35 | - |
|
36 | - /** |
|
37 | - * (PECL solr >= 2.2.0)<br/> |
|
38 | - * Returns the field that is being collapsed on. |
|
39 | - * @link https://php.net/manual/en/solrcollapsefunction.getfield.php |
|
40 | - * @return string |
|
41 | - */ |
|
42 | - public function getField() {} |
|
43 | - |
|
44 | - /** |
|
45 | - * (PECL solr >= 2.2.0)<br/> |
|
46 | - * Returns collapse hint |
|
47 | - * @link https://php.net/manual/en/solrcollapsefunction.gethint.php |
|
48 | - * @return string |
|
49 | - */ |
|
50 | - public function getHint() {} |
|
51 | - |
|
52 | - /** |
|
53 | - * (PECL solr >= 2.2.0)<br/> |
|
54 | - * Returns max parameter |
|
55 | - * @link https://php.net/manual/en/solrcollapsefunction.getmax.php |
|
56 | - * @return string |
|
57 | - */ |
|
58 | - public function getMax() {} |
|
59 | - |
|
60 | - /** |
|
61 | - * (PECL solr >= 2.2.0)<br/> |
|
62 | - * Returns min parameter |
|
63 | - * @link https://php.net/manual/en/solrcollapsefunction.getmin.php |
|
64 | - * @return string |
|
65 | - */ |
|
66 | - public function getMin() {} |
|
67 | - |
|
68 | - /** |
|
69 | - * (PECL solr >= 2.2.0)<br/> |
|
70 | - * Returns null policy |
|
71 | - * @link https://php.net/manual/en/solrcollapsefunction.getnullpolicy.php |
|
72 | - * @return string |
|
73 | - */ |
|
74 | - public function getNullPolicy() {} |
|
75 | - |
|
76 | - /** |
|
77 | - * (PECL solr >= 2.2.0)<br/> |
|
78 | - * Returns size parameter |
|
79 | - * @link https://php.net/manual/en/solrcollapsefunction.getsize.php |
|
80 | - * @return int |
|
81 | - */ |
|
82 | - public function getSize() {} |
|
83 | - |
|
84 | - /** |
|
85 | - * (PECL solr >= 2.2.0)<br/> |
|
86 | - * Sets the field to collapse on |
|
87 | - * @link https://php.net/manual/en/solrcollapsefunction.setfield.php |
|
88 | - * @param string $fieldName <p> |
|
89 | - * The field name to collapse on. In order to collapse a result. The field type must be a single valued String, Int |
|
90 | - * or Float. |
|
91 | - * </p> |
|
92 | - * @return SolrCollapseFunction |
|
93 | - */ |
|
94 | - public function setField($fieldName) {} |
|
95 | - |
|
96 | - /** |
|
97 | - * (PECL solr >= 2.2.0)<br/> |
|
98 | - * Sets collapse hint |
|
99 | - * @link https://php.net/manual/en/solrcollapsefunction.sethint.php |
|
100 | - * @param string $hint <p> |
|
101 | - * Currently there is only one hint available "top_fc", which stands for top level FieldCache |
|
102 | - * </p> |
|
103 | - * @return SolrCollapseFunction |
|
104 | - */ |
|
105 | - public function setHint($hint) {} |
|
106 | - |
|
107 | - /** |
|
108 | - * (PECL solr >= 2.2.0)<br/> |
|
109 | - * Selects the group heads by the max value of a numeric field or function query. |
|
110 | - * @link https://php.net/manual/en/solrcollapsefunction.setmax.php |
|
111 | - * @param string $max |
|
112 | - * @return SolrCollapseFunction |
|
113 | - */ |
|
114 | - public function setMax($max) {} |
|
115 | - |
|
116 | - /** |
|
117 | - * (PECL solr >= 2.2.0)<br/> |
|
118 | - * Sets the initial size of the collapse data structures when collapsing on a numeric field only |
|
119 | - * @link https://php.net/manual/en/solrcollapsefunction.setmin.php |
|
120 | - * @param string $min |
|
121 | - * @return SolrCollapseFunction |
|
122 | - */ |
|
123 | - public function setMin($min) {} |
|
124 | - |
|
125 | - /** |
|
126 | - * (PECL solr >= 2.2.0)<br/> |
|
127 | - * Sets the NULL Policy |
|
128 | - * @link https://php.net/manual/en/solrcollapsefunction.setnullpolicy.php |
|
129 | - * @param string $nullPolicy |
|
130 | - * @return SolrCollapseFunction |
|
131 | - */ |
|
132 | - public function setNullPolicy($nullPolicy) {} |
|
133 | - |
|
134 | - /** |
|
135 | - * (PECL solr >= 2.2.0)<br/> |
|
136 | - * Sets the initial size of the collapse data structures when collapsing on a numeric field only. |
|
137 | - * @link https://php.net/manual/en/solrcollapsefunction.setsize.php |
|
138 | - * @param int $size |
|
139 | - * @return SolrCollapseFunction |
|
140 | - */ |
|
141 | - public function setSize($size) {} |
|
142 | - |
|
143 | - /** |
|
144 | - * (PECL solr >= 2.2.0)<br/> |
|
145 | - * Returns a string representing the constructed collapse function |
|
146 | - * @link https://php.net/manual/en/solrcollapsefunction.tostring.php |
|
147 | - * @return string |
|
148 | - */ |
|
149 | - public function __toString() {} |
|
16 | + /** @var string */ |
|
17 | + public const NULLPOLICY_IGNORE = 'ignore'; |
|
18 | + |
|
19 | + /** @var string */ |
|
20 | + public const NULLPOLICY_EXPAND = 'expand'; |
|
21 | + |
|
22 | + /** @var string */ |
|
23 | + public const NULLPOLICY_COLLAPSE = 'collapse'; |
|
24 | + |
|
25 | + /** |
|
26 | + * (PECL solr >= 2.2.0)<br/> |
|
27 | + * SolrCollapseFunction constructor. |
|
28 | + * @link https://php.net/manual/en/solrcollapsefunction.construct.php |
|
29 | + * @param string $field [optional] <p> |
|
30 | + * The field name to collapse on.<br/> |
|
31 | + * In order to collapse a result. The field type must be a single valued String, Int or Float. |
|
32 | + * </p> |
|
33 | + */ |
|
34 | + public function __construct($field) {} |
|
35 | + |
|
36 | + /** |
|
37 | + * (PECL solr >= 2.2.0)<br/> |
|
38 | + * Returns the field that is being collapsed on. |
|
39 | + * @link https://php.net/manual/en/solrcollapsefunction.getfield.php |
|
40 | + * @return string |
|
41 | + */ |
|
42 | + public function getField() {} |
|
43 | + |
|
44 | + /** |
|
45 | + * (PECL solr >= 2.2.0)<br/> |
|
46 | + * Returns collapse hint |
|
47 | + * @link https://php.net/manual/en/solrcollapsefunction.gethint.php |
|
48 | + * @return string |
|
49 | + */ |
|
50 | + public function getHint() {} |
|
51 | + |
|
52 | + /** |
|
53 | + * (PECL solr >= 2.2.0)<br/> |
|
54 | + * Returns max parameter |
|
55 | + * @link https://php.net/manual/en/solrcollapsefunction.getmax.php |
|
56 | + * @return string |
|
57 | + */ |
|
58 | + public function getMax() {} |
|
59 | + |
|
60 | + /** |
|
61 | + * (PECL solr >= 2.2.0)<br/> |
|
62 | + * Returns min parameter |
|
63 | + * @link https://php.net/manual/en/solrcollapsefunction.getmin.php |
|
64 | + * @return string |
|
65 | + */ |
|
66 | + public function getMin() {} |
|
67 | + |
|
68 | + /** |
|
69 | + * (PECL solr >= 2.2.0)<br/> |
|
70 | + * Returns null policy |
|
71 | + * @link https://php.net/manual/en/solrcollapsefunction.getnullpolicy.php |
|
72 | + * @return string |
|
73 | + */ |
|
74 | + public function getNullPolicy() {} |
|
75 | + |
|
76 | + /** |
|
77 | + * (PECL solr >= 2.2.0)<br/> |
|
78 | + * Returns size parameter |
|
79 | + * @link https://php.net/manual/en/solrcollapsefunction.getsize.php |
|
80 | + * @return int |
|
81 | + */ |
|
82 | + public function getSize() {} |
|
83 | + |
|
84 | + /** |
|
85 | + * (PECL solr >= 2.2.0)<br/> |
|
86 | + * Sets the field to collapse on |
|
87 | + * @link https://php.net/manual/en/solrcollapsefunction.setfield.php |
|
88 | + * @param string $fieldName <p> |
|
89 | + * The field name to collapse on. In order to collapse a result. The field type must be a single valued String, Int |
|
90 | + * or Float. |
|
91 | + * </p> |
|
92 | + * @return SolrCollapseFunction |
|
93 | + */ |
|
94 | + public function setField($fieldName) {} |
|
95 | + |
|
96 | + /** |
|
97 | + * (PECL solr >= 2.2.0)<br/> |
|
98 | + * Sets collapse hint |
|
99 | + * @link https://php.net/manual/en/solrcollapsefunction.sethint.php |
|
100 | + * @param string $hint <p> |
|
101 | + * Currently there is only one hint available "top_fc", which stands for top level FieldCache |
|
102 | + * </p> |
|
103 | + * @return SolrCollapseFunction |
|
104 | + */ |
|
105 | + public function setHint($hint) {} |
|
106 | + |
|
107 | + /** |
|
108 | + * (PECL solr >= 2.2.0)<br/> |
|
109 | + * Selects the group heads by the max value of a numeric field or function query. |
|
110 | + * @link https://php.net/manual/en/solrcollapsefunction.setmax.php |
|
111 | + * @param string $max |
|
112 | + * @return SolrCollapseFunction |
|
113 | + */ |
|
114 | + public function setMax($max) {} |
|
115 | + |
|
116 | + /** |
|
117 | + * (PECL solr >= 2.2.0)<br/> |
|
118 | + * Sets the initial size of the collapse data structures when collapsing on a numeric field only |
|
119 | + * @link https://php.net/manual/en/solrcollapsefunction.setmin.php |
|
120 | + * @param string $min |
|
121 | + * @return SolrCollapseFunction |
|
122 | + */ |
|
123 | + public function setMin($min) {} |
|
124 | + |
|
125 | + /** |
|
126 | + * (PECL solr >= 2.2.0)<br/> |
|
127 | + * Sets the NULL Policy |
|
128 | + * @link https://php.net/manual/en/solrcollapsefunction.setnullpolicy.php |
|
129 | + * @param string $nullPolicy |
|
130 | + * @return SolrCollapseFunction |
|
131 | + */ |
|
132 | + public function setNullPolicy($nullPolicy) {} |
|
133 | + |
|
134 | + /** |
|
135 | + * (PECL solr >= 2.2.0)<br/> |
|
136 | + * Sets the initial size of the collapse data structures when collapsing on a numeric field only. |
|
137 | + * @link https://php.net/manual/en/solrcollapsefunction.setsize.php |
|
138 | + * @param int $size |
|
139 | + * @return SolrCollapseFunction |
|
140 | + */ |
|
141 | + public function setSize($size) {} |
|
142 | + |
|
143 | + /** |
|
144 | + * (PECL solr >= 2.2.0)<br/> |
|
145 | + * Returns a string representing the constructed collapse function |
|
146 | + * @link https://php.net/manual/en/solrcollapsefunction.tostring.php |
|
147 | + * @return string |
|
148 | + */ |
|
149 | + public function __toString() {} |
|
150 | 150 | } |
@@ -11,8 +11,7 @@ |
||
11 | 11 | * Class SolrCollapseFunction |
12 | 12 | * @link https://php.net/manual/en/class.solrcollapsefunction.php |
13 | 13 | */ |
14 | -class SolrCollapseFunction |
|
15 | -{ |
|
14 | +class SolrCollapseFunction { |
|
16 | 15 | /** @var string */ |
17 | 16 | public const NULLPOLICY_IGNORE = 'ignore'; |
18 | 17 |
@@ -14,2412 +14,2412 @@ |
||
14 | 14 | */ |
15 | 15 | class SolrQuery extends SolrModifiableParams implements Serializable |
16 | 16 | { |
17 | - /** @var int Used to specify that the sorting should be in acending order */ |
|
18 | - public const ORDER_ASC = 0; |
|
19 | - |
|
20 | - /** @var int Used to specify that the sorting should be in descending order */ |
|
21 | - public const ORDER_DESC = 1; |
|
22 | - |
|
23 | - /** @var int Used to specify that the facet should sort by index */ |
|
24 | - public const FACET_SORT_INDEX = 0; |
|
25 | - |
|
26 | - /** @var int Used to specify that the facet should sort by count */ |
|
27 | - public const FACET_SORT_COUNT = 1; |
|
28 | - |
|
29 | - /** @var int Used in the TermsComponent */ |
|
30 | - public const TERMS_SORT_INDEX = 0; |
|
31 | - |
|
32 | - /** @var int Used in the TermsComponent */ |
|
33 | - public const TERMS_SORT_COUNT = 1; |
|
34 | - |
|
35 | - /** |
|
36 | - * (PECL solr >= 2.2.0)<br/> |
|
37 | - * Overrides main filter query, determines which documents to include in the main group. |
|
38 | - * @link https://php.net/manual/en/solrquery.addexpandfilterquery.php |
|
39 | - * @param string $fq |
|
40 | - * @return SolrQuery <p> |
|
41 | - * Returns a SolrQuery object. |
|
42 | - * </p> |
|
43 | - */ |
|
44 | - public function addExpandFilterQuery($fq) {} |
|
45 | - |
|
46 | - /** |
|
47 | - * (PECL solr >= 2.2.0)<br/> |
|
48 | - * Orders the documents within the expanded groups (expand.sort parameter). |
|
49 | - * @link https://php.net/manual/en/solrquery.addexpandsortfield.php |
|
50 | - * @param string $field <p> |
|
51 | - * Field name |
|
52 | - * </p> |
|
53 | - * @param string $order [optional] <p> |
|
54 | - * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants. |
|
55 | - * </p> |
|
56 | - * <p> |
|
57 | - * Default: SolrQuery::ORDER_DESC |
|
58 | - * </p> |
|
59 | - * @return SolrQuery <p> |
|
60 | - * Returns a SolrQuery object. |
|
61 | - * </p> |
|
62 | - */ |
|
63 | - public function addExpandSortField($field, $order) {} |
|
64 | - |
|
65 | - /** |
|
66 | - * (PECL solr >= 0.9.2)<br/> |
|
67 | - * Maps to facet.date |
|
68 | - * @link https://php.net/manual/en/solrquery.addfacetdatefield.php |
|
69 | - * @param string $dateField <p> |
|
70 | - * The name of the date field. |
|
71 | - * </p> |
|
72 | - * @return SolrQuery <p> |
|
73 | - * Returns a SolrQuery object. |
|
74 | - * </p> |
|
75 | - */ |
|
76 | - public function addFacetDateField($dateField) {} |
|
77 | - |
|
78 | - /** |
|
79 | - * (PECL solr >= 0.9.2)<br/> |
|
80 | - * Adds another facet.date.other parameter |
|
81 | - * @link https://php.net/manual/en/solrquery.addfacetdateother.php |
|
82 | - * @param string $value <p> |
|
83 | - * The value to use. |
|
84 | - * </p> |
|
85 | - * @param string $field_override <p> |
|
86 | - * The field name for the override. |
|
87 | - * </p> |
|
88 | - * @return SolrQuery <p> |
|
89 | - * Returns the current SolrQuery object, if the return value is used. |
|
90 | - * </p> |
|
91 | - */ |
|
92 | - public function addFacetDateOther($value, $field_override) {} |
|
93 | - |
|
94 | - /** |
|
95 | - * (PECL solr >= 0.9.2)<br/> |
|
96 | - * Adds another field to the facet |
|
97 | - * @link https://php.net/manual/en/solrquery.addfacetfield.php |
|
98 | - * @param string $field <p> |
|
99 | - * The name of the field |
|
100 | - * </p> |
|
101 | - * @return SolrQuery <p> |
|
102 | - * Returns the current SolrQuery object, if the return value is used. |
|
103 | - * </p> |
|
104 | - */ |
|
105 | - public function addFacetField($field) {} |
|
106 | - |
|
107 | - /** |
|
108 | - * (PECL solr >= 0.9.2)<br/> |
|
109 | - * Adds a facet query |
|
110 | - * @link https://php.net/manual/en/solrquery.addfacetquery.php |
|
111 | - * @param string $facetQuery <p> |
|
112 | - * The facet query |
|
113 | - * </p> |
|
114 | - * @return SolrQuery <p> |
|
115 | - * Returns the current SolrQuery object, if the return value is used. |
|
116 | - * </p> |
|
117 | - */ |
|
118 | - public function addFacetQuery($facetQuery) {} |
|
119 | - |
|
120 | - /** |
|
121 | - * (PECL solr >= 0.9.2)<br/> |
|
122 | - * Specifies which fields to return in the result |
|
123 | - * @link https://php.net/manual/en/solrquery.addfield.php |
|
124 | - * @param string $field <p> |
|
125 | - * The name of the field |
|
126 | - * </p> |
|
127 | - * @return SolrQuery <p> |
|
128 | - * Returns a SolrQuery object. |
|
129 | - * </p> |
|
130 | - */ |
|
131 | - public function addField($field) {} |
|
132 | - |
|
133 | - /** |
|
134 | - * (PECL solr >= 0.9.2)<br/> |
|
135 | - * Specifies a filter query |
|
136 | - * @link https://php.net/manual/en/solrquery.addfilterquery.php |
|
137 | - * @param string $fq <p> |
|
138 | - * The filter query |
|
139 | - * </p> |
|
140 | - * @return SolrQuery <p> |
|
141 | - * Returns a SolrQuery object. |
|
142 | - * </p> |
|
143 | - */ |
|
144 | - public function addFilterQuery($fq) {} |
|
145 | - |
|
146 | - /** |
|
147 | - * (PECL solr >= 2.2.0)<br/> |
|
148 | - * Add a field to be used to group results. |
|
149 | - * @link https://php.net/manual/en/solrquery.addgroupfield.php |
|
150 | - * @param string $value |
|
151 | - * @return SolrQuery <p> |
|
152 | - * Returns a SolrQuery object. |
|
153 | - * </p> |
|
154 | - */ |
|
155 | - public function addGroupField($value) {} |
|
156 | - |
|
157 | - /** |
|
158 | - * (PECL solr >= 2.2.0)<br/> |
|
159 | - * Allows grouping results based on the unique values of a function query (group.func parameter). |
|
160 | - * @link https://php.net/manual/en/solrquery.addgroupfunction.php |
|
161 | - * @param string $value |
|
162 | - * @return SolrQuery <p> |
|
163 | - * Returns a SolrQuery object. |
|
164 | - * </p> |
|
165 | - */ |
|
166 | - public function addGroupFunction($value) {} |
|
167 | - |
|
168 | - /** |
|
169 | - * (PECL solr >= 2.2.0)<br/> |
|
170 | - * Allows grouping of documents that match the given query. |
|
171 | - * @link https://php.net/manual/en/solrquery.addgroupquery.php |
|
172 | - * @param string $value |
|
173 | - * @return SolrQuery <p> |
|
174 | - * Returns a SolrQuery object. |
|
175 | - * </p> |
|
176 | - */ |
|
177 | - public function addGroupQuery($value) {} |
|
178 | - |
|
179 | - /** |
|
180 | - * (PECL solr >= 2.2.0)<br/> |
|
181 | - * Add a group sort field (group.sort parameter). |
|
182 | - * @link https://php.net/manual/en/solrquery.addgroupsortfield.php |
|
183 | - * @param string $field <p> |
|
184 | - * Field name |
|
185 | - * </p> |
|
186 | - * @param int $order <p> |
|
187 | - * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants |
|
188 | - * </p> |
|
189 | - * @return SolrQuery <p> |
|
190 | - * Returns a SolrQuery object. |
|
191 | - * </p> |
|
192 | - */ |
|
193 | - public function addGroupSortField($field, $order) {} |
|
194 | - |
|
195 | - /** |
|
196 | - * (PECL solr >= 0.9.2)<br/> |
|
197 | - * Maps to hl.fl |
|
198 | - * @link https://php.net/manual/en/solrquery.addhighlightfield.php |
|
199 | - * @param string $field <p> |
|
200 | - * Name of the field |
|
201 | - * </p> |
|
202 | - * @return SolrQuery <p> |
|
203 | - * Returns the current SolrQuery object, if the return value is used. |
|
204 | - * </p> |
|
205 | - */ |
|
206 | - public function addHighlightField($field) {} |
|
207 | - |
|
208 | - /** |
|
209 | - * (PECL solr >= 0.9.2)<br/> |
|
210 | - * Sets a field to use for similarity |
|
211 | - * @link https://php.net/manual/en/solrquery.addmltfield.php |
|
212 | - * @param string $field <p> |
|
213 | - * The name of the field |
|
214 | - * </p> |
|
215 | - * @return SolrQuery <p> |
|
216 | - * Returns the current SolrQuery object, if the return value is used. |
|
217 | - * </p> |
|
218 | - */ |
|
219 | - public function addMltField($field) {} |
|
220 | - |
|
221 | - /** |
|
222 | - * (PECL solr >= 0.9.2)<br/> |
|
223 | - * Maps to mlt.qf |
|
224 | - * @link https://php.net/manual/en/solrquery.addmltqueryfield.php |
|
225 | - * @param string $field <p> |
|
226 | - * The name of the field |
|
227 | - * </p> |
|
228 | - * @param float $boost <p> |
|
229 | - * Its boost value |
|
230 | - * </p> |
|
231 | - * @return SolrQuery <p> |
|
232 | - * Returns the current SolrQuery object, if the return value is used. |
|
233 | - * </p> |
|
234 | - */ |
|
235 | - public function addMltQueryField($field, $boost) {} |
|
236 | - |
|
237 | - /** |
|
238 | - * (PECL solr >= 0.9.2)<br/> |
|
239 | - * Used to control how the results should be sorted |
|
240 | - * @link https://php.net/manual/en/solrquery.addsortfield.php |
|
241 | - * @param string $field <p> |
|
242 | - * The name of the field |
|
243 | - * </p> |
|
244 | - * @param int $order <p> |
|
245 | - * The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC. |
|
246 | - * </p> |
|
247 | - * @return SolrQuery <p> |
|
248 | - * Returns a SolrQuery object. |
|
249 | - * </p> |
|
250 | - */ |
|
251 | - public function addSortField($field, $order = SolrQuery::ORDER_DESC) {} |
|
252 | - |
|
253 | - /** |
|
254 | - * (PECL solr >= 0.9.2)<br/> |
|
255 | - * Requests a return of sub results for values within the given facet |
|
256 | - * @link https://php.net/manual/en/solrquery.addstatsfacet.php |
|
257 | - * @param string $field <p> |
|
258 | - * The name of the field |
|
259 | - * </p> |
|
260 | - * @return SolrQuery <p> |
|
261 | - * Returns the current SolrQuery object, if the return value is used. |
|
262 | - * </p> |
|
263 | - */ |
|
264 | - public function addStatsFacet($field) {} |
|
265 | - |
|
266 | - /** |
|
267 | - * (PECL solr >= 0.9.2)<br/> |
|
268 | - * Maps to stats.field parameter |
|
269 | - * @link https://php.net/manual/en/solrquery.addstatsfield.php |
|
270 | - * @param string $field <p> |
|
271 | - * The name of the field |
|
272 | - * </p> |
|
273 | - * @return SolrQuery <p> |
|
274 | - * Returns the current SolrQuery object, if the return value is used. |
|
275 | - * </p> |
|
276 | - */ |
|
277 | - public function addStatsField($field) {} |
|
278 | - |
|
279 | - /** |
|
280 | - * (No version information available, might only be in Git)<br/> |
|
281 | - * Collapses the result set to a single document per group |
|
282 | - * @link https://php.net/manual/en/solrquery.collapse.php |
|
283 | - * @param SolrCollapseFunction $collapseFunction |
|
284 | - * @return SolrQuery <p> |
|
285 | - * Returns a SolrQuery object. |
|
286 | - * </p> |
|
287 | - */ |
|
288 | - public function collapse(SolrCollapseFunction $collapseFunction) {} |
|
289 | - |
|
290 | - /** |
|
291 | - * (PECL solr >= 0.9.2)<br/> |
|
292 | - * SolrQuery constructor. |
|
293 | - * @link https://php.net/manual/en/solrquery.construct.php |
|
294 | - * @param string $q <p> |
|
295 | - * Optional search query |
|
296 | - * </p> |
|
297 | - */ |
|
298 | - public function __construct($q = '') {} |
|
299 | - |
|
300 | - /** |
|
301 | - * (PECL solr >= 0.9.2)<br/> |
|
302 | - * Destructor |
|
303 | - * @link https://php.net/manual/en/solrquery.destruct.php |
|
304 | - */ |
|
305 | - public function __destruct() {} |
|
306 | - |
|
307 | - /** |
|
308 | - * (PECL solr >= 2.2.0)<br/> |
|
309 | - * Returns true if group expanding is enabled |
|
310 | - * @link https://php.net/manual/en/solrquery.getexpand.php |
|
311 | - * @return bool <p> |
|
312 | - * Returns <b>TRUE</b> if group expanding is enabled |
|
313 | - * </p> |
|
314 | - */ |
|
315 | - public function getExpand() {} |
|
316 | - |
|
317 | - /** |
|
318 | - * (PECL solr >= 2.2.0)<br/> |
|
319 | - * Returns the expand filter queries |
|
320 | - * @link https://php.net/manual/en/solrquery.getexpandfilterqueries.php |
|
321 | - * @return array <p> |
|
322 | - * Returns the expand filter queries |
|
323 | - * </p> |
|
324 | - */ |
|
325 | - public function getExpandFilterQueries() {} |
|
326 | - |
|
327 | - /** |
|
328 | - * (PECL solr >= 2.2.0)<br/> |
|
329 | - * Returns the expand query expand.q parameter |
|
330 | - * @link https://php.net/manual/en/solrquery.getexpandquery.php |
|
331 | - * @return array <p> |
|
332 | - * Returns the expand query expand.q parameter |
|
333 | - * </p> |
|
334 | - */ |
|
335 | - public function getExpandQuery() {} |
|
336 | - |
|
337 | - /** |
|
338 | - * (PECL solr >= 2.2.0)<br/> |
|
339 | - * Returns The number of rows to display in each group (expand.rows) |
|
340 | - * @link https://php.net/manual/en/solrquery.getexpandrows.php |
|
341 | - * @return int <p> |
|
342 | - * Returns The number of rows to display in each group (expand.rows) |
|
343 | - * </p> |
|
344 | - */ |
|
345 | - public function getExpandRows() {} |
|
346 | - |
|
347 | - /** |
|
348 | - * (PECL solr >= 2.2.0)<br/> |
|
349 | - * Returns an array of fields |
|
350 | - * @link https://php.net/manual/en/solrquery.getexpandsortfields.php |
|
351 | - * @return array <p> |
|
352 | - * Returns an array of fields |
|
353 | - * </p> |
|
354 | - */ |
|
355 | - public function getExpandSortFields() {} |
|
356 | - |
|
357 | - /** |
|
358 | - * (PECL solr >= 0.9.2)<br/> |
|
359 | - * Returns the value of the facet parameter |
|
360 | - * @link https://php.net/manual/en/solrquery.getfacet.php |
|
361 | - * @return bool|null <p> |
|
362 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
363 | - * </p> |
|
364 | - */ |
|
365 | - public function getFacet() {} |
|
366 | - |
|
367 | - /** |
|
368 | - * (PECL solr >= 0.9.2)<br/> |
|
369 | - * Returns the value for the facet.date.end parameter |
|
370 | - * @link https://php.net/manual/en/solrquery.getfacetdateend.php |
|
371 | - * @param string $field_override [optional] <p> |
|
372 | - * The name of the field |
|
373 | - * </p> |
|
374 | - * @return string|null <p> |
|
375 | - * Returns a string on success and <b>NULL</b> if not set |
|
376 | - * </p> |
|
377 | - */ |
|
378 | - public function getFacetDateEnd($field_override) {} |
|
379 | - |
|
380 | - /** |
|
381 | - * (PECL solr >= 0.9.2)<br/> |
|
382 | - * Returns all the facet.date fields |
|
383 | - * @link https://php.net/manual/en/solrquery.getfacetdatefields.php |
|
384 | - * @return array|null <p> |
|
385 | - * Returns all the facet.date fields as an array or <b>NULL</b> if none was set |
|
386 | - * </p> |
|
387 | - */ |
|
388 | - public function getFacetDateFields() {} |
|
389 | - |
|
390 | - /** |
|
391 | - * (PECL solr >= 0.9.2)<br/> |
|
392 | - * Returns the value of the facet.date.gap parameter |
|
393 | - * @link https://php.net/manual/en/solrquery.getfacetdategap.php |
|
394 | - * @param string $field_override [optional] <p> |
|
395 | - * The name of the field |
|
396 | - * </p> |
|
397 | - * @return string|null <p> |
|
398 | - * Returns a string on success and <b>NULL</b> if not set |
|
399 | - * </p> |
|
400 | - */ |
|
401 | - public function getFacetDateGap($field_override) {} |
|
402 | - |
|
403 | - /** |
|
404 | - * (PECL solr >= 0.9.2)<br/> |
|
405 | - * Returns the value of the facet.date.hardend parameter |
|
406 | - * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php |
|
407 | - * @param string $field_override [optional] <p> |
|
408 | - * The name of the field |
|
409 | - * </p> |
|
410 | - * @return string|null <p> |
|
411 | - * Returns a string on success and <b>NULL</b> if not set |
|
412 | - * </p> |
|
413 | - */ |
|
414 | - public function getFacetDateHardEnd($field_override) {} |
|
415 | - |
|
416 | - /** |
|
417 | - * (PECL solr >= 0.9.2)<br/> |
|
418 | - * Returns the value for the facet.date.other parameter |
|
419 | - * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php |
|
420 | - * @param string $field_override [optional] <p> |
|
421 | - * The name of the field |
|
422 | - * </p> |
|
423 | - * @return array|null <p> |
|
424 | - * Returns an array on success and <b>NULL</b> if not set |
|
425 | - * </p> |
|
426 | - */ |
|
427 | - public function getFacetDateOther($field_override) {} |
|
428 | - |
|
429 | - /** |
|
430 | - * (PECL solr >= 0.9.2)<br/> |
|
431 | - * Returns the lower bound for the first date range for all date faceting on this field |
|
432 | - * @link https://php.net/manual/en/solrquery.getfacetdatestart.php |
|
433 | - * @param string $field_override [optional] <p> |
|
434 | - * The name of the field |
|
435 | - * </p> |
|
436 | - * @return string|null <p> |
|
437 | - * Returns a string on success and <b>NULL</b> if not set |
|
438 | - * </p> |
|
439 | - */ |
|
440 | - public function getFacetDateStart($field_override) {} |
|
441 | - |
|
442 | - /** |
|
443 | - * (PECL solr >= 0.9.2)<br/> |
|
444 | - * Returns all the facet fields |
|
445 | - * @link https://php.net/manual/en/solrquery.getfacetfields.php |
|
446 | - * @return array|null <p> |
|
447 | - * Returns an array of all the fields and <b>NULL</b> if none was set |
|
448 | - * </p> |
|
449 | - */ |
|
450 | - public function getFacetFields() {} |
|
451 | - |
|
452 | - /** |
|
453 | - * (PECL solr >= 0.9.2)<br/> |
|
454 | - * Returns the maximum number of constraint counts that should be returned for the facet fields |
|
455 | - * @link https://php.net/manual/en/solrquery.getfacetlimit.php |
|
456 | - * @param string $field_override [optional] <p> |
|
457 | - * The name of the field |
|
458 | - * </p> |
|
459 | - * @return int|null <p> |
|
460 | - * Returns an integer on success and <b>NULL</b> if not set |
|
461 | - * </p> |
|
462 | - */ |
|
463 | - public function getFacetLimit($field_override) {} |
|
464 | - |
|
465 | - /** |
|
466 | - * (PECL solr >= 0.9.2)<br/> |
|
467 | - * Returns the value of the facet.method parameter |
|
468 | - * @link https://php.net/manual/en/solrquery.getfacetmethod.php |
|
469 | - * @param string $field_override [optional] <p> |
|
470 | - * The name of the field |
|
471 | - * </p> |
|
472 | - * @return string|null <p> |
|
473 | - * Returns a string on success and <b>NULL</b> if not set |
|
474 | - * </p> |
|
475 | - */ |
|
476 | - public function getFacetMethod($field_override) {} |
|
477 | - |
|
478 | - /** |
|
479 | - * (PECL solr >= 0.9.2)<br/> |
|
480 | - * Returns the minimum counts for facet fields should be included in the response |
|
481 | - * @link https://php.net/manual/en/solrquery.getfacetmincount.php |
|
482 | - * @param string $field_override [optional] <p> |
|
483 | - * The name of the field |
|
484 | - * </p> |
|
485 | - * @return int|null <p> |
|
486 | - * Returns an integer on success and <b>NULL</b> if not set |
|
487 | - * </p> |
|
488 | - */ |
|
489 | - public function getFacetMinCount($field_override) {} |
|
490 | - |
|
491 | - /** |
|
492 | - * (PECL solr >= 0.9.2)<br/> |
|
493 | - * Returns the current state of the facet.missing parameter |
|
494 | - * @link https://php.net/manual/en/solrquery.getfacetmissing.php |
|
495 | - * @param string $field_override [optional] <p> |
|
496 | - * The name of the field |
|
497 | - * </p> |
|
498 | - * @return string|null <p> |
|
499 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
500 | - * </p> |
|
501 | - */ |
|
502 | - public function getFacetMissing($field_override) {} |
|
503 | - |
|
504 | - /** |
|
505 | - * (PECL solr >= 0.9.2)<br/> |
|
506 | - * Returns an offset into the list of constraints to be used for pagination |
|
507 | - * @link https://php.net/manual/en/solrquery.getfacetoffset.php |
|
508 | - * @param string $field_override [optional] <p> |
|
509 | - * The name of the field |
|
510 | - * </p> |
|
511 | - * @return int|null <p> |
|
512 | - * Returns an integer on success and <b>NULL</b> if not set |
|
513 | - * </p> |
|
514 | - */ |
|
515 | - public function getFacetOffset($field_override) {} |
|
516 | - |
|
517 | - /** |
|
518 | - * (PECL solr >= 0.9.2)<br/> |
|
519 | - * Returns the facet prefix |
|
520 | - * @link https://php.net/manual/en/solrquery.getfacetprefix.php |
|
521 | - * @param string $field_override [optional] <p> |
|
522 | - * The name of the field |
|
523 | - * </p> |
|
524 | - * @return string|null <p> |
|
525 | - * Returns a string on success and <b>NULL</b> if not set |
|
526 | - * </p> |
|
527 | - */ |
|
528 | - public function getFacetPrefix($field_override) {} |
|
529 | - |
|
530 | - /** |
|
531 | - * (PECL solr >= 0.9.2)<br/> |
|
532 | - * Returns all the facet queries |
|
533 | - * @link https://php.net/manual/en/solrquery.getfacetqueries.php |
|
534 | - * @return string|null <p> |
|
535 | - * Returns an array on success and <b>NULL</b> if not set |
|
536 | - * </p> |
|
537 | - */ |
|
538 | - public function getFacetQueries() {} |
|
539 | - |
|
540 | - /** |
|
541 | - * (PECL solr >= 0.9.2)<br/> |
|
542 | - * Returns the facet sort type |
|
543 | - * @link https://php.net/manual/en/solrquery.getfacetsort.php |
|
544 | - * @param string $field_override [optional] <p> |
|
545 | - * The name of the field |
|
546 | - * </p> |
|
547 | - * @return int|null <p> |
|
548 | - * Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or <b>NULL</b> if not |
|
549 | - * set. |
|
550 | - * </p> |
|
551 | - */ |
|
552 | - public function getFacetSort($field_override) {} |
|
553 | - |
|
554 | - /** |
|
555 | - * (PECL solr >= 0.9.2)<br/> |
|
556 | - * Returns the list of fields that will be returned in the response |
|
557 | - * @link https://php.net/manual/en/solrquery.getfields.php |
|
558 | - * @return string|null <p> |
|
559 | - * Returns an array on success and <b>NULL</b> if not set |
|
560 | - * </p> |
|
561 | - */ |
|
562 | - public function getFields() {} |
|
563 | - |
|
564 | - /** |
|
565 | - * (PECL solr >= 0.9.2)<br/> |
|
566 | - * Returns an array of filter queries |
|
567 | - * @link https://php.net/manual/en/solrquery.getfilterqueries.php |
|
568 | - * @return string|null <p> |
|
569 | - * Returns an array on success and <b>NULL</b> if not set |
|
570 | - * </p> |
|
571 | - */ |
|
572 | - public function getFilterQueries() {} |
|
573 | - |
|
574 | - /** |
|
575 | - * (PECL solr >= 2.2.0)<br/> |
|
576 | - * Returns true if grouping is enabled |
|
577 | - * https://secure.php.net/manual/en/solrquery.getgroup.php |
|
578 | - * @return bool <p> |
|
579 | - * Returns true if grouping is enabled |
|
580 | - * </p> |
|
581 | - */ |
|
582 | - public function getGroup() {} |
|
583 | - |
|
584 | - /** |
|
585 | - * (PECL solr >= 2.2.0)<br/> |
|
586 | - * Returns group cache percent value |
|
587 | - * @link https://php.net/manual/en/solrquery.getgroupcachepercent.php |
|
588 | - * @return int <p> |
|
589 | - * Returns group cache percent value |
|
590 | - * </p> |
|
591 | - */ |
|
592 | - public function getGroupCachePercent() {} |
|
593 | - |
|
594 | - /** |
|
595 | - * (PECL solr >= 2.2.0)<br/> |
|
596 | - * Returns the group.facet parameter value |
|
597 | - * @link https://php.net/manual/en/solrquery.getgroupfacet.php |
|
598 | - * @return bool <p> |
|
599 | - * Returns the group.facet parameter value |
|
600 | - * </p> |
|
601 | - */ |
|
602 | - public function getGroupFacet() {} |
|
603 | - |
|
604 | - /** |
|
605 | - * (PECL solr >= 2.2.0)<br/> |
|
606 | - * Returns group fields (group.field parameter values) |
|
607 | - * @link https://php.net/manual/en/solrquery.getgroupfields.php |
|
608 | - * @return array <p> |
|
609 | - * Returns group fields (group.field parameter values) |
|
610 | - * </p> |
|
611 | - */ |
|
612 | - public function getGroupFields() {} |
|
613 | - |
|
614 | - /** |
|
615 | - * (PECL solr >= 2.2.0)<br/> |
|
616 | - * Returns the group.format value |
|
617 | - * @link https://php.net/manual/en/solrquery.getgroupformat.php |
|
618 | - * @return string <p> |
|
619 | - * Returns the group.format value |
|
620 | - * </p> |
|
621 | - */ |
|
622 | - public function getGroupFormat() {} |
|
623 | - |
|
624 | - /** |
|
625 | - * (PECL solr >= 2.2.0)<br/> |
|
626 | - * Returns group functions (group.func parameter values) |
|
627 | - * @link https://php.net/manual/en/solrquery.getgroupfunctions.php |
|
628 | - * @return array <p> |
|
629 | - * Returns group functions (group.func parameter values) |
|
630 | - * </p> |
|
631 | - */ |
|
632 | - public function getGroupFunctions() {} |
|
633 | - |
|
634 | - /** |
|
635 | - * (PECL solr >= 2.2.0)<br/> |
|
636 | - * Returns the group.limit value |
|
637 | - * @link https://php.net/manual/en/solrquery.getgrouplimit.php |
|
638 | - * @return int <p> |
|
639 | - * Returns the group.limit value |
|
640 | - * </p> |
|
641 | - */ |
|
642 | - public function getGroupLimit() {} |
|
643 | - |
|
644 | - /** |
|
645 | - * (PECL solr >= 2.2.0)<br/> |
|
646 | - * Returns the group.main value |
|
647 | - * @link https://php.net/manual/en/solrquery.getgroupmain.php |
|
648 | - * @return bool <p> |
|
649 | - * Returns the group.main value |
|
650 | - * </p> |
|
651 | - */ |
|
652 | - public function getGroupMain() {} |
|
653 | - |
|
654 | - /** |
|
655 | - * (PECL solr >= 2.2.0)<br/> |
|
656 | - * Returns the group.ngroups value |
|
657 | - * @link https://php.net/manual/en/solrquery.getgroupngroups.php |
|
658 | - * @return bool <p> |
|
659 | - * Returns the group.ngroups value |
|
660 | - * </p> |
|
661 | - */ |
|
662 | - public function getGroupNGroups() {} |
|
663 | - |
|
664 | - /** |
|
665 | - * (PECL solr >= 2.2.0)<br/> |
|
666 | - * Returns the group.offset value |
|
667 | - * @link https://php.net/manual/en/solrquery.getgroupoffset.php |
|
668 | - * @return bool <p> |
|
669 | - * Returns the group.offset value |
|
670 | - * </p> |
|
671 | - */ |
|
672 | - public function getGroupOffset() {} |
|
673 | - |
|
674 | - /** |
|
675 | - * (PECL solr >= 2.2.0)<br/> |
|
676 | - * Returns all the group.query parameter values |
|
677 | - * @link https://php.net/manual/en/solrquery.getgroupqueries.php |
|
678 | - * @return array <p> |
|
679 | - * Returns all the group.query parameter values |
|
680 | - * </p> |
|
681 | - */ |
|
682 | - public function getGroupQueries() {} |
|
683 | - |
|
684 | - /** |
|
685 | - * (PECL solr >= 2.2.0)<br/> |
|
686 | - * Returns the group.sort value |
|
687 | - * @link https://php.net/manual/en/solrquery.getgroupsortfields.php |
|
688 | - * @return array <p> |
|
689 | - * Returns all the group.sort parameter values |
|
690 | - * </p> |
|
691 | - */ |
|
692 | - public function getGroupSortFields() {} |
|
693 | - |
|
694 | - /** |
|
695 | - * (PECL solr >= 2.2.0)<br/> |
|
696 | - * Returns the group.truncate value |
|
697 | - * @link https://php.net/manual/en/solrquery.getgrouptruncate.php |
|
698 | - * @return bool <p> |
|
699 | - * Returns the group.truncate value |
|
700 | - * </p> |
|
701 | - */ |
|
702 | - public function getGroupTruncate() {} |
|
703 | - |
|
704 | - /** |
|
705 | - * (PECL solr >= 0.9.2)<br/> |
|
706 | - * Returns the state of the hl parameter |
|
707 | - * @link https://php.net/manual/en/solrquery.gethighlight.php |
|
708 | - * @return bool <p> |
|
709 | - * Returns the state of the hl parameter |
|
710 | - * </p> |
|
711 | - */ |
|
712 | - public function getHighlight() {} |
|
713 | - |
|
714 | - /** |
|
715 | - * (PECL solr >= 0.9.2)<br/> |
|
716 | - * Returns the highlight field to use as backup or default |
|
717 | - * @link https://php.net/manual/en/solrquery.gethighlightalternatefield.php |
|
718 | - * @param string $field_override [optional] <p> |
|
719 | - * The name of the field |
|
720 | - * </p> |
|
721 | - * @return string|null <p> |
|
722 | - * Returns a string on success and <b>NULL</b> if not set |
|
723 | - * </p> |
|
724 | - */ |
|
725 | - public function getHighlightAlternateField($field_override) {} |
|
726 | - |
|
727 | - /** |
|
728 | - * (PECL solr >= 0.9.2)<br/> |
|
729 | - * Returns all the fields that Solr should generate highlighted snippets for |
|
730 | - * @link https://php.net/manual/en/solrquery.gethighlightfields.php |
|
731 | - * @return array|null <p> |
|
732 | - * Returns an array on success and <b>NULL</b> if not set |
|
733 | - * </p> |
|
734 | - */ |
|
735 | - public function getHighlightFields() {} |
|
736 | - |
|
737 | - /** |
|
738 | - * (PECL solr >= 0.9.2)<br/> |
|
739 | - * Returns the formatter for the highlighted output |
|
740 | - * @link https://php.net/manual/en/solrquery.gethighlightformatter.php |
|
741 | - * @param string $field_override [optional] <p> |
|
742 | - * The name of the field |
|
743 | - * </p> |
|
744 | - * @return string|null <p> |
|
745 | - * Returns a string on success and <b>NULL</b> if not set |
|
746 | - * </p> |
|
747 | - */ |
|
748 | - public function getHighlightFormatter($field_override) {} |
|
749 | - |
|
750 | - /** |
|
751 | - * (PECL solr >= 0.9.2)<br/> |
|
752 | - * Returns the text snippet generator for highlighted text |
|
753 | - * @link https://php.net/manual/en/solrquery.gethighlightfragmenter.php |
|
754 | - * @param string $field_override [optional] <p> |
|
755 | - * The name of the field |
|
756 | - * </p> |
|
757 | - * @return string|null <p> |
|
758 | - * Returns a string on success and <b>NULL</b> if not set |
|
759 | - * </p> |
|
760 | - */ |
|
761 | - public function getHighlightFragmenter($field_override) {} |
|
762 | - |
|
763 | - /** |
|
764 | - * (PECL solr >= 0.9.2)<br/> |
|
765 | - * Returns the number of characters of fragments to consider for highlighting |
|
766 | - * @link https://php.net/manual/en/solrquery.gethighlightfragsize.php |
|
767 | - * @param string $field_override [optional] <p> |
|
768 | - * The name of the field |
|
769 | - * </p> |
|
770 | - * @return int|null <p> |
|
771 | - * Returns an integer on success and <b>NULL</b> if not set |
|
772 | - * </p> |
|
773 | - */ |
|
774 | - public function getHighlightFragsize($field_override) {} |
|
775 | - |
|
776 | - /** |
|
777 | - * (PECL solr >= 0.9.2)<br/> |
|
778 | - * Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries |
|
779 | - * @link https://php.net/manual/en/solrquery.gethighlighthighlightmultiterm.php |
|
780 | - * @return bool|null <p> |
|
781 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
782 | - * </p> |
|
783 | - */ |
|
784 | - public function getHighlightHighlightMultiTerm() {} |
|
785 | - |
|
786 | - /** |
|
787 | - * (PECL solr >= 0.9.2)<br/> |
|
788 | - * Returns the maximum number of characters of the field to return |
|
789 | - * @link https://php.net/manual/en/solrquery.gethighlightmaxalternatefieldlength.php |
|
790 | - * @param string $field_override [optional] <p> |
|
791 | - * The name of the field |
|
792 | - * </p> |
|
793 | - * @return int|null <p> |
|
794 | - * Returns an integer on success and <b>NULL</b> if not set |
|
795 | - * </p> |
|
796 | - */ |
|
797 | - public function getHighlightMaxAlternateFieldLength($field_override) {} |
|
798 | - |
|
799 | - /** |
|
800 | - * (PECL solr >= 0.9.2)<br/> |
|
801 | - * Returns the maximum number of characters into a document to look for suitable snippets |
|
802 | - * @link https://php.net/manual/en/solrquery.gethighlightmaxanalyzedchars.php |
|
803 | - * @return int|null <p> |
|
804 | - * Returns an integer on success and <b>NULL</b> if not set |
|
805 | - * </p> |
|
806 | - */ |
|
807 | - public function getHighlightMaxAnalyzedChars() {} |
|
808 | - |
|
809 | - /** |
|
810 | - * (PECL solr >= 0.9.2)<br/> |
|
811 | - * Returns whether or not the collapse contiguous fragments into a single fragment |
|
812 | - * @link https://php.net/manual/en/solrquery.gethighlightmergecontiguous.php |
|
813 | - * @param string $field_override [optional] <p> |
|
814 | - * The name of the field |
|
815 | - * </p> |
|
816 | - * @return bool|null <p> |
|
817 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
818 | - * </p> |
|
819 | - */ |
|
820 | - public function getHighlightMergeContiguous($field_override) {} |
|
821 | - |
|
822 | - /** |
|
823 | - * (PECL solr >= 0.9.2)<br/> |
|
824 | - * Returns the maximum number of characters from a field when using the regex fragmenter |
|
825 | - * @link https://php.net/manual/en/solrquery.gethighlightregexmaxanalyzedchars.php |
|
826 | - * @return int|null <p> |
|
827 | - * Returns an integer on success and <b>NULL</b> if not set |
|
828 | - * </p> |
|
829 | - */ |
|
830 | - public function getHighlightRegexMaxAnalyzedChars() {} |
|
831 | - |
|
832 | - /** |
|
833 | - * (PECL solr >= 0.9.2)<br/> |
|
834 | - * Returns the regular expression for fragmenting |
|
835 | - * @link https://php.net/manual/en/solrquery.gethighlightregexpattern.php |
|
836 | - * @return string <p> |
|
837 | - * Returns a string on success and <b>NULL</b> if not set |
|
838 | - * </p> |
|
839 | - */ |
|
840 | - public function getHighlightRegexPattern() {} |
|
841 | - |
|
842 | - /** |
|
843 | - * (PECL solr >= 0.9.2)<br/> |
|
844 | - * Returns the deviation factor from the ideal fragment size |
|
845 | - * @link https://php.net/manual/en/solrquery.gethighlightregexslop.php |
|
846 | - * @return float|null <p> |
|
847 | - * Returns a double on success and <b>NULL</b> if not set. |
|
848 | - * </p> |
|
849 | - */ |
|
850 | - public function getHighlightRegexSlop() {} |
|
851 | - |
|
852 | - /** |
|
853 | - * (PECL solr >= 0.9.2)<br/> |
|
854 | - * Returns if a field will only be highlighted if the query matched in this particular field |
|
855 | - * @link https://php.net/manual/en/solrquery.gethighlightrequirefieldmatch.php |
|
856 | - * @return bool|null <p> |
|
857 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
858 | - * </p> |
|
859 | - */ |
|
860 | - public function getHighlightRequireFieldMatch() {} |
|
861 | - |
|
862 | - /** |
|
863 | - * (PECL solr >= 0.9.2)<br/> |
|
864 | - * Returns the text which appears after a highlighted term |
|
865 | - * @link https://php.net/manual/en/solrquery.gethighlightsimplepost.php |
|
866 | - * @param string $field_override [optional] <p> |
|
867 | - * The name of the field |
|
868 | - * </p> |
|
869 | - * @return string|null <p> |
|
870 | - * Returns a string on success and <b>NULL</b> if not set |
|
871 | - * </p> |
|
872 | - */ |
|
873 | - public function getHighlightSimplePost($field_override) {} |
|
874 | - |
|
875 | - /** |
|
876 | - * (PECL solr >= 0.9.2)<br/> |
|
877 | - * Returns the text which appears before a highlighted term |
|
878 | - * @link https://php.net/manual/en/solrquery.gethighlightsimplepre.php |
|
879 | - * @param string $field_override [optional] <p> |
|
880 | - * The name of the field |
|
881 | - * </p> |
|
882 | - * @return string|null <p> |
|
883 | - * Returns a string on success and <b>NULL</b> if not set |
|
884 | - * </p> |
|
885 | - */ |
|
886 | - public function getHighlightSimplePre($field_override) {} |
|
887 | - |
|
888 | - /** |
|
889 | - * (PECL solr >= 0.9.2)<br/> |
|
890 | - * Returns the maximum number of highlighted snippets to generate per field |
|
891 | - * @link https://php.net/manual/en/solrquery.gethighlightsnippets.php |
|
892 | - * @param string $field_override [optional] <p> |
|
893 | - * The name of the field |
|
894 | - * </p> |
|
895 | - * @return int|null <p> |
|
896 | - * Returns an integer on success and <b>NULL</b> if not set |
|
897 | - * </p> |
|
898 | - */ |
|
899 | - public function getHighlightSnippets($field_override) {} |
|
900 | - |
|
901 | - /** |
|
902 | - * (PECL solr >= 0.9.2)<br/> |
|
903 | - * Returns the state of the hl.usePhraseHighlighter parameter |
|
904 | - * @link https://php.net/manual/en/solrquery.gethighlightusephrasehighlighter.php |
|
905 | - * @return bool|null <p> |
|
906 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
907 | - * </p> |
|
908 | - */ |
|
909 | - public function getHighlightUsePhraseHighlighter() {} |
|
910 | - |
|
911 | - /** |
|
912 | - * (PECL solr >= 0.9.2)<br/> |
|
913 | - * Returns whether or not MoreLikeThis results should be enabled |
|
914 | - * @link https://php.net/manual/en/solrquery.getmlt.php |
|
915 | - * @return bool|null <p> |
|
916 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
917 | - * </p> |
|
918 | - */ |
|
919 | - public function getMlt() {} |
|
920 | - |
|
921 | - /** |
|
922 | - * (PECL solr >= 0.9.2)<br/> |
|
923 | - * Returns whether or not the query will be boosted by the interesting term relevance |
|
924 | - * @link https://php.net/manual/en/solrquery.getmltboost.php |
|
925 | - * @return bool|null <p> |
|
926 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
927 | - * </p> |
|
928 | - */ |
|
929 | - public function getMltBoost() {} |
|
930 | - |
|
931 | - /** |
|
932 | - * (PECL solr >= 0.9.2)<br/> |
|
933 | - * Returns the number of similar documents to return for each result |
|
934 | - * @link https://php.net/manual/en/solrquery.getmltcount.php |
|
935 | - * @return int|null <p> |
|
936 | - * Returns an integer on success and <b>NULL</b> if not set |
|
937 | - * </p> |
|
938 | - */ |
|
939 | - public function getMltCount() {} |
|
940 | - |
|
941 | - /** |
|
942 | - * (PECL solr >= 0.9.2)<br/> |
|
943 | - * Returns all the fields to use for similarity |
|
944 | - * @link https://php.net/manual/en/solrquery.getmltfields.php |
|
945 | - * @return array <p> |
|
946 | - * Returns an array on success and <b>NULL</b> if not set |
|
947 | - * </p> |
|
948 | - */ |
|
949 | - public function getMltFields() {} |
|
950 | - |
|
951 | - /** |
|
952 | - * (PECL solr >= 0.9.2)<br/> |
|
953 | - * Returns the maximum number of query terms that will be included in any generated query |
|
954 | - * @link https://php.net/manual/en/solrquery.getmltmaxnumqueryterms.php |
|
955 | - * @return int|null <p> |
|
956 | - * Returns an integer on success and <b>NULL</b> if not set |
|
957 | - * </p> |
|
958 | - */ |
|
959 | - public function getMltMaxNumQueryTerms() {} |
|
960 | - |
|
961 | - /** |
|
962 | - * (PECL solr >= 0.9.2)<br/> |
|
963 | - * Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support |
|
964 | - * @link https://php.net/manual/en/solrquery.getmltmaxnumtokens.php |
|
965 | - * @return int <p> |
|
966 | - * Returns an integer on success and <b>NULL</b> if not set |
|
967 | - * </p> |
|
968 | - */ |
|
969 | - public function getMltMaxNumTokens() {} |
|
970 | - |
|
971 | - /** |
|
972 | - * (PECL solr >= 0.9.2)<br/> |
|
973 | - * Returns the maximum word length above which words will be ignored |
|
974 | - * @link https://php.net/manual/en/solrquery.getmltmaxwordlength.php |
|
975 | - * @return int|null <p> |
|
976 | - * Returns an integer on success and <b>NULL</b> if not set |
|
977 | - * </p> |
|
978 | - */ |
|
979 | - public function getMltMaxWordLength() {} |
|
980 | - |
|
981 | - /** |
|
982 | - * (PECL solr >= 0.9.2)<br/> |
|
983 | - * Returns the threshold frequency at which words will be ignored which do not occur in at least this many docs |
|
984 | - * @link https://php.net/manual/en/solrquery.getmltmindocfrequency.php |
|
985 | - * @return int|null <p> |
|
986 | - * Returns an integer on success and <b>NULL</b> if not set |
|
987 | - * </p> |
|
988 | - */ |
|
989 | - public function getMltMinDocFrequency() {} |
|
990 | - |
|
991 | - /** |
|
992 | - * (PECL solr >= 0.9.2)<br/> |
|
993 | - * Returns the frequency below which terms will be ignored in the source document |
|
994 | - * @link https://php.net/manual/en/solrquery.getmltmintermfrequency.php |
|
995 | - * @return int|null <p> |
|
996 | - * Returns an integer on success and <b>NULL</b> if not set |
|
997 | - * </p> |
|
998 | - */ |
|
999 | - public function getMltMinTermFrequency() {} |
|
1000 | - |
|
1001 | - /** |
|
1002 | - * (PECL solr >= 0.9.2)<br/> |
|
1003 | - * Returns the minimum word length below which words will be ignored |
|
1004 | - * @link https://php.net/manual/en/solrquery.getmltminwordlength.php |
|
1005 | - * @return int <p> |
|
1006 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1007 | - * </p> |
|
1008 | - */ |
|
1009 | - public function getMltMinWordLength() {} |
|
1010 | - |
|
1011 | - /** |
|
1012 | - * (PECL solr >= 0.9.2)<br/> |
|
1013 | - * Returns the query fields and their boosts |
|
1014 | - * @link https://php.net/manual/en/solrquery.getmltqueryfields.php |
|
1015 | - * @return array|null <p> |
|
1016 | - * Returns an array on success and <b>NULL</b> if not set |
|
1017 | - * </p> |
|
1018 | - */ |
|
1019 | - public function getMltQueryFields() {} |
|
1020 | - |
|
1021 | - /** |
|
1022 | - * (PECL solr >= 0.9.2)<br/> |
|
1023 | - * Returns the main query |
|
1024 | - * @link https://php.net/manual/en/solrquery.getquery.php |
|
1025 | - * @return string <p> |
|
1026 | - * Returns a string on success and <b>NULL</b> if not set |
|
1027 | - * </p> |
|
1028 | - */ |
|
1029 | - public function getQuery() {} |
|
1030 | - |
|
1031 | - /** |
|
1032 | - * (PECL solr >= 0.9.2)<br/> |
|
1033 | - * Returns the maximum number of documents |
|
1034 | - * @link https://php.net/manual/en/solrquery.getrows.php |
|
1035 | - * @return int|null <p> |
|
1036 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1037 | - * </p> |
|
1038 | - */ |
|
1039 | - public function getRows() {} |
|
1040 | - |
|
1041 | - /** |
|
1042 | - * (PECL solr >= 0.9.2)<br/> |
|
1043 | - * Returns all the sort fields |
|
1044 | - * @link https://php.net/manual/en/solrquery.getsortfields.php |
|
1045 | - * @return array <p> |
|
1046 | - * Returns an array on success and <b>NULL</b> if none of the parameters was set. |
|
1047 | - * </p> |
|
1048 | - */ |
|
1049 | - public function getSortFields() {} |
|
1050 | - |
|
1051 | - /** |
|
1052 | - * (PECL solr >= 0.9.2)<br/> |
|
1053 | - * Returns the offset in the complete result set |
|
1054 | - * @link https://php.net/manual/en/solrquery.getstart.php |
|
1055 | - * @return int|null <p> |
|
1056 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1057 | - * </p> |
|
1058 | - */ |
|
1059 | - public function getStart() {} |
|
1060 | - |
|
1061 | - /** |
|
1062 | - * (PECL solr >= 0.9.2)<br/> |
|
1063 | - * Returns whether or not stats is enabled |
|
1064 | - * @link https://php.net/manual/en/solrquery.getstats.php |
|
1065 | - * @return bool|null <p> |
|
1066 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
1067 | - * </p> |
|
1068 | - */ |
|
1069 | - public function getStats() {} |
|
1070 | - |
|
1071 | - /** |
|
1072 | - * (PECL solr >= 0.9.2)<br/> |
|
1073 | - * Returns all the stats facets that were set |
|
1074 | - * @link https://php.net/manual/en/solrquery.getstatsfacets.php |
|
1075 | - * @return array|null <p> |
|
1076 | - * Returns an array on success and <b>NULL</b> if not set |
|
1077 | - * </p> |
|
1078 | - */ |
|
1079 | - public function getStatsFacets() {} |
|
1080 | - |
|
1081 | - /** |
|
1082 | - * (PECL solr >= 0.9.2)<br/> |
|
1083 | - * Returns all the statistics fields |
|
1084 | - * @link https://php.net/manual/en/solrquery.getstatsfields.php |
|
1085 | - * @return array|null <p> |
|
1086 | - * Returns an array on success and <b>NULL</b> if not set |
|
1087 | - * </p> |
|
1088 | - */ |
|
1089 | - public function getStatsFields() {} |
|
1090 | - |
|
1091 | - /** |
|
1092 | - * (PECL solr >= 0.9.2)<br/> |
|
1093 | - * Returns whether or not the TermsComponent is enabled |
|
1094 | - * @link https://php.net/manual/en/solrquery.getterms.php |
|
1095 | - * @return bool|null <p> |
|
1096 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
1097 | - * </p> |
|
1098 | - */ |
|
1099 | - public function getTerms() {} |
|
1100 | - |
|
1101 | - /** |
|
1102 | - * (PECL solr >= 0.9.2)<br/> |
|
1103 | - * Returns the field from which the terms are retrieved |
|
1104 | - * @link https://php.net/manual/en/solrquery.gettermsfield.php |
|
1105 | - * @return string|null <p> |
|
1106 | - * Returns a string on success and <b>NULL</b> if not set |
|
1107 | - * </p> |
|
1108 | - */ |
|
1109 | - public function getTermsField() {} |
|
1110 | - |
|
1111 | - /** |
|
1112 | - * (PECL solr >= 0.9.2)<br/> |
|
1113 | - * Returns whether or not to include the lower bound in the result set |
|
1114 | - * @link https://php.net/manual/en/solrquery.gettermsincludelowerbound.php |
|
1115 | - * @return bool|null <p> |
|
1116 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
1117 | - * </p> |
|
1118 | - */ |
|
1119 | - public function getTermsIncludeLowerBound() {} |
|
1120 | - |
|
1121 | - /** |
|
1122 | - * (PECL solr >= 0.9.2)<br/> |
|
1123 | - * Returns whether or not to include the upper bound term in the result set |
|
1124 | - * @link https://php.net/manual/en/solrquery.gettermsincludeupperbound.php |
|
1125 | - * @return bool|null <p> |
|
1126 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
1127 | - * </p> |
|
1128 | - */ |
|
1129 | - public function getTermsIncludeUpperBound() {} |
|
1130 | - |
|
1131 | - /** |
|
1132 | - * (PECL solr >= 0.9.2)<br/> |
|
1133 | - * Returns the maximum number of terms Solr should return |
|
1134 | - * @link https://php.net/manual/en/solrquery.gettermslimit.php |
|
1135 | - * @return int|null <p> |
|
1136 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1137 | - * </p> |
|
1138 | - */ |
|
1139 | - public function getTermsLimit() {} |
|
1140 | - |
|
1141 | - /** |
|
1142 | - * (PECL solr >= 0.9.2)<br/> |
|
1143 | - * Returns the term to start at |
|
1144 | - * @link https://php.net/manual/en/solrquery.gettermslowerbound.php |
|
1145 | - * @return string|null <p> |
|
1146 | - * Returns a string on success and <b>NULL</b> if not set |
|
1147 | - * </p> |
|
1148 | - */ |
|
1149 | - public function getTermsLowerBound() {} |
|
1150 | - |
|
1151 | - /** |
|
1152 | - * (PECL solr >= 0.9.2)<br/> |
|
1153 | - * Returns the maximum document frequency |
|
1154 | - * @link https://php.net/manual/en/solrquery.gettermsmaxcount.php |
|
1155 | - * @return int|null <p> |
|
1156 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1157 | - * </p> |
|
1158 | - */ |
|
1159 | - public function getTermsMaxCount() {} |
|
1160 | - |
|
1161 | - /** |
|
1162 | - * (PECL solr >= 0.9.2)<br/> |
|
1163 | - * Returns the minimum document frequency to return in order to be included |
|
1164 | - * @link https://php.net/manual/en/solrquery.gettermsmincount.php |
|
1165 | - * @return int|null <p> |
|
1166 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1167 | - * </p> |
|
1168 | - */ |
|
1169 | - public function getTermsMinCount() {} |
|
1170 | - |
|
1171 | - /** |
|
1172 | - * (PECL solr >= 0.9.2)<br/> |
|
1173 | - * Returns the term prefix |
|
1174 | - * @link https://php.net/manual/en/solrquery.gettermsprefix.php |
|
1175 | - * @return string|null <p> |
|
1176 | - * Returns a string on success and <b>NULL</b> if not set |
|
1177 | - * </p> |
|
1178 | - */ |
|
1179 | - public function getTermsPrefix() {} |
|
1180 | - |
|
1181 | - /** |
|
1182 | - * (PECL solr >= 0.9.2)<br/> |
|
1183 | - * Whether or not to return raw characters |
|
1184 | - * @link https://php.net/manual/en/solrquery.gettermsreturnraw.php |
|
1185 | - * @return bool|null <p> |
|
1186 | - * Returns a boolean on success and <b>NULL</b> if not set |
|
1187 | - * </p> |
|
1188 | - */ |
|
1189 | - public function getTermsReturnRaw() {} |
|
1190 | - |
|
1191 | - /** |
|
1192 | - * (PECL solr >= 0.9.2)<br/> |
|
1193 | - * Returns an integer indicating how terms are sorted |
|
1194 | - * @link https://php.net/manual/en/solrquery.gettermssort.php |
|
1195 | - * @return int|null <p> |
|
1196 | - * Returns an integer on success and <b>NULL</b> if not set<br/> |
|
1197 | - * SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.<br/> |
|
1198 | - * SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first) |
|
1199 | - * </p> |
|
1200 | - */ |
|
1201 | - public function getTermsSort() {} |
|
1202 | - |
|
1203 | - /** |
|
1204 | - * (PECL solr >= 0.9.2)<br/> |
|
1205 | - * Returns the term to stop at |
|
1206 | - * @link https://php.net/manual/en/solrquery.gettermsupperbound.php |
|
1207 | - * @return string|null <p> |
|
1208 | - * Returns a string on success and <b>NULL</b> if not set |
|
1209 | - * </p> |
|
1210 | - */ |
|
1211 | - public function getTermsUpperBound() {} |
|
1212 | - |
|
1213 | - /** |
|
1214 | - * (PECL solr >= 0.9.2)<br/> |
|
1215 | - * Returns the time in milliseconds allowed for the query to finish |
|
1216 | - * @link https://php.net/manual/en/solrquery.gettimeallowed.php |
|
1217 | - * @return int|null <p> |
|
1218 | - * Returns an integer on success and <b>NULL</b> if not set |
|
1219 | - * </p> |
|
1220 | - */ |
|
1221 | - public function getTimeAllowed() {} |
|
1222 | - |
|
1223 | - /** |
|
1224 | - * (PECL solr >= 2.2.0)<br/> |
|
1225 | - * Removes an expand filter query |
|
1226 | - * @link https://php.net/manual/en/solrquery.removeexpandfilterquery.php |
|
1227 | - * @param string $fq |
|
1228 | - * @return SolrQuery <p> |
|
1229 | - * Returns the current SolrQuery object, if the return value is used. |
|
1230 | - * </p> |
|
1231 | - */ |
|
1232 | - public function removeExpandFilterQuery($fq) {} |
|
1233 | - |
|
1234 | - /** |
|
1235 | - * (PECL solr >= 2.2.0)<br/> |
|
1236 | - * Removes an expand sort field from the expand.sort parameter. |
|
1237 | - * @link https://php.net/manual/en/solrquery.removeexpandsortfield.php |
|
1238 | - * @param string $field <p> |
|
1239 | - * Field name |
|
1240 | - * </p> |
|
1241 | - * @return SolrQuery <p> |
|
1242 | - * Returns the current SolrQuery object, if the return value is used. |
|
1243 | - * </p> |
|
1244 | - */ |
|
1245 | - public function removeExpandSortField($field) {} |
|
1246 | - |
|
1247 | - /** |
|
1248 | - * (PECL solr >= 0.9.2)<br/> |
|
1249 | - * Removes one of the facet date fields |
|
1250 | - * @link https://php.net/manual/en/solrquery.removefacetdatefield.php |
|
1251 | - * @param string $field <p> |
|
1252 | - * The name of the date field to remove |
|
1253 | - * </p> |
|
1254 | - * @return SolrQuery <p> |
|
1255 | - * Returns the current SolrQuery object, if the return value is used. |
|
1256 | - * </p> |
|
1257 | - */ |
|
1258 | - public function removeFacetDateField($field) {} |
|
1259 | - |
|
1260 | - /** |
|
1261 | - * (PECL solr >= 0.9.2)<br/> |
|
1262 | - * Removes one of the facet.date.other parameters |
|
1263 | - * @link https://php.net/manual/en/solrquery.removefacetdateother.php |
|
1264 | - * @param string $value <p> |
|
1265 | - * The value |
|
1266 | - * </p> |
|
1267 | - * @param string $field_override [optional] <p> |
|
1268 | - * The name of the field. |
|
1269 | - * </p> |
|
1270 | - * @return SolrQuery <p> |
|
1271 | - * Returns the current SolrQuery object, if the return value is used. |
|
1272 | - * </p> |
|
1273 | - */ |
|
1274 | - public function removeFacetDateOther($value, $field_override) {} |
|
1275 | - |
|
1276 | - /** |
|
1277 | - * (PECL solr >= 0.9.2)<br/> |
|
1278 | - * Removes one of the facet.date parameters |
|
1279 | - * @link https://php.net/manual/en/solrquery.removefacetfield.php |
|
1280 | - * @param string $field <p> |
|
1281 | - * The name of the field |
|
1282 | - * </p> |
|
1283 | - * @return SolrQuery <p> |
|
1284 | - * Returns the current SolrQuery object, if the return value is used. |
|
1285 | - * </p> |
|
1286 | - */ |
|
1287 | - public function removeFacetField($field) {} |
|
1288 | - |
|
1289 | - /** |
|
1290 | - * (PECL solr >= 0.9.2)<br/> |
|
1291 | - * Removes one of the facet.query parameters |
|
1292 | - * @link https://php.net/manual/en/solrquery.removefacetquery.php |
|
1293 | - * @param string $value <p> |
|
1294 | - * The value |
|
1295 | - * </p> |
|
1296 | - * @return SolrQuery <p> |
|
1297 | - * Returns the current SolrQuery object, if the return value is used. |
|
1298 | - * </p> |
|
1299 | - */ |
|
1300 | - public function removeFacetQuery($value) {} |
|
1301 | - |
|
1302 | - /** |
|
1303 | - * (PECL solr >= 0.9.2)<br/> |
|
1304 | - * Removes a field from the list of fields |
|
1305 | - * @link https://php.net/manual/en/solrquery.removefield.php |
|
1306 | - * @param string $field <p> |
|
1307 | - * The name of the field |
|
1308 | - * </p> |
|
1309 | - * @return SolrQuery <p> |
|
1310 | - * Returns the current SolrQuery object, if the return value is used. |
|
1311 | - * </p> |
|
1312 | - */ |
|
1313 | - public function removeField($field) {} |
|
1314 | - |
|
1315 | - /** |
|
1316 | - * (PECL solr >= 0.9.2)<br/> |
|
1317 | - * Removes a filter query |
|
1318 | - * @link https://php.net/manual/en/solrquery.removefilterquery.php |
|
1319 | - * @param string $fq |
|
1320 | - * @return SolrQuery <p> |
|
1321 | - * Returns the current SolrQuery object, if the return value is used. |
|
1322 | - * </p> |
|
1323 | - */ |
|
1324 | - public function removeFilterQuery($fq) {} |
|
1325 | - |
|
1326 | - /** |
|
1327 | - * (PECL solr >= 0.9.2)<br/> |
|
1328 | - * Removes one of the fields used for highlighting |
|
1329 | - * @link https://php.net/manual/en/solrquery.removehighlightfield.php |
|
1330 | - * @param string $field <p> |
|
1331 | - * The name of the field |
|
1332 | - * </p> |
|
1333 | - * @return SolrQuery <p> |
|
1334 | - * Returns the current SolrQuery object, if the return value is used. |
|
1335 | - * </p> |
|
1336 | - */ |
|
1337 | - public function removeHighlightField($field) {} |
|
1338 | - |
|
1339 | - /** |
|
1340 | - * (PECL solr >= 0.9.2)<br/> |
|
1341 | - * Removes one of the moreLikeThis fields |
|
1342 | - * @link https://php.net/manual/en/solrquery.removemltfield.php |
|
1343 | - * @param string $field <p> |
|
1344 | - * The name of the field |
|
1345 | - * </p> |
|
1346 | - * @return SolrQuery <p> |
|
1347 | - * Returns the current SolrQuery object, if the return value is used. |
|
1348 | - * </p> |
|
1349 | - */ |
|
1350 | - public function removeMltField($field) {} |
|
1351 | - |
|
1352 | - /** |
|
1353 | - * (PECL solr >= 0.9.2)<br/> |
|
1354 | - * Removes one of the moreLikeThis query fields |
|
1355 | - * @link https://php.net/manual/en/solrquery.removemltqueryfield.php |
|
1356 | - * @param string $queryField <p> |
|
1357 | - * The query field |
|
1358 | - * </p> |
|
1359 | - * @return SolrQuery <p> |
|
1360 | - * Returns the current SolrQuery object, if the return value is used. |
|
1361 | - * </p> |
|
1362 | - */ |
|
1363 | - public function removeMltQueryField($queryField) {} |
|
1364 | - |
|
1365 | - /** |
|
1366 | - * (PECL solr >= 0.9.2)<br/> |
|
1367 | - * Removes one of the sort fields |
|
1368 | - * @link https://php.net/manual/en/solrquery.removesortfield.php |
|
1369 | - * @param string $field <p> |
|
1370 | - * The name of the field |
|
1371 | - * </p> |
|
1372 | - * @return SolrQuery <p> |
|
1373 | - * Returns the current SolrQuery object, if the return value is used. |
|
1374 | - * </p> |
|
1375 | - */ |
|
1376 | - public function removeSortField($field) {} |
|
1377 | - |
|
1378 | - /** |
|
1379 | - * (PECL solr >= 0.9.2)<br/> |
|
1380 | - * Removes one of the stats.facet parameters |
|
1381 | - * @link https://php.net/manual/en/solrquery.removestatsfacet.php |
|
1382 | - * @param string $value <p> |
|
1383 | - * The value |
|
1384 | - * </p> |
|
1385 | - * @return SolrQuery <p> |
|
1386 | - * Returns the current SolrQuery object, if the return value is used. |
|
1387 | - * </p> |
|
1388 | - */ |
|
1389 | - public function removeStatsFacet($value) {} |
|
1390 | - |
|
1391 | - /** |
|
1392 | - * (PECL solr >= 0.9.2)<br/> |
|
1393 | - * Removes one of the stats.field parameters |
|
1394 | - * @link https://php.net/manual/en/solrquery.removestatsfield.php |
|
1395 | - * @param string $field <p> |
|
1396 | - * The name of the field |
|
1397 | - * </p> |
|
1398 | - * @return SolrQuery <p> |
|
1399 | - * Returns the current SolrQuery object, if the return value is used. |
|
1400 | - * </p> |
|
1401 | - */ |
|
1402 | - public function removeStatsField($field) {} |
|
1403 | - |
|
1404 | - /** |
|
1405 | - * (PECL solr >= 0.9.2)<br/> |
|
1406 | - * Toggles the echoHandler parameter |
|
1407 | - * @link https://php.net/manual/en/solrquery.setechohandler.php |
|
1408 | - * @param bool $flag <p> |
|
1409 | - * <b>TRUE</b> or <b>FALSE</b> |
|
1410 | - * </p> |
|
1411 | - * @return SolrQuery <p> |
|
1412 | - * Returns the current SolrQuery object, if the return value is used. |
|
1413 | - * </p> |
|
1414 | - */ |
|
1415 | - public function setEchoHandler($flag) {} |
|
1416 | - |
|
1417 | - /** |
|
1418 | - * (PECL solr >= 0.9.2)<br/> |
|
1419 | - * Determines what kind of parameters to include in the response |
|
1420 | - * @link https://php.net/manual/en/solrquery.setechoparams.php |
|
1421 | - * @param string $type <p> |
|
1422 | - * The type of parameters to include: |
|
1423 | - * </p> |
|
1424 | - * <ul> |
|
1425 | - * <li><b>none</b>: don't include any request parameters for debugging</li> |
|
1426 | - * <li><b>explicit</b>: include the parameters explicitly specified by the client in the request</li> |
|
1427 | - * <li><b>all</b>: include all parameters involved in this request, either specified explicitly by the client, or |
|
1428 | - * implicit because of the request handler configuration.</li> |
|
1429 | - * </ul> |
|
1430 | - * @return SolrQuery <p> |
|
1431 | - * Returns the current SolrQuery object, if the return value is used. |
|
1432 | - * </p> |
|
1433 | - */ |
|
1434 | - public function setEchoParams($type) {} |
|
1435 | - |
|
1436 | - /** |
|
1437 | - * (PECL solr >= 2.2.0)<br/> |
|
1438 | - * Enables/Disables the Expand Component |
|
1439 | - * @link https://php.net/manual/en/solrquery.setexpand.php |
|
1440 | - * @param bool $value <p> |
|
1441 | - * Bool flag |
|
1442 | - * </b> |
|
1443 | - * @return SolrQuery <p> |
|
1444 | - * Returns the current SolrQuery object, if the return value is used. |
|
1445 | - * </p> |
|
1446 | - */ |
|
1447 | - public function setExpand($value) {} |
|
1448 | - |
|
1449 | - /** |
|
1450 | - * (PECL solr >= 2.2.0)<br/> |
|
1451 | - * Sets the expand.q parameter |
|
1452 | - * @link https://php.net/manual/en/solrquery.setexpandquery.php |
|
1453 | - * @param string $q |
|
1454 | - * @return SolrQuery <p> |
|
1455 | - * Returns the current SolrQuery object, if the return value is used. |
|
1456 | - * </p> |
|
1457 | - */ |
|
1458 | - public function setExpandQuery($q) {} |
|
1459 | - |
|
1460 | - /** |
|
1461 | - * (PECL solr >= 2.2.0)<br/> |
|
1462 | - * Sets the number of rows to display in each group (expand.rows). Server Default 5 |
|
1463 | - * @link https://php.net/manual/en/solrquery.setexpandrows.php |
|
1464 | - * @param int $value |
|
1465 | - * @return SolrQuery <p> |
|
1466 | - * Returns the current SolrQuery object, if the return value is used. |
|
1467 | - * </p> |
|
1468 | - */ |
|
1469 | - public function setExpandRows($value) {} |
|
1470 | - |
|
1471 | - /** |
|
1472 | - * (PECL solr >= 0.9.2)<br/> |
|
1473 | - * Sets the explainOther common query parameter |
|
1474 | - * @link https://php.net/manual/en/solrquery.setexplainother.php |
|
1475 | - * @param string $query <p> |
|
1476 | - * The Lucene query to identify a set of documents |
|
1477 | - * </p> |
|
1478 | - * @return SolrQuery <p> |
|
1479 | - * Returns the current SolrQuery object, if the return value is used. |
|
1480 | - * </p> |
|
1481 | - */ |
|
1482 | - public function setExplainOther($query) {} |
|
1483 | - |
|
1484 | - /** |
|
1485 | - * (PECL solr >= 0.9.2)<br/> |
|
1486 | - * Maps to the facet parameter. Enables or disables facetting |
|
1487 | - * @link https://php.net/manual/en/solrquery.setfacet.php |
|
1488 | - * @param bool $flag <p> |
|
1489 | - * <b>TRUE</b> enables faceting and <b>FALSE</b> disables it. |
|
1490 | - * </p> |
|
1491 | - * @return SolrQuery <p> |
|
1492 | - * Returns the current SolrQuery object, if the return value is used. |
|
1493 | - * </p> |
|
1494 | - */ |
|
1495 | - public function setFacet($flag) {} |
|
1496 | - |
|
1497 | - /** |
|
1498 | - * (PECL solr >= 0.9.2)<br/> |
|
1499 | - * Maps to facet.date.end |
|
1500 | - * @link https://php.net/manual/en/solrquery.setfacetdateend.php |
|
1501 | - * @param string $value <p> |
|
1502 | - * See facet.date.end |
|
1503 | - * </p> |
|
1504 | - * @param string $field_override [optional] <p> |
|
1505 | - * Name of the field |
|
1506 | - * </p> |
|
1507 | - * @return SolrQuery <p> |
|
1508 | - * Returns the current SolrQuery object, if the return value is used. |
|
1509 | - * </p> |
|
1510 | - */ |
|
1511 | - public function setFacetDateEnd($value, $field_override) {} |
|
1512 | - |
|
1513 | - /** |
|
1514 | - * (PECL solr >= 0.9.2)<br/> |
|
1515 | - * Maps to facet.date.gap |
|
1516 | - * @link https://php.net/manual/en/solrquery.setfacetdategap.php |
|
1517 | - * @param string $value <p> |
|
1518 | - * See facet.date.gap |
|
1519 | - * </p> |
|
1520 | - * @param string $field_override [optional] <p> |
|
1521 | - * Name of the field |
|
1522 | - * </p> |
|
1523 | - * @return SolrQuery <p> |
|
1524 | - * Returns the current SolrQuery object, if the return value is used. |
|
1525 | - * </p> |
|
1526 | - */ |
|
1527 | - public function setFacetDateGap($value, $field_override) {} |
|
1528 | - |
|
1529 | - /** |
|
1530 | - * (PECL solr >= 0.9.2)<br/> |
|
1531 | - * Maps to facet.date.hardend |
|
1532 | - * @link https://php.net/manual/en/solrquery.setfacetdatehardend.php |
|
1533 | - * @param bool $value <p> |
|
1534 | - * See facet.date.hardend |
|
1535 | - * </p> |
|
1536 | - * @param string $field_override [optional] <p> |
|
1537 | - * Name of the field |
|
1538 | - * </p> |
|
1539 | - * @return SolrQuery <p> |
|
1540 | - * Returns the current SolrQuery object, if the return value is used. |
|
1541 | - * </p> |
|
1542 | - */ |
|
1543 | - public function setFacetDateHardEnd($value, $field_override) {} |
|
1544 | - |
|
1545 | - /** |
|
1546 | - * (PECL solr >= 0.9.2)<br/> |
|
1547 | - * Maps to facet.date.start |
|
1548 | - * @link https://php.net/manual/en/solrquery.setfacetdatestart.php |
|
1549 | - * @param string $value <p> |
|
1550 | - * See facet.date.start |
|
1551 | - * </p> |
|
1552 | - * @param string $field_override [optional] <p> |
|
1553 | - * Name of the field |
|
1554 | - * </p> |
|
1555 | - * @return SolrQuery <p> |
|
1556 | - * Returns the current SolrQuery object, if the return value is used. |
|
1557 | - * </p> |
|
1558 | - */ |
|
1559 | - public function setFacetDateStart($value, $field_override) {} |
|
1560 | - |
|
1561 | - /** |
|
1562 | - * (PECL solr >= 0.9.2)<br/> |
|
1563 | - * Sets the minimum document frequency used for determining term count |
|
1564 | - * @link https://php.net/manual/en/solrquery.setfacetenumcachemindefaultfrequency.php |
|
1565 | - * @param int $frequency <p> |
|
1566 | - * The minimum frequency |
|
1567 | - * </p> |
|
1568 | - * @param string $field_override [optional] <p> |
|
1569 | - * Name of the field |
|
1570 | - * </p> |
|
1571 | - * @return SolrQuery <p> |
|
1572 | - * Returns the current SolrQuery object, if the return value is used. |
|
1573 | - * </p> |
|
1574 | - */ |
|
1575 | - public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override) {} |
|
1576 | - |
|
1577 | - /** |
|
1578 | - * (PECL solr >= 0.9.2)<br/> |
|
1579 | - * Maps to facet.limit |
|
1580 | - * @link https://php.net/manual/en/solrquery.setfacetlimit.php |
|
1581 | - * @param int $limit <p> |
|
1582 | - * The maximum number of constraint counts |
|
1583 | - * </p> |
|
1584 | - * @param string $field_override [optional] <p> |
|
1585 | - * Name of the field |
|
1586 | - * </p> |
|
1587 | - * @return SolrQuery <p> |
|
1588 | - * Returns the current SolrQuery object, if the return value is used. |
|
1589 | - * </p> |
|
1590 | - */ |
|
1591 | - public function setFacetLimit($limit, $field_override) {} |
|
1592 | - |
|
1593 | - /** |
|
1594 | - * (PECL solr >= 0.9.2)<br/> |
|
1595 | - * Specifies the type of algorithm to use when faceting a field |
|
1596 | - * @link https://php.net/manual/en/solrquery.setfacetmethod.php |
|
1597 | - * @param string $method <p> |
|
1598 | - * The method to use. |
|
1599 | - * </p> |
|
1600 | - * @param string $field_override [optional] <p> |
|
1601 | - * Name of the field |
|
1602 | - * </p> |
|
1603 | - * @return SolrQuery <p> |
|
1604 | - * Returns the current SolrQuery object, if the return value is used. |
|
1605 | - * </p> |
|
1606 | - */ |
|
1607 | - public function setFacetMethod($method, $field_override) {} |
|
1608 | - |
|
1609 | - /** |
|
1610 | - * (PECL solr >= 0.9.2)<br/> |
|
1611 | - * Maps to facet.mincount |
|
1612 | - * @link https://php.net/manual/en/solrquery.setfacetmincount.php |
|
1613 | - * @param int $mincount <p> |
|
1614 | - * The minimum count |
|
1615 | - * </p> |
|
1616 | - * @param string $field_override [optional] <p> |
|
1617 | - * Name of the field |
|
1618 | - * </p> |
|
1619 | - * @return SolrQuery <p> |
|
1620 | - * Returns the current SolrQuery object, if the return value is used. |
|
1621 | - * </p> |
|
1622 | - */ |
|
1623 | - public function setFacetMinCount($mincount, $field_override) {} |
|
1624 | - |
|
1625 | - /** |
|
1626 | - * (PECL solr >= 0.9.2)<br/> |
|
1627 | - * Maps to facet.missing |
|
1628 | - * @link https://php.net/manual/en/solrquery.setfacetmissing.php |
|
1629 | - * @param bool $flag <p> |
|
1630 | - * <b>TRUE</b> turns this feature on. <b>FALSE</b> disables it. |
|
1631 | - * </p> |
|
1632 | - * @param string $field_override [optional] <p> |
|
1633 | - * Name of the field |
|
1634 | - * </p> |
|
1635 | - * @return SolrQuery <p> |
|
1636 | - * Returns the current SolrQuery object, if the return value is used. |
|
1637 | - * </p> |
|
1638 | - */ |
|
1639 | - public function setFacetMissing($flag, $field_override) {} |
|
1640 | - |
|
1641 | - /** |
|
1642 | - * (PECL solr >= 0.9.2)<br/> |
|
1643 | - * Sets the offset into the list of constraints to allow for pagination |
|
1644 | - * @link https://php.net/manual/en/solrquery.setfacetoffset.php |
|
1645 | - * @param int $offset <p> |
|
1646 | - * The offset |
|
1647 | - * </p> |
|
1648 | - * @param string $field_override [optional] <p> |
|
1649 | - * Name of the field |
|
1650 | - * </p> |
|
1651 | - * @return SolrQuery <p> |
|
1652 | - * Returns the current SolrQuery object, if the return value is used. |
|
1653 | - * </p> |
|
1654 | - */ |
|
1655 | - public function setFacetOffset($offset, $field_override) {} |
|
1656 | - |
|
1657 | - /** |
|
1658 | - * (PECL solr >= 0.9.2)<br/> |
|
1659 | - * Specifies a string prefix with which to limits the terms on which to facet |
|
1660 | - * @link https://php.net/manual/en/solrquery.setfacetprefix.php |
|
1661 | - * @param string $prefix <p> |
|
1662 | - * The prefix string |
|
1663 | - * </p> |
|
1664 | - * @param string $field_override [optional] <p> |
|
1665 | - * Name of the field |
|
1666 | - * </p> |
|
1667 | - * @return SolrQuery <p> |
|
1668 | - * Returns the current SolrQuery object, if the return value is used. |
|
1669 | - * </p> |
|
1670 | - */ |
|
1671 | - public function setFacetPrefix($prefix, $field_override) {} |
|
1672 | - |
|
1673 | - /** |
|
1674 | - * (PECL solr >= 0.9.2)<br/> |
|
1675 | - * Determines the ordering of the facet field constraints |
|
1676 | - * @link https://php.net/manual/en/solrquery.setfacetsort.php |
|
1677 | - * @param int $facetSort <p> |
|
1678 | - * Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count. |
|
1679 | - * </p> |
|
1680 | - * @param string $field_override [optional] <p> |
|
1681 | - * Name of the field |
|
1682 | - * </p> |
|
1683 | - * @return SolrQuery <p> |
|
1684 | - * Returns the current SolrQuery object, if the return value is used. |
|
1685 | - * </p> |
|
1686 | - */ |
|
1687 | - public function setFacetSort($facetSort, $field_override) {} |
|
1688 | - |
|
1689 | - /** |
|
1690 | - * (PECL solr >= 2.2.0)<br/> |
|
1691 | - * Enable/Disable result grouping (group parameter) |
|
1692 | - * @link https://php.net/manual/en/solrquery.setgroup.php |
|
1693 | - * @param bool $value |
|
1694 | - * @return SolrQuery <p> |
|
1695 | - * Returns the current SolrQuery object, if the return value is used. |
|
1696 | - * </p> |
|
1697 | - */ |
|
1698 | - public function setGroup($value) {} |
|
1699 | - |
|
1700 | - /** |
|
1701 | - * (PECL solr >= 2.2.0)<br/> |
|
1702 | - * Enables caching for result grouping |
|
1703 | - * @link https://php.net/manual/en/solrquery.setgroupcachepercent.php |
|
1704 | - * @param int $percent <p> |
|
1705 | - * Setting this parameter to a number greater than 0 enables caching for result grouping. Result Grouping executes |
|
1706 | - * two searches; this option caches the second search. The server default value is 0. Testing has shown that group |
|
1707 | - * caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or |
|
1708 | - * "match all" queries, group caching degrades performance. group.cache.percent parameter. |
|
1709 | - * </p> |
|
1710 | - * @return SolrQuery <p> |
|
1711 | - * Returns the current SolrQuery object, if the return value is used. |
|
1712 | - * </p> |
|
1713 | - */ |
|
1714 | - public function setGroupCachePercent($percent) {} |
|
1715 | - |
|
1716 | - /** |
|
1717 | - * (PECL solr >= 2.2.0)<br/> |
|
1718 | - * Sets group.facet parameter |
|
1719 | - * @link https://php.net/manual/en/solrquery.setgroupfacet.php |
|
1720 | - * @param bool $value |
|
1721 | - * @return SolrQuery <p> |
|
1722 | - * Returns the current SolrQuery object, if the return value is used. |
|
1723 | - * </p> |
|
1724 | - */ |
|
1725 | - public function setGroupFacet($value) {} |
|
1726 | - |
|
1727 | - /** |
|
1728 | - * (PECL solr >= 2.2.0)<br/> |
|
1729 | - * Sets the group format, result structure (group.format parameter). |
|
1730 | - * @link https://php.net/manual/en/solrquery.setgroupformat.php |
|
1731 | - * @param string $value <p> |
|
1732 | - * Sets the group.format parameter. If this parameter is set to simple, the grouped documents are presented in a |
|
1733 | - * single flat list, and the start and rows parameters affect the numbers of documents instead of groups.<br/> |
|
1734 | - * Accepts: grouped/simple |
|
1735 | - * </p> |
|
1736 | - * @return SolrQuery <p> |
|
1737 | - * Returns the current SolrQuery object, if the return value is used. |
|
1738 | - * </p> |
|
1739 | - */ |
|
1740 | - public function setGroupFormat($value) {} |
|
1741 | - |
|
1742 | - /** |
|
1743 | - * (PECL solr >= 2.2.0)<br/> |
|
1744 | - * Specifies the number of results to return for each group. The server default value is 1. |
|
1745 | - * @link https://php.net/manual/en/solrquery.setgrouplimit.php |
|
1746 | - * @param int $value |
|
1747 | - * @return SolrQuery <p> |
|
1748 | - * Returns the current SolrQuery object, if the return value is used. |
|
1749 | - * </p> |
|
1750 | - */ |
|
1751 | - public function setGroupLimit($value) {} |
|
1752 | - |
|
1753 | - /** |
|
1754 | - * (PECL solr >= 2.2.0)<br/> |
|
1755 | - * If true, the result of the first field grouping command is used as the main result list in the response, using |
|
1756 | - * group.format=simple. |
|
1757 | - * @link https://php.net/manual/en/solrquery.setgroupmain.php |
|
1758 | - * @param string $value |
|
1759 | - * @return SolrQuery <p> |
|
1760 | - * Returns the current SolrQuery object, if the return value is used. |
|
1761 | - * </p> |
|
1762 | - */ |
|
1763 | - public function setGroupMain($value) {} |
|
1764 | - |
|
1765 | - /** |
|
1766 | - * (PECL solr >= 2.2.0)<br/> |
|
1767 | - * If true, Solr includes the number of groups that have matched the query in the results. |
|
1768 | - * @link https://php.net/manual/en/solrquery.setgroupngroups.php |
|
1769 | - * @param bool $value |
|
1770 | - * @return SolrQuery <p> |
|
1771 | - * Returns the current SolrQuery object, if the return value is used. |
|
1772 | - * </p> |
|
1773 | - */ |
|
1774 | - public function setGroupNGroups($value) {} |
|
1775 | - |
|
1776 | - /** |
|
1777 | - * (PECL solr >= 2.2.0)<br/> |
|
1778 | - * Sets the group.offset parameter. |
|
1779 | - * @link https://php.net/manual/en/solrquery.setgroupoffset.php |
|
1780 | - * @param int $value |
|
1781 | - * @return SolrQuery <p> |
|
1782 | - * Returns the current SolrQuery object, if the return value is used. |
|
1783 | - * </p> |
|
1784 | - */ |
|
1785 | - public function setGroupOffset($value) {} |
|
1786 | - |
|
1787 | - /** |
|
1788 | - * (PECL solr >= 2.2.0)<br/> |
|
1789 | - * If true, facet counts are based on the most relevant document of each group matching the query. |
|
1790 | - * @link https://php.net/manual/en/solrquery.setgrouptruncate.php |
|
1791 | - * @param bool $value |
|
1792 | - * @return SolrQuery <p> |
|
1793 | - * Returns the current SolrQuery object, if the return value is used. |
|
1794 | - * </p> |
|
1795 | - */ |
|
1796 | - public function setGroupTruncate($value) {} |
|
1797 | - |
|
1798 | - /** |
|
1799 | - * (PECL solr >= 0.9.2)<br/> |
|
1800 | - * Enables or disables highlighting |
|
1801 | - * @link https://php.net/manual/en/solrquery.sethighlight.php |
|
1802 | - * @param bool $flag <p> |
|
1803 | - * Setting it to <b>TRUE</b> enables highlighted snippets to be generated in the query response.<br/> |
|
1804 | - * Setting it to <b>FALSE</b> disables highlighting |
|
1805 | - * </p> |
|
1806 | - * @return SolrQuery <p> |
|
1807 | - * Returns the current SolrQuery object, if the return value is used. |
|
1808 | - * </p> |
|
1809 | - */ |
|
1810 | - public function setHighlight($flag) {} |
|
1811 | - |
|
1812 | - /** |
|
1813 | - * (PECL solr >= 0.9.2)<br/> |
|
1814 | - * Specifies the backup field to use |
|
1815 | - * @link https://php.net/manual/en/solrquery.sethighlightalternatefield.php |
|
1816 | - * @param string $field <p> |
|
1817 | - * The name of the backup field |
|
1818 | - * </p> |
|
1819 | - * @param string $field_override [optional] <p> |
|
1820 | - * Name of the field |
|
1821 | - * </p> |
|
1822 | - * @return SolrQuery <p> |
|
1823 | - * Returns the current SolrQuery object, if the return value is used. |
|
1824 | - * </p> |
|
1825 | - */ |
|
1826 | - public function setHighlightAlternateField($field, $field_override) {} |
|
1827 | - |
|
1828 | - /** |
|
1829 | - * (PECL solr >= 0.9.2)<br/> |
|
1830 | - * Specify a formatter for the highlight output |
|
1831 | - * @link https://php.net/manual/en/solrquery.sethighlightformatter.php |
|
1832 | - * @param string $formatter <p> |
|
1833 | - * Currently the only legal value is "simple" |
|
1834 | - * </p> |
|
1835 | - * @param string $field_override [optional] <p> |
|
1836 | - * Name of the field |
|
1837 | - * </p> |
|
1838 | - * @return SolrQuery <p> |
|
1839 | - * Returns the current SolrQuery object, if the return value is used. |
|
1840 | - * </p> |
|
1841 | - */ |
|
1842 | - public function setHighlightFormatter($formatter, $field_override) {} |
|
1843 | - |
|
1844 | - /** |
|
1845 | - * (PECL solr >= 0.9.2)<br/> |
|
1846 | - * Sets a text snippet generator for highlighted text |
|
1847 | - * @link https://php.net/manual/en/solrquery.sethighlightfragmenter.php |
|
1848 | - * @param string $fragmenter <p> |
|
1849 | - * The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain |
|
1850 | - * regular expression |
|
1851 | - * </p> |
|
1852 | - * @param string $field_override [optional] <p> |
|
1853 | - * Name of the field |
|
1854 | - * </p> |
|
1855 | - * @return SolrQuery <p> |
|
1856 | - * Returns the current SolrQuery object, if the return value is used. |
|
1857 | - * </p> |
|
1858 | - */ |
|
1859 | - public function setHighlightFragmenter($fragmenter, $field_override) {} |
|
1860 | - |
|
1861 | - /** |
|
1862 | - * (PECL solr >= 0.9.2)<br/> |
|
1863 | - * The size of fragments to consider for highlighting |
|
1864 | - * @link https://php.net/manual/en/solrquery.sethighlightfragsize.php |
|
1865 | - * @param int $size <p> |
|
1866 | - * The size, in characters, of fragments to consider for highlighting |
|
1867 | - * </p> |
|
1868 | - * @param string $field_override [optional] <p> |
|
1869 | - * Name of the field |
|
1870 | - * </p> |
|
1871 | - * @return SolrQuery <p> |
|
1872 | - * Returns the current SolrQuery object, if the return value is used. |
|
1873 | - * </p> |
|
1874 | - */ |
|
1875 | - public function setHighlightFragsize($size, $field_override) {} |
|
1876 | - |
|
1877 | - /** |
|
1878 | - * (PECL solr >= 0.9.2)<br/> |
|
1879 | - * Use SpanScorer to highlight phrase terms |
|
1880 | - * @link https://php.net/manual/en/solrquery.sethighlighthighlightmultiterm.php |
|
1881 | - * @param bool $flag <p> |
|
1882 | - * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the |
|
1883 | - * document. |
|
1884 | - * </p> |
|
1885 | - * @return SolrQuery <p> |
|
1886 | - * Returns the current SolrQuery object, if the return value is used. |
|
1887 | - * </p> |
|
1888 | - */ |
|
1889 | - public function setHighlightHighlightMultiTerm($flag) {} |
|
1890 | - |
|
1891 | - /** |
|
1892 | - * (PECL solr >= 0.9.2)<br/> |
|
1893 | - * Sets the maximum number of characters of the field to return |
|
1894 | - * @link https://php.net/manual/en/solrquery.sethighlightmaxalternatefieldlength.php |
|
1895 | - * @param int $fieldLength <p> |
|
1896 | - * The length of the field |
|
1897 | - * </p> |
|
1898 | - * <p> |
|
1899 | - * If SolrQuery::setHighlightAlternateField() was passed the value <b>TRUE</b>, this parameter specifies the maximum |
|
1900 | - * number of characters of the field to return |
|
1901 | - * </p> |
|
1902 | - * <p> |
|
1903 | - * Any value less than or equal to 0 means unlimited. |
|
1904 | - * </p> |
|
1905 | - * @param string $field_override [optional] <p> |
|
1906 | - * Name of the field |
|
1907 | - * </p> |
|
1908 | - * @return SolrQuery <p> |
|
1909 | - * Returns the current SolrQuery object, if the return value is used. |
|
1910 | - * </p> |
|
1911 | - */ |
|
1912 | - public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override) {} |
|
1913 | - |
|
1914 | - /** |
|
1915 | - * (PECL solr >= 0.9.2)<br/> |
|
1916 | - * Specifies the number of characters into a document to look for suitable snippets |
|
1917 | - * @link https://php.net/manual/en/solrquery.sethighlightmaxanalyzedchars.php |
|
1918 | - * @param int $value <p> |
|
1919 | - * The number of characters into a document to look for suitable snippets |
|
1920 | - * </p> |
|
1921 | - * @return SolrQuery <p> |
|
1922 | - * Returns the current SolrQuery object, if the return value is used. |
|
1923 | - * </p> |
|
1924 | - */ |
|
1925 | - public function setHighlightMaxAnalyzedChars($value) {} |
|
1926 | - |
|
1927 | - /** |
|
1928 | - * (PECL solr >= 0.9.2)<br/> |
|
1929 | - * Whether or not to collapse contiguous fragments into a single fragment |
|
1930 | - * @link https://php.net/manual/en/solrquery.sethighlightmergecontiguous.php |
|
1931 | - * @param bool $flag <p> |
|
1932 | - * Whether or not to collapse contiguous fragments into a single fragment |
|
1933 | - * </p> |
|
1934 | - * @param string $field_override [optional] <p> |
|
1935 | - * Name of the field |
|
1936 | - * </p> |
|
1937 | - * @return SolrQuery <p> |
|
1938 | - * Returns the current SolrQuery object, if the return value is used. |
|
1939 | - * </p> |
|
1940 | - */ |
|
1941 | - public function setHighlightMergeContiguous($flag, $field_override) {} |
|
1942 | - |
|
1943 | - /** |
|
1944 | - * (PECL solr >= 0.9.2)<br/> |
|
1945 | - * Specify the maximum number of characters to analyze |
|
1946 | - * @link https://php.net/manual/en/solrquery.sethighlightregexmaxanalyzedchars.php |
|
1947 | - * @param int $maxAnalyzedChars <p> |
|
1948 | - * The maximum number of characters to analyze from a field when using the regex fragmenter |
|
1949 | - * </p> |
|
1950 | - * @return SolrQuery <p> |
|
1951 | - * Returns the current SolrQuery object, if the return value is used. |
|
1952 | - * </p> |
|
1953 | - */ |
|
1954 | - public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars) {} |
|
1955 | - |
|
1956 | - /** |
|
1957 | - * (PECL solr >= 0.9.2)<br/> |
|
1958 | - * Specify the regular expression for fragmenting |
|
1959 | - * @link https://php.net/manual/en/solrquery.sethighlightregexpattern.php |
|
1960 | - * @param string $value <p> |
|
1961 | - * The regular expression for fragmenting. This could be used to extract sentences |
|
1962 | - * </p> |
|
1963 | - * @return SolrQuery <p> |
|
1964 | - * Returns the current SolrQuery object, if the return value is used. |
|
1965 | - * </p> |
|
1966 | - */ |
|
1967 | - public function setHighlightRegexPattern($value) {} |
|
1968 | - |
|
1969 | - /** |
|
1970 | - * (PECL solr >= 0.9.2)<br/> |
|
1971 | - * Sets the factor by which the regex fragmenter can stray from the ideal fragment size |
|
1972 | - * @link https://php.net/manual/en/solrquery.sethighlightregexslop.php |
|
1973 | - * @param float $factor <p> |
|
1974 | - * The factor by which the regex fragmenter can stray from the ideal fragment size (specified by |
|
1975 | - * SolrQuery::setHighlightFragsize) to accommodate the regular expression. |
|
1976 | - * </p> |
|
1977 | - * @return SolrQuery <p> |
|
1978 | - * Returns the current SolrQuery object, if the return value is used. |
|
1979 | - * </p> |
|
1980 | - */ |
|
1981 | - public function setHighlightRegexSlop($factor) {} |
|
1982 | - |
|
1983 | - /** |
|
1984 | - * (PECL solr >= 0.9.2)<br/> |
|
1985 | - * Require field matching during highlighting |
|
1986 | - * @link https://php.net/manual/en/solrquery.sethighlightrequirefieldmatch.php |
|
1987 | - * @param bool $flag <p> |
|
1988 | - * If <b>TRUE</b>, then a field will only be highlighted if the query matched in this particular field.<br/> |
|
1989 | - * This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <b>TRUE</b>. |
|
1990 | - * </p> |
|
1991 | - * @return SolrQuery <p> |
|
1992 | - * Returns the current SolrQuery object, if the return value is used. |
|
1993 | - * </p> |
|
1994 | - */ |
|
1995 | - public function setHighlightRequireFieldMatch($flag) {} |
|
1996 | - |
|
1997 | - /** |
|
1998 | - * (PECL solr >= 0.9.2)<br/> |
|
1999 | - * Sets the text which appears after a highlighted term |
|
2000 | - * @link https://php.net/manual/en/solrquery.sethighlightsimplepost.php |
|
2001 | - * @param string $simplePost <p> |
|
2002 | - * Sets the text which appears after a highlighted term. The default is </em> |
|
2003 | - * </p> |
|
2004 | - * @param string $field_override [optional] <p> |
|
2005 | - * Name of the field |
|
2006 | - * </p> |
|
2007 | - * @return SolrQuery <p> |
|
2008 | - * Returns the current SolrQuery object, if the return value is used. |
|
2009 | - * </p> |
|
2010 | - */ |
|
2011 | - public function setHighlightSimplePost($simplePost, $field_override) {} |
|
2012 | - |
|
2013 | - /** |
|
2014 | - * (PECL solr >= 0.9.2)<br/> |
|
2015 | - * Sets the text which appears before a highlighted term |
|
2016 | - * @link https://php.net/manual/en/solrquery.sethighlightsimplepre.php |
|
2017 | - * @param string $simplePre <p> |
|
2018 | - * Sets the text which appears before a highlighted term. The default is <em> |
|
2019 | - * </p> |
|
2020 | - * @param string $field_override [optional] <p> |
|
2021 | - * Name of the field |
|
2022 | - * </p> |
|
2023 | - * @return SolrQuery <p> |
|
2024 | - * Returns the current SolrQuery object, if the return value is used. |
|
2025 | - * </p> |
|
2026 | - */ |
|
2027 | - public function setHighlightSimplePre($simplePre, $field_override) {} |
|
2028 | - |
|
2029 | - /** |
|
2030 | - * (PECL solr >= 0.9.2)<br/> |
|
2031 | - * Sets the maximum number of highlighted snippets to generate per field |
|
2032 | - * @link https://php.net/manual/en/solrquery.sethighlightsnippets.php |
|
2033 | - * @param int $value <p> |
|
2034 | - * The maximum number of highlighted snippets to generate per field |
|
2035 | - * </p> |
|
2036 | - * @param string $field_override [optional] <p> |
|
2037 | - * Name of the field |
|
2038 | - * </p> |
|
2039 | - * @return SolrQuery <p> |
|
2040 | - * Returns the current SolrQuery object, if the return value is used. |
|
2041 | - * </p> |
|
2042 | - */ |
|
2043 | - public function setHighlightSnippets($value, $field_override) {} |
|
2044 | - |
|
2045 | - /** |
|
2046 | - * (PECL solr >= 0.9.2)<br/> |
|
2047 | - * Whether to highlight phrase terms only when they appear within the query phrase |
|
2048 | - * @link https://php.net/manual/en/solrquery.sethighlightusephrasehighlighter.php |
|
2049 | - * @param bool $flag <p> |
|
2050 | - * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the |
|
2051 | - * document. |
|
2052 | - * </p> |
|
2053 | - * @return SolrQuery <p> |
|
2054 | - * Returns the current SolrQuery object, if the return value is used. |
|
2055 | - * </p> |
|
2056 | - */ |
|
2057 | - public function setHighlightUsePhraseHighlighter($flag) {} |
|
2058 | - |
|
2059 | - /** |
|
2060 | - * (PECL solr >= 0.9.2)<br/> |
|
2061 | - * Enables or disables moreLikeThis |
|
2062 | - * @link https://php.net/manual/en/solrquery.setmlt.php |
|
2063 | - * @param bool $flag <p> |
|
2064 | - * <b>TRUE</b> enables it and <b>FALSE</b> turns it off. |
|
2065 | - * </p> |
|
2066 | - * @return SolrQuery <p> |
|
2067 | - * Returns the current SolrQuery object, if the return value is used. |
|
2068 | - * </p> |
|
2069 | - */ |
|
2070 | - public function setMlt($flag) {} |
|
2071 | - |
|
2072 | - /** |
|
2073 | - * (PECL solr >= 0.9.2)<br/> |
|
2074 | - * Set if the query will be boosted by the interesting term relevance |
|
2075 | - * @link https://php.net/manual/en/solrquery.setmltboost.php |
|
2076 | - * @param bool $flag <p> |
|
2077 | - * Sets to <b>TRUE</b> or <b>FALSE</b> |
|
2078 | - * </p> |
|
2079 | - * @return SolrQuery <p> |
|
2080 | - * Returns the current SolrQuery object, if the return value is used. |
|
2081 | - * </p> |
|
2082 | - */ |
|
2083 | - public function setMltBoost($flag) {} |
|
2084 | - |
|
2085 | - /** |
|
2086 | - * (PECL solr >= 0.9.2)<br/> |
|
2087 | - * Set the number of similar documents to return for each result |
|
2088 | - * @link https://php.net/manual/en/solrquery.setmltcount.php |
|
2089 | - * @param int $count <p> |
|
2090 | - * The number of similar documents to return for each result |
|
2091 | - * </p> |
|
2092 | - * @return SolrQuery <p> |
|
2093 | - * Returns the current SolrQuery object, if the return value is used. |
|
2094 | - * </p> |
|
2095 | - */ |
|
2096 | - public function setMltCount($count) {} |
|
2097 | - |
|
2098 | - /** |
|
2099 | - * (PECL solr >= 0.9.2)<br/> |
|
2100 | - * Sets the maximum number of query terms included |
|
2101 | - * @link https://php.net/manual/en/solrquery.setmltmaxnumqueryterms.php |
|
2102 | - * @param int $value <p> |
|
2103 | - * The maximum number of query terms that will be included in any generated query |
|
2104 | - * </p> |
|
2105 | - * @return SolrQuery <p> |
|
2106 | - * Returns the current SolrQuery object, if the return value is used. |
|
2107 | - * </p> |
|
2108 | - */ |
|
2109 | - public function setMltMaxNumQueryTerms($value) {} |
|
2110 | - |
|
2111 | - /** |
|
2112 | - * (PECL solr >= 0.9.2)<br/> |
|
2113 | - * Specifies the maximum number of tokens to parse |
|
2114 | - * @link https://php.net/manual/en/solrquery.setmltmaxnumtokens.php |
|
2115 | - * @param int $value <p> |
|
2116 | - * The maximum number of tokens to parse |
|
2117 | - * </p> |
|
2118 | - * @return SolrQuery <p> |
|
2119 | - * Returns the current SolrQuery object, if the return value is used. |
|
2120 | - * </p> |
|
2121 | - */ |
|
2122 | - public function setMltMaxNumTokens($value) {} |
|
2123 | - |
|
2124 | - /** |
|
2125 | - * (PECL solr >= 0.9.2)<br/> |
|
2126 | - * Sets the maximum word length |
|
2127 | - * @link https://php.net/manual/en/solrquery.setmltmaxwordlength.php |
|
2128 | - * @param int $maxWordLength <p> |
|
2129 | - * The maximum word length above which words will be ignored |
|
2130 | - * </p> |
|
2131 | - * @return SolrQuery <p> |
|
2132 | - * Returns the current SolrQuery object, if the return value is used. |
|
2133 | - * </p> |
|
2134 | - */ |
|
2135 | - public function setMltMaxWordLength($maxWordLength) {} |
|
2136 | - |
|
2137 | - /** |
|
2138 | - * (PECL solr >= 0.9.2)<br/> |
|
2139 | - * Sets the mltMinDoc frequency |
|
2140 | - * @link https://php.net/manual/en/solrquery.setmltmindocfrequency.php |
|
2141 | - * @param int $minDocFrequency <p> |
|
2142 | - * Sets the frequency at which words will be ignored which do not occur in at least this many docs. |
|
2143 | - * </p> |
|
2144 | - * @return SolrQuery <p> |
|
2145 | - * Returns the current SolrQuery object, if the return value is used. |
|
2146 | - * </p> |
|
2147 | - */ |
|
2148 | - public function setMltMinDocFrequency($minDocFrequency) {} |
|
2149 | - |
|
2150 | - /** |
|
2151 | - * (PECL solr >= 0.9.2)<br/> |
|
2152 | - * Sets the frequency below which terms will be ignored in the source docs |
|
2153 | - * @link https://php.net/manual/en/solrquery.setmltmintermfrequency.php |
|
2154 | - * @param int $minTermFrequency <p> |
|
2155 | - * The frequency below which terms will be ignored in the source docs |
|
2156 | - * </p> |
|
2157 | - * @return SolrQuery <p> |
|
2158 | - * Returns the current SolrQuery object, if the return value is used. |
|
2159 | - * </p> |
|
2160 | - */ |
|
2161 | - public function setMltMinTermFrequency($minTermFrequency) {} |
|
2162 | - |
|
2163 | - /** |
|
2164 | - * (PECL solr >= 0.9.2)<br/> |
|
2165 | - * Sets the minimum word length |
|
2166 | - * @link https://php.net/manual/en/solrquery.setmltminwordlength.php |
|
2167 | - * @param int $minWordLength <p> |
|
2168 | - * The minimum word length below which words will be ignored |
|
2169 | - * </p> |
|
2170 | - * @return SolrQuery <p> |
|
2171 | - * Returns the current SolrQuery object, if the return value is used. |
|
2172 | - * </p> |
|
2173 | - */ |
|
2174 | - public function setMltMinWordLength($minWordLength) {} |
|
2175 | - |
|
2176 | - /** |
|
2177 | - * (PECL solr >= 0.9.2)<br/> |
|
2178 | - * Exclude the header from the returned results |
|
2179 | - * @link https://php.net/manual/en/solrquery.setomitheader.php |
|
2180 | - * @param bool $flag <p> |
|
2181 | - * <b>TRUE</b> excludes the header from the result. |
|
2182 | - * </p> |
|
2183 | - * @return SolrQuery <p> |
|
2184 | - * Returns the current SolrQuery object, if the return value is used. |
|
2185 | - * </p> |
|
2186 | - */ |
|
2187 | - public function setOmitHeader($flag) {} |
|
2188 | - |
|
2189 | - /** |
|
2190 | - * (PECL solr >= 0.9.2)<br/> |
|
2191 | - * Sets the search query |
|
2192 | - * @link https://php.net/manual/en/solrquery.setquery.php |
|
2193 | - * @param string $query <p> |
|
2194 | - * The search query |
|
2195 | - * </p> |
|
2196 | - * @return SolrQuery <p> |
|
2197 | - * Returns the current SolrQuery object, if the return value is used. |
|
2198 | - * </p> |
|
2199 | - */ |
|
2200 | - public function setQuery($query) {} |
|
2201 | - |
|
2202 | - /** |
|
2203 | - * (PECL solr >= 0.9.2)<br/> |
|
2204 | - * Specifies the maximum number of rows to return in the result |
|
2205 | - * @link https://php.net/manual/en/solrquery.setrows.php |
|
2206 | - * @param int $rows <p> |
|
2207 | - * The maximum number of rows to return |
|
2208 | - * </p> |
|
2209 | - * @return SolrQuery <p> |
|
2210 | - * Returns the current SolrQuery object, if the return value is used. |
|
2211 | - * </p> |
|
2212 | - */ |
|
2213 | - public function setRows($rows) {} |
|
2214 | - |
|
2215 | - /** |
|
2216 | - * (PECL solr >= 0.9.2)<br/> |
|
2217 | - * Flag to show debug information |
|
2218 | - * @link https://php.net/manual/en/solrquery.setshowdebuginfo.php |
|
2219 | - * @param bool $flag <p> |
|
2220 | - * Whether to show debug info. <b>TRUE</b> or <b>FALSE</b> |
|
2221 | - * </p> |
|
2222 | - * @return SolrQuery <p> |
|
2223 | - * Returns the current SolrQuery object, if the return value is used. |
|
2224 | - * </p> |
|
2225 | - */ |
|
2226 | - public function setShowDebugInfo($flag) {} |
|
2227 | - |
|
2228 | - /** |
|
2229 | - * (PECL solr >= 0.9.2)<br/> |
|
2230 | - * Specifies the number of rows to skip |
|
2231 | - * @link https://php.net/manual/en/solrquery.setstart.php |
|
2232 | - * @param int $start <p> |
|
2233 | - * The number of rows to skip. |
|
2234 | - * </p> |
|
2235 | - * @return SolrQuery <p> |
|
2236 | - * Returns the current SolrQuery object, if the return value is used. |
|
2237 | - * </p> |
|
2238 | - */ |
|
2239 | - public function setStart($start) {} |
|
2240 | - |
|
2241 | - /** |
|
2242 | - * (PECL solr >= 0.9.2)<br/> |
|
2243 | - * Enables or disables the Stats component |
|
2244 | - * @link https://php.net/manual/en/solrquery.setstats.php |
|
2245 | - * @param bool $flag <p> |
|
2246 | - * <b>TRUE</b> turns on the stats component and <b>FALSE</b> disables it. |
|
2247 | - * </p> |
|
2248 | - * @return SolrQuery <p> |
|
2249 | - * Returns the current SolrQuery object, if the return value is used. |
|
2250 | - * </p> |
|
2251 | - */ |
|
2252 | - public function setStats($flag) {} |
|
2253 | - |
|
2254 | - /** |
|
2255 | - * (PECL solr >= 0.9.2)<br/> |
|
2256 | - * Enables or disables the TermsComponent |
|
2257 | - * @link https://php.net/manual/en/solrquery.setterms.php |
|
2258 | - * @param bool $flag <p> |
|
2259 | - * <b>TRUE</b> enables it. <b>FALSE</b> turns it off |
|
2260 | - * </p> |
|
2261 | - * @return SolrQuery <p> |
|
2262 | - * Returns the current SolrQuery object, if the return value is used. |
|
2263 | - * </p> |
|
2264 | - */ |
|
2265 | - public function setTerms($flag) {} |
|
2266 | - |
|
2267 | - /** |
|
2268 | - * (PECL solr >= 0.9.2)<br/> |
|
2269 | - * Sets the name of the field to get the Terms from |
|
2270 | - * @link https://php.net/manual/en/solrquery.settermsfield.php |
|
2271 | - * @param string $fieldname <p> |
|
2272 | - * The field name |
|
2273 | - * </p> |
|
2274 | - * @return SolrQuery <p> |
|
2275 | - * Returns the current SolrQuery object, if the return value is used. |
|
2276 | - * </p> |
|
2277 | - */ |
|
2278 | - public function setTermsField($fieldname) {} |
|
2279 | - |
|
2280 | - /** |
|
2281 | - * (PECL solr >= 0.9.2)<br/> |
|
2282 | - * Include the lower bound term in the result set |
|
2283 | - * @link https://php.net/manual/en/solrquery.settermsincludelowerbound.php |
|
2284 | - * @param bool $flag <p> |
|
2285 | - * Include the lower bound term in the result set |
|
2286 | - * </p> |
|
2287 | - * @return SolrQuery <p> |
|
2288 | - * Returns the current SolrQuery object, if the return value is used. |
|
2289 | - * </p> |
|
2290 | - */ |
|
2291 | - public function setTermsIncludeLowerBound($flag) {} |
|
2292 | - |
|
2293 | - /** |
|
2294 | - * (PECL solr >= 0.9.2)<br/> |
|
2295 | - * Include the upper bound term in the result set |
|
2296 | - * @link https://php.net/manual/en/solrquery.settermsincludeupperbound.php |
|
2297 | - * @param bool $flag <p> |
|
2298 | - * <b>TRUE</b> or <b>FALSE</b> |
|
2299 | - * </p> |
|
2300 | - * @return SolrQuery <p> |
|
2301 | - * Returns the current SolrQuery object, if the return value is used. |
|
2302 | - * </p> |
|
2303 | - */ |
|
2304 | - public function setTermsIncludeUpperBound($flag) {} |
|
2305 | - |
|
2306 | - /** |
|
2307 | - * (PECL solr >= 0.9.2)<br/> |
|
2308 | - * Sets the maximum number of terms to return |
|
2309 | - * @link https://php.net/manual/en/solrquery.settermslimit.php |
|
2310 | - * @param int $limit <p> |
|
2311 | - * The maximum number of terms to return. All the terms will be returned if the limit is negative. |
|
2312 | - * </p> |
|
2313 | - * @return SolrQuery <p> |
|
2314 | - * Returns the current SolrQuery object, if the return value is used. |
|
2315 | - * </p> |
|
2316 | - */ |
|
2317 | - public function setTermsLimit($limit) {} |
|
2318 | - |
|
2319 | - /** |
|
2320 | - * (PECL solr >= 0.9.2)<br/> |
|
2321 | - * Specifies the Term to start from |
|
2322 | - * @link https://php.net/manual/en/solrquery.settermslowerbound.php |
|
2323 | - * @param string $lowerBound <p> |
|
2324 | - * The lower bound Term |
|
2325 | - * </p> |
|
2326 | - * @return SolrQuery <p> |
|
2327 | - * Returns the current SolrQuery object, if the return value is used. |
|
2328 | - * </p> |
|
2329 | - */ |
|
2330 | - public function setTermsLowerBound($lowerBound) {} |
|
2331 | - |
|
2332 | - /** |
|
2333 | - * (PECL solr >= 0.9.2)<br/> |
|
2334 | - * Sets the maximum document frequency |
|
2335 | - * @link https://php.net/manual/en/solrquery.settermsmaxcount.php |
|
2336 | - * @param int $frequency <p> |
|
2337 | - * The maximum document frequency. |
|
2338 | - * </p> |
|
2339 | - * @return SolrQuery <p> |
|
2340 | - * Returns the current SolrQuery object, if the return value is used. |
|
2341 | - * </p> |
|
2342 | - */ |
|
2343 | - public function setTermsMaxCount($frequency) {} |
|
2344 | - |
|
2345 | - /** |
|
2346 | - * (PECL solr >= 0.9.2)<br/> |
|
2347 | - * Sets the minimum document frequency |
|
2348 | - * @link https://php.net/manual/en/solrquery.settermsmincount.php |
|
2349 | - * @param int $frequency <p> |
|
2350 | - * The minimum frequency |
|
2351 | - * </p> |
|
2352 | - * @return SolrQuery <p> |
|
2353 | - * Returns the current SolrQuery object, if the return value is used. |
|
2354 | - * </p> |
|
2355 | - */ |
|
2356 | - public function setTermsMinCount($frequency) {} |
|
2357 | - |
|
2358 | - /** |
|
2359 | - * (PECL solr >= 0.9.2)<br/> |
|
2360 | - * Restrict matches to terms that start with the prefix |
|
2361 | - * @link https://php.net/manual/en/solrquery.settermsprefix.php |
|
2362 | - * @param string $prefix <p> |
|
2363 | - * Restrict matches to terms that start with the prefix |
|
2364 | - * </p> |
|
2365 | - * @return SolrQuery <p> |
|
2366 | - * Returns the current SolrQuery object, if the return value is used. |
|
2367 | - * </p> |
|
2368 | - */ |
|
2369 | - public function setTermsPrefix($prefix) {} |
|
2370 | - |
|
2371 | - /** |
|
2372 | - * (PECL solr >= 0.9.2)<br/> |
|
2373 | - * Return the raw characters of the indexed term |
|
2374 | - * @link https://php.net/manual/en/solrquery.settermsreturnraw.php |
|
2375 | - * @param bool $flag <p> |
|
2376 | - * <b>TRUE</b> or <b>FALSE</b> |
|
2377 | - * </p> |
|
2378 | - * @return SolrQuery <p> |
|
2379 | - * Returns the current SolrQuery object, if the return value is used. |
|
2380 | - * </p> |
|
2381 | - */ |
|
2382 | - public function setTermsReturnRaw($flag) {} |
|
2383 | - |
|
2384 | - /** |
|
2385 | - * (PECL solr >= 0.9.2)<br/> |
|
2386 | - * Specifies how to sort the returned terms |
|
2387 | - * @link https://php.net/manual/en/solrquery.settermssort.php |
|
2388 | - * @param int $sortType <p> |
|
2389 | - * If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first).<br/> |
|
2390 | - * If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order |
|
2391 | - * </p> |
|
2392 | - * @return SolrQuery <p> |
|
2393 | - * Returns the current SolrQuery object, if the return value is used. |
|
2394 | - * </p> |
|
2395 | - */ |
|
2396 | - public function setTermsSort($sortType) {} |
|
2397 | - |
|
2398 | - /** |
|
2399 | - * (PECL solr >= 0.9.2)<br/> |
|
2400 | - * Sets the term to stop at |
|
2401 | - * @link https://php.net/manual/en/solrquery.settermsupperbound.php |
|
2402 | - * @param string $upperBound <p> |
|
2403 | - * The term to stop at |
|
2404 | - * </p> |
|
2405 | - * @return SolrQuery <p> |
|
2406 | - * Returns the current SolrQuery object, if the return value is used. |
|
2407 | - * </p> |
|
2408 | - */ |
|
2409 | - public function setTermsUpperBound($upperBound) {} |
|
2410 | - |
|
2411 | - /** |
|
2412 | - * (PECL solr >= 0.9.2)<br/> |
|
2413 | - * The time allowed for search to finish |
|
2414 | - * @link https://php.net/manual/en/solrquery.settimeallowed.php |
|
2415 | - * @param int $timeAllowed <p> |
|
2416 | - * The time allowed for a search to finish. This value only applies to the search and not to requests in general. |
|
2417 | - * Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be |
|
2418 | - * returned, if there are any. |
|
2419 | - * </p> |
|
2420 | - * @return SolrQuery <p> |
|
2421 | - * Returns the current SolrQuery object, if the return value is used. |
|
2422 | - * </p> |
|
2423 | - */ |
|
2424 | - public function setTimeAllowed($timeAllowed) {} |
|
17 | + /** @var int Used to specify that the sorting should be in acending order */ |
|
18 | + public const ORDER_ASC = 0; |
|
19 | + |
|
20 | + /** @var int Used to specify that the sorting should be in descending order */ |
|
21 | + public const ORDER_DESC = 1; |
|
22 | + |
|
23 | + /** @var int Used to specify that the facet should sort by index */ |
|
24 | + public const FACET_SORT_INDEX = 0; |
|
25 | + |
|
26 | + /** @var int Used to specify that the facet should sort by count */ |
|
27 | + public const FACET_SORT_COUNT = 1; |
|
28 | + |
|
29 | + /** @var int Used in the TermsComponent */ |
|
30 | + public const TERMS_SORT_INDEX = 0; |
|
31 | + |
|
32 | + /** @var int Used in the TermsComponent */ |
|
33 | + public const TERMS_SORT_COUNT = 1; |
|
34 | + |
|
35 | + /** |
|
36 | + * (PECL solr >= 2.2.0)<br/> |
|
37 | + * Overrides main filter query, determines which documents to include in the main group. |
|
38 | + * @link https://php.net/manual/en/solrquery.addexpandfilterquery.php |
|
39 | + * @param string $fq |
|
40 | + * @return SolrQuery <p> |
|
41 | + * Returns a SolrQuery object. |
|
42 | + * </p> |
|
43 | + */ |
|
44 | + public function addExpandFilterQuery($fq) {} |
|
45 | + |
|
46 | + /** |
|
47 | + * (PECL solr >= 2.2.0)<br/> |
|
48 | + * Orders the documents within the expanded groups (expand.sort parameter). |
|
49 | + * @link https://php.net/manual/en/solrquery.addexpandsortfield.php |
|
50 | + * @param string $field <p> |
|
51 | + * Field name |
|
52 | + * </p> |
|
53 | + * @param string $order [optional] <p> |
|
54 | + * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants. |
|
55 | + * </p> |
|
56 | + * <p> |
|
57 | + * Default: SolrQuery::ORDER_DESC |
|
58 | + * </p> |
|
59 | + * @return SolrQuery <p> |
|
60 | + * Returns a SolrQuery object. |
|
61 | + * </p> |
|
62 | + */ |
|
63 | + public function addExpandSortField($field, $order) {} |
|
64 | + |
|
65 | + /** |
|
66 | + * (PECL solr >= 0.9.2)<br/> |
|
67 | + * Maps to facet.date |
|
68 | + * @link https://php.net/manual/en/solrquery.addfacetdatefield.php |
|
69 | + * @param string $dateField <p> |
|
70 | + * The name of the date field. |
|
71 | + * </p> |
|
72 | + * @return SolrQuery <p> |
|
73 | + * Returns a SolrQuery object. |
|
74 | + * </p> |
|
75 | + */ |
|
76 | + public function addFacetDateField($dateField) {} |
|
77 | + |
|
78 | + /** |
|
79 | + * (PECL solr >= 0.9.2)<br/> |
|
80 | + * Adds another facet.date.other parameter |
|
81 | + * @link https://php.net/manual/en/solrquery.addfacetdateother.php |
|
82 | + * @param string $value <p> |
|
83 | + * The value to use. |
|
84 | + * </p> |
|
85 | + * @param string $field_override <p> |
|
86 | + * The field name for the override. |
|
87 | + * </p> |
|
88 | + * @return SolrQuery <p> |
|
89 | + * Returns the current SolrQuery object, if the return value is used. |
|
90 | + * </p> |
|
91 | + */ |
|
92 | + public function addFacetDateOther($value, $field_override) {} |
|
93 | + |
|
94 | + /** |
|
95 | + * (PECL solr >= 0.9.2)<br/> |
|
96 | + * Adds another field to the facet |
|
97 | + * @link https://php.net/manual/en/solrquery.addfacetfield.php |
|
98 | + * @param string $field <p> |
|
99 | + * The name of the field |
|
100 | + * </p> |
|
101 | + * @return SolrQuery <p> |
|
102 | + * Returns the current SolrQuery object, if the return value is used. |
|
103 | + * </p> |
|
104 | + */ |
|
105 | + public function addFacetField($field) {} |
|
106 | + |
|
107 | + /** |
|
108 | + * (PECL solr >= 0.9.2)<br/> |
|
109 | + * Adds a facet query |
|
110 | + * @link https://php.net/manual/en/solrquery.addfacetquery.php |
|
111 | + * @param string $facetQuery <p> |
|
112 | + * The facet query |
|
113 | + * </p> |
|
114 | + * @return SolrQuery <p> |
|
115 | + * Returns the current SolrQuery object, if the return value is used. |
|
116 | + * </p> |
|
117 | + */ |
|
118 | + public function addFacetQuery($facetQuery) {} |
|
119 | + |
|
120 | + /** |
|
121 | + * (PECL solr >= 0.9.2)<br/> |
|
122 | + * Specifies which fields to return in the result |
|
123 | + * @link https://php.net/manual/en/solrquery.addfield.php |
|
124 | + * @param string $field <p> |
|
125 | + * The name of the field |
|
126 | + * </p> |
|
127 | + * @return SolrQuery <p> |
|
128 | + * Returns a SolrQuery object. |
|
129 | + * </p> |
|
130 | + */ |
|
131 | + public function addField($field) {} |
|
132 | + |
|
133 | + /** |
|
134 | + * (PECL solr >= 0.9.2)<br/> |
|
135 | + * Specifies a filter query |
|
136 | + * @link https://php.net/manual/en/solrquery.addfilterquery.php |
|
137 | + * @param string $fq <p> |
|
138 | + * The filter query |
|
139 | + * </p> |
|
140 | + * @return SolrQuery <p> |
|
141 | + * Returns a SolrQuery object. |
|
142 | + * </p> |
|
143 | + */ |
|
144 | + public function addFilterQuery($fq) {} |
|
145 | + |
|
146 | + /** |
|
147 | + * (PECL solr >= 2.2.0)<br/> |
|
148 | + * Add a field to be used to group results. |
|
149 | + * @link https://php.net/manual/en/solrquery.addgroupfield.php |
|
150 | + * @param string $value |
|
151 | + * @return SolrQuery <p> |
|
152 | + * Returns a SolrQuery object. |
|
153 | + * </p> |
|
154 | + */ |
|
155 | + public function addGroupField($value) {} |
|
156 | + |
|
157 | + /** |
|
158 | + * (PECL solr >= 2.2.0)<br/> |
|
159 | + * Allows grouping results based on the unique values of a function query (group.func parameter). |
|
160 | + * @link https://php.net/manual/en/solrquery.addgroupfunction.php |
|
161 | + * @param string $value |
|
162 | + * @return SolrQuery <p> |
|
163 | + * Returns a SolrQuery object. |
|
164 | + * </p> |
|
165 | + */ |
|
166 | + public function addGroupFunction($value) {} |
|
167 | + |
|
168 | + /** |
|
169 | + * (PECL solr >= 2.2.0)<br/> |
|
170 | + * Allows grouping of documents that match the given query. |
|
171 | + * @link https://php.net/manual/en/solrquery.addgroupquery.php |
|
172 | + * @param string $value |
|
173 | + * @return SolrQuery <p> |
|
174 | + * Returns a SolrQuery object. |
|
175 | + * </p> |
|
176 | + */ |
|
177 | + public function addGroupQuery($value) {} |
|
178 | + |
|
179 | + /** |
|
180 | + * (PECL solr >= 2.2.0)<br/> |
|
181 | + * Add a group sort field (group.sort parameter). |
|
182 | + * @link https://php.net/manual/en/solrquery.addgroupsortfield.php |
|
183 | + * @param string $field <p> |
|
184 | + * Field name |
|
185 | + * </p> |
|
186 | + * @param int $order <p> |
|
187 | + * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants |
|
188 | + * </p> |
|
189 | + * @return SolrQuery <p> |
|
190 | + * Returns a SolrQuery object. |
|
191 | + * </p> |
|
192 | + */ |
|
193 | + public function addGroupSortField($field, $order) {} |
|
194 | + |
|
195 | + /** |
|
196 | + * (PECL solr >= 0.9.2)<br/> |
|
197 | + * Maps to hl.fl |
|
198 | + * @link https://php.net/manual/en/solrquery.addhighlightfield.php |
|
199 | + * @param string $field <p> |
|
200 | + * Name of the field |
|
201 | + * </p> |
|
202 | + * @return SolrQuery <p> |
|
203 | + * Returns the current SolrQuery object, if the return value is used. |
|
204 | + * </p> |
|
205 | + */ |
|
206 | + public function addHighlightField($field) {} |
|
207 | + |
|
208 | + /** |
|
209 | + * (PECL solr >= 0.9.2)<br/> |
|
210 | + * Sets a field to use for similarity |
|
211 | + * @link https://php.net/manual/en/solrquery.addmltfield.php |
|
212 | + * @param string $field <p> |
|
213 | + * The name of the field |
|
214 | + * </p> |
|
215 | + * @return SolrQuery <p> |
|
216 | + * Returns the current SolrQuery object, if the return value is used. |
|
217 | + * </p> |
|
218 | + */ |
|
219 | + public function addMltField($field) {} |
|
220 | + |
|
221 | + /** |
|
222 | + * (PECL solr >= 0.9.2)<br/> |
|
223 | + * Maps to mlt.qf |
|
224 | + * @link https://php.net/manual/en/solrquery.addmltqueryfield.php |
|
225 | + * @param string $field <p> |
|
226 | + * The name of the field |
|
227 | + * </p> |
|
228 | + * @param float $boost <p> |
|
229 | + * Its boost value |
|
230 | + * </p> |
|
231 | + * @return SolrQuery <p> |
|
232 | + * Returns the current SolrQuery object, if the return value is used. |
|
233 | + * </p> |
|
234 | + */ |
|
235 | + public function addMltQueryField($field, $boost) {} |
|
236 | + |
|
237 | + /** |
|
238 | + * (PECL solr >= 0.9.2)<br/> |
|
239 | + * Used to control how the results should be sorted |
|
240 | + * @link https://php.net/manual/en/solrquery.addsortfield.php |
|
241 | + * @param string $field <p> |
|
242 | + * The name of the field |
|
243 | + * </p> |
|
244 | + * @param int $order <p> |
|
245 | + * The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC. |
|
246 | + * </p> |
|
247 | + * @return SolrQuery <p> |
|
248 | + * Returns a SolrQuery object. |
|
249 | + * </p> |
|
250 | + */ |
|
251 | + public function addSortField($field, $order = SolrQuery::ORDER_DESC) {} |
|
252 | + |
|
253 | + /** |
|
254 | + * (PECL solr >= 0.9.2)<br/> |
|
255 | + * Requests a return of sub results for values within the given facet |
|
256 | + * @link https://php.net/manual/en/solrquery.addstatsfacet.php |
|
257 | + * @param string $field <p> |
|
258 | + * The name of the field |
|
259 | + * </p> |
|
260 | + * @return SolrQuery <p> |
|
261 | + * Returns the current SolrQuery object, if the return value is used. |
|
262 | + * </p> |
|
263 | + */ |
|
264 | + public function addStatsFacet($field) {} |
|
265 | + |
|
266 | + /** |
|
267 | + * (PECL solr >= 0.9.2)<br/> |
|
268 | + * Maps to stats.field parameter |
|
269 | + * @link https://php.net/manual/en/solrquery.addstatsfield.php |
|
270 | + * @param string $field <p> |
|
271 | + * The name of the field |
|
272 | + * </p> |
|
273 | + * @return SolrQuery <p> |
|
274 | + * Returns the current SolrQuery object, if the return value is used. |
|
275 | + * </p> |
|
276 | + */ |
|
277 | + public function addStatsField($field) {} |
|
278 | + |
|
279 | + /** |
|
280 | + * (No version information available, might only be in Git)<br/> |
|
281 | + * Collapses the result set to a single document per group |
|
282 | + * @link https://php.net/manual/en/solrquery.collapse.php |
|
283 | + * @param SolrCollapseFunction $collapseFunction |
|
284 | + * @return SolrQuery <p> |
|
285 | + * Returns a SolrQuery object. |
|
286 | + * </p> |
|
287 | + */ |
|
288 | + public function collapse(SolrCollapseFunction $collapseFunction) {} |
|
289 | + |
|
290 | + /** |
|
291 | + * (PECL solr >= 0.9.2)<br/> |
|
292 | + * SolrQuery constructor. |
|
293 | + * @link https://php.net/manual/en/solrquery.construct.php |
|
294 | + * @param string $q <p> |
|
295 | + * Optional search query |
|
296 | + * </p> |
|
297 | + */ |
|
298 | + public function __construct($q = '') {} |
|
299 | + |
|
300 | + /** |
|
301 | + * (PECL solr >= 0.9.2)<br/> |
|
302 | + * Destructor |
|
303 | + * @link https://php.net/manual/en/solrquery.destruct.php |
|
304 | + */ |
|
305 | + public function __destruct() {} |
|
306 | + |
|
307 | + /** |
|
308 | + * (PECL solr >= 2.2.0)<br/> |
|
309 | + * Returns true if group expanding is enabled |
|
310 | + * @link https://php.net/manual/en/solrquery.getexpand.php |
|
311 | + * @return bool <p> |
|
312 | + * Returns <b>TRUE</b> if group expanding is enabled |
|
313 | + * </p> |
|
314 | + */ |
|
315 | + public function getExpand() {} |
|
316 | + |
|
317 | + /** |
|
318 | + * (PECL solr >= 2.2.0)<br/> |
|
319 | + * Returns the expand filter queries |
|
320 | + * @link https://php.net/manual/en/solrquery.getexpandfilterqueries.php |
|
321 | + * @return array <p> |
|
322 | + * Returns the expand filter queries |
|
323 | + * </p> |
|
324 | + */ |
|
325 | + public function getExpandFilterQueries() {} |
|
326 | + |
|
327 | + /** |
|
328 | + * (PECL solr >= 2.2.0)<br/> |
|
329 | + * Returns the expand query expand.q parameter |
|
330 | + * @link https://php.net/manual/en/solrquery.getexpandquery.php |
|
331 | + * @return array <p> |
|
332 | + * Returns the expand query expand.q parameter |
|
333 | + * </p> |
|
334 | + */ |
|
335 | + public function getExpandQuery() {} |
|
336 | + |
|
337 | + /** |
|
338 | + * (PECL solr >= 2.2.0)<br/> |
|
339 | + * Returns The number of rows to display in each group (expand.rows) |
|
340 | + * @link https://php.net/manual/en/solrquery.getexpandrows.php |
|
341 | + * @return int <p> |
|
342 | + * Returns The number of rows to display in each group (expand.rows) |
|
343 | + * </p> |
|
344 | + */ |
|
345 | + public function getExpandRows() {} |
|
346 | + |
|
347 | + /** |
|
348 | + * (PECL solr >= 2.2.0)<br/> |
|
349 | + * Returns an array of fields |
|
350 | + * @link https://php.net/manual/en/solrquery.getexpandsortfields.php |
|
351 | + * @return array <p> |
|
352 | + * Returns an array of fields |
|
353 | + * </p> |
|
354 | + */ |
|
355 | + public function getExpandSortFields() {} |
|
356 | + |
|
357 | + /** |
|
358 | + * (PECL solr >= 0.9.2)<br/> |
|
359 | + * Returns the value of the facet parameter |
|
360 | + * @link https://php.net/manual/en/solrquery.getfacet.php |
|
361 | + * @return bool|null <p> |
|
362 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
363 | + * </p> |
|
364 | + */ |
|
365 | + public function getFacet() {} |
|
366 | + |
|
367 | + /** |
|
368 | + * (PECL solr >= 0.9.2)<br/> |
|
369 | + * Returns the value for the facet.date.end parameter |
|
370 | + * @link https://php.net/manual/en/solrquery.getfacetdateend.php |
|
371 | + * @param string $field_override [optional] <p> |
|
372 | + * The name of the field |
|
373 | + * </p> |
|
374 | + * @return string|null <p> |
|
375 | + * Returns a string on success and <b>NULL</b> if not set |
|
376 | + * </p> |
|
377 | + */ |
|
378 | + public function getFacetDateEnd($field_override) {} |
|
379 | + |
|
380 | + /** |
|
381 | + * (PECL solr >= 0.9.2)<br/> |
|
382 | + * Returns all the facet.date fields |
|
383 | + * @link https://php.net/manual/en/solrquery.getfacetdatefields.php |
|
384 | + * @return array|null <p> |
|
385 | + * Returns all the facet.date fields as an array or <b>NULL</b> if none was set |
|
386 | + * </p> |
|
387 | + */ |
|
388 | + public function getFacetDateFields() {} |
|
389 | + |
|
390 | + /** |
|
391 | + * (PECL solr >= 0.9.2)<br/> |
|
392 | + * Returns the value of the facet.date.gap parameter |
|
393 | + * @link https://php.net/manual/en/solrquery.getfacetdategap.php |
|
394 | + * @param string $field_override [optional] <p> |
|
395 | + * The name of the field |
|
396 | + * </p> |
|
397 | + * @return string|null <p> |
|
398 | + * Returns a string on success and <b>NULL</b> if not set |
|
399 | + * </p> |
|
400 | + */ |
|
401 | + public function getFacetDateGap($field_override) {} |
|
402 | + |
|
403 | + /** |
|
404 | + * (PECL solr >= 0.9.2)<br/> |
|
405 | + * Returns the value of the facet.date.hardend parameter |
|
406 | + * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php |
|
407 | + * @param string $field_override [optional] <p> |
|
408 | + * The name of the field |
|
409 | + * </p> |
|
410 | + * @return string|null <p> |
|
411 | + * Returns a string on success and <b>NULL</b> if not set |
|
412 | + * </p> |
|
413 | + */ |
|
414 | + public function getFacetDateHardEnd($field_override) {} |
|
415 | + |
|
416 | + /** |
|
417 | + * (PECL solr >= 0.9.2)<br/> |
|
418 | + * Returns the value for the facet.date.other parameter |
|
419 | + * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php |
|
420 | + * @param string $field_override [optional] <p> |
|
421 | + * The name of the field |
|
422 | + * </p> |
|
423 | + * @return array|null <p> |
|
424 | + * Returns an array on success and <b>NULL</b> if not set |
|
425 | + * </p> |
|
426 | + */ |
|
427 | + public function getFacetDateOther($field_override) {} |
|
428 | + |
|
429 | + /** |
|
430 | + * (PECL solr >= 0.9.2)<br/> |
|
431 | + * Returns the lower bound for the first date range for all date faceting on this field |
|
432 | + * @link https://php.net/manual/en/solrquery.getfacetdatestart.php |
|
433 | + * @param string $field_override [optional] <p> |
|
434 | + * The name of the field |
|
435 | + * </p> |
|
436 | + * @return string|null <p> |
|
437 | + * Returns a string on success and <b>NULL</b> if not set |
|
438 | + * </p> |
|
439 | + */ |
|
440 | + public function getFacetDateStart($field_override) {} |
|
441 | + |
|
442 | + /** |
|
443 | + * (PECL solr >= 0.9.2)<br/> |
|
444 | + * Returns all the facet fields |
|
445 | + * @link https://php.net/manual/en/solrquery.getfacetfields.php |
|
446 | + * @return array|null <p> |
|
447 | + * Returns an array of all the fields and <b>NULL</b> if none was set |
|
448 | + * </p> |
|
449 | + */ |
|
450 | + public function getFacetFields() {} |
|
451 | + |
|
452 | + /** |
|
453 | + * (PECL solr >= 0.9.2)<br/> |
|
454 | + * Returns the maximum number of constraint counts that should be returned for the facet fields |
|
455 | + * @link https://php.net/manual/en/solrquery.getfacetlimit.php |
|
456 | + * @param string $field_override [optional] <p> |
|
457 | + * The name of the field |
|
458 | + * </p> |
|
459 | + * @return int|null <p> |
|
460 | + * Returns an integer on success and <b>NULL</b> if not set |
|
461 | + * </p> |
|
462 | + */ |
|
463 | + public function getFacetLimit($field_override) {} |
|
464 | + |
|
465 | + /** |
|
466 | + * (PECL solr >= 0.9.2)<br/> |
|
467 | + * Returns the value of the facet.method parameter |
|
468 | + * @link https://php.net/manual/en/solrquery.getfacetmethod.php |
|
469 | + * @param string $field_override [optional] <p> |
|
470 | + * The name of the field |
|
471 | + * </p> |
|
472 | + * @return string|null <p> |
|
473 | + * Returns a string on success and <b>NULL</b> if not set |
|
474 | + * </p> |
|
475 | + */ |
|
476 | + public function getFacetMethod($field_override) {} |
|
477 | + |
|
478 | + /** |
|
479 | + * (PECL solr >= 0.9.2)<br/> |
|
480 | + * Returns the minimum counts for facet fields should be included in the response |
|
481 | + * @link https://php.net/manual/en/solrquery.getfacetmincount.php |
|
482 | + * @param string $field_override [optional] <p> |
|
483 | + * The name of the field |
|
484 | + * </p> |
|
485 | + * @return int|null <p> |
|
486 | + * Returns an integer on success and <b>NULL</b> if not set |
|
487 | + * </p> |
|
488 | + */ |
|
489 | + public function getFacetMinCount($field_override) {} |
|
490 | + |
|
491 | + /** |
|
492 | + * (PECL solr >= 0.9.2)<br/> |
|
493 | + * Returns the current state of the facet.missing parameter |
|
494 | + * @link https://php.net/manual/en/solrquery.getfacetmissing.php |
|
495 | + * @param string $field_override [optional] <p> |
|
496 | + * The name of the field |
|
497 | + * </p> |
|
498 | + * @return string|null <p> |
|
499 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
500 | + * </p> |
|
501 | + */ |
|
502 | + public function getFacetMissing($field_override) {} |
|
503 | + |
|
504 | + /** |
|
505 | + * (PECL solr >= 0.9.2)<br/> |
|
506 | + * Returns an offset into the list of constraints to be used for pagination |
|
507 | + * @link https://php.net/manual/en/solrquery.getfacetoffset.php |
|
508 | + * @param string $field_override [optional] <p> |
|
509 | + * The name of the field |
|
510 | + * </p> |
|
511 | + * @return int|null <p> |
|
512 | + * Returns an integer on success and <b>NULL</b> if not set |
|
513 | + * </p> |
|
514 | + */ |
|
515 | + public function getFacetOffset($field_override) {} |
|
516 | + |
|
517 | + /** |
|
518 | + * (PECL solr >= 0.9.2)<br/> |
|
519 | + * Returns the facet prefix |
|
520 | + * @link https://php.net/manual/en/solrquery.getfacetprefix.php |
|
521 | + * @param string $field_override [optional] <p> |
|
522 | + * The name of the field |
|
523 | + * </p> |
|
524 | + * @return string|null <p> |
|
525 | + * Returns a string on success and <b>NULL</b> if not set |
|
526 | + * </p> |
|
527 | + */ |
|
528 | + public function getFacetPrefix($field_override) {} |
|
529 | + |
|
530 | + /** |
|
531 | + * (PECL solr >= 0.9.2)<br/> |
|
532 | + * Returns all the facet queries |
|
533 | + * @link https://php.net/manual/en/solrquery.getfacetqueries.php |
|
534 | + * @return string|null <p> |
|
535 | + * Returns an array on success and <b>NULL</b> if not set |
|
536 | + * </p> |
|
537 | + */ |
|
538 | + public function getFacetQueries() {} |
|
539 | + |
|
540 | + /** |
|
541 | + * (PECL solr >= 0.9.2)<br/> |
|
542 | + * Returns the facet sort type |
|
543 | + * @link https://php.net/manual/en/solrquery.getfacetsort.php |
|
544 | + * @param string $field_override [optional] <p> |
|
545 | + * The name of the field |
|
546 | + * </p> |
|
547 | + * @return int|null <p> |
|
548 | + * Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or <b>NULL</b> if not |
|
549 | + * set. |
|
550 | + * </p> |
|
551 | + */ |
|
552 | + public function getFacetSort($field_override) {} |
|
553 | + |
|
554 | + /** |
|
555 | + * (PECL solr >= 0.9.2)<br/> |
|
556 | + * Returns the list of fields that will be returned in the response |
|
557 | + * @link https://php.net/manual/en/solrquery.getfields.php |
|
558 | + * @return string|null <p> |
|
559 | + * Returns an array on success and <b>NULL</b> if not set |
|
560 | + * </p> |
|
561 | + */ |
|
562 | + public function getFields() {} |
|
563 | + |
|
564 | + /** |
|
565 | + * (PECL solr >= 0.9.2)<br/> |
|
566 | + * Returns an array of filter queries |
|
567 | + * @link https://php.net/manual/en/solrquery.getfilterqueries.php |
|
568 | + * @return string|null <p> |
|
569 | + * Returns an array on success and <b>NULL</b> if not set |
|
570 | + * </p> |
|
571 | + */ |
|
572 | + public function getFilterQueries() {} |
|
573 | + |
|
574 | + /** |
|
575 | + * (PECL solr >= 2.2.0)<br/> |
|
576 | + * Returns true if grouping is enabled |
|
577 | + * https://secure.php.net/manual/en/solrquery.getgroup.php |
|
578 | + * @return bool <p> |
|
579 | + * Returns true if grouping is enabled |
|
580 | + * </p> |
|
581 | + */ |
|
582 | + public function getGroup() {} |
|
583 | + |
|
584 | + /** |
|
585 | + * (PECL solr >= 2.2.0)<br/> |
|
586 | + * Returns group cache percent value |
|
587 | + * @link https://php.net/manual/en/solrquery.getgroupcachepercent.php |
|
588 | + * @return int <p> |
|
589 | + * Returns group cache percent value |
|
590 | + * </p> |
|
591 | + */ |
|
592 | + public function getGroupCachePercent() {} |
|
593 | + |
|
594 | + /** |
|
595 | + * (PECL solr >= 2.2.0)<br/> |
|
596 | + * Returns the group.facet parameter value |
|
597 | + * @link https://php.net/manual/en/solrquery.getgroupfacet.php |
|
598 | + * @return bool <p> |
|
599 | + * Returns the group.facet parameter value |
|
600 | + * </p> |
|
601 | + */ |
|
602 | + public function getGroupFacet() {} |
|
603 | + |
|
604 | + /** |
|
605 | + * (PECL solr >= 2.2.0)<br/> |
|
606 | + * Returns group fields (group.field parameter values) |
|
607 | + * @link https://php.net/manual/en/solrquery.getgroupfields.php |
|
608 | + * @return array <p> |
|
609 | + * Returns group fields (group.field parameter values) |
|
610 | + * </p> |
|
611 | + */ |
|
612 | + public function getGroupFields() {} |
|
613 | + |
|
614 | + /** |
|
615 | + * (PECL solr >= 2.2.0)<br/> |
|
616 | + * Returns the group.format value |
|
617 | + * @link https://php.net/manual/en/solrquery.getgroupformat.php |
|
618 | + * @return string <p> |
|
619 | + * Returns the group.format value |
|
620 | + * </p> |
|
621 | + */ |
|
622 | + public function getGroupFormat() {} |
|
623 | + |
|
624 | + /** |
|
625 | + * (PECL solr >= 2.2.0)<br/> |
|
626 | + * Returns group functions (group.func parameter values) |
|
627 | + * @link https://php.net/manual/en/solrquery.getgroupfunctions.php |
|
628 | + * @return array <p> |
|
629 | + * Returns group functions (group.func parameter values) |
|
630 | + * </p> |
|
631 | + */ |
|
632 | + public function getGroupFunctions() {} |
|
633 | + |
|
634 | + /** |
|
635 | + * (PECL solr >= 2.2.0)<br/> |
|
636 | + * Returns the group.limit value |
|
637 | + * @link https://php.net/manual/en/solrquery.getgrouplimit.php |
|
638 | + * @return int <p> |
|
639 | + * Returns the group.limit value |
|
640 | + * </p> |
|
641 | + */ |
|
642 | + public function getGroupLimit() {} |
|
643 | + |
|
644 | + /** |
|
645 | + * (PECL solr >= 2.2.0)<br/> |
|
646 | + * Returns the group.main value |
|
647 | + * @link https://php.net/manual/en/solrquery.getgroupmain.php |
|
648 | + * @return bool <p> |
|
649 | + * Returns the group.main value |
|
650 | + * </p> |
|
651 | + */ |
|
652 | + public function getGroupMain() {} |
|
653 | + |
|
654 | + /** |
|
655 | + * (PECL solr >= 2.2.0)<br/> |
|
656 | + * Returns the group.ngroups value |
|
657 | + * @link https://php.net/manual/en/solrquery.getgroupngroups.php |
|
658 | + * @return bool <p> |
|
659 | + * Returns the group.ngroups value |
|
660 | + * </p> |
|
661 | + */ |
|
662 | + public function getGroupNGroups() {} |
|
663 | + |
|
664 | + /** |
|
665 | + * (PECL solr >= 2.2.0)<br/> |
|
666 | + * Returns the group.offset value |
|
667 | + * @link https://php.net/manual/en/solrquery.getgroupoffset.php |
|
668 | + * @return bool <p> |
|
669 | + * Returns the group.offset value |
|
670 | + * </p> |
|
671 | + */ |
|
672 | + public function getGroupOffset() {} |
|
673 | + |
|
674 | + /** |
|
675 | + * (PECL solr >= 2.2.0)<br/> |
|
676 | + * Returns all the group.query parameter values |
|
677 | + * @link https://php.net/manual/en/solrquery.getgroupqueries.php |
|
678 | + * @return array <p> |
|
679 | + * Returns all the group.query parameter values |
|
680 | + * </p> |
|
681 | + */ |
|
682 | + public function getGroupQueries() {} |
|
683 | + |
|
684 | + /** |
|
685 | + * (PECL solr >= 2.2.0)<br/> |
|
686 | + * Returns the group.sort value |
|
687 | + * @link https://php.net/manual/en/solrquery.getgroupsortfields.php |
|
688 | + * @return array <p> |
|
689 | + * Returns all the group.sort parameter values |
|
690 | + * </p> |
|
691 | + */ |
|
692 | + public function getGroupSortFields() {} |
|
693 | + |
|
694 | + /** |
|
695 | + * (PECL solr >= 2.2.0)<br/> |
|
696 | + * Returns the group.truncate value |
|
697 | + * @link https://php.net/manual/en/solrquery.getgrouptruncate.php |
|
698 | + * @return bool <p> |
|
699 | + * Returns the group.truncate value |
|
700 | + * </p> |
|
701 | + */ |
|
702 | + public function getGroupTruncate() {} |
|
703 | + |
|
704 | + /** |
|
705 | + * (PECL solr >= 0.9.2)<br/> |
|
706 | + * Returns the state of the hl parameter |
|
707 | + * @link https://php.net/manual/en/solrquery.gethighlight.php |
|
708 | + * @return bool <p> |
|
709 | + * Returns the state of the hl parameter |
|
710 | + * </p> |
|
711 | + */ |
|
712 | + public function getHighlight() {} |
|
713 | + |
|
714 | + /** |
|
715 | + * (PECL solr >= 0.9.2)<br/> |
|
716 | + * Returns the highlight field to use as backup or default |
|
717 | + * @link https://php.net/manual/en/solrquery.gethighlightalternatefield.php |
|
718 | + * @param string $field_override [optional] <p> |
|
719 | + * The name of the field |
|
720 | + * </p> |
|
721 | + * @return string|null <p> |
|
722 | + * Returns a string on success and <b>NULL</b> if not set |
|
723 | + * </p> |
|
724 | + */ |
|
725 | + public function getHighlightAlternateField($field_override) {} |
|
726 | + |
|
727 | + /** |
|
728 | + * (PECL solr >= 0.9.2)<br/> |
|
729 | + * Returns all the fields that Solr should generate highlighted snippets for |
|
730 | + * @link https://php.net/manual/en/solrquery.gethighlightfields.php |
|
731 | + * @return array|null <p> |
|
732 | + * Returns an array on success and <b>NULL</b> if not set |
|
733 | + * </p> |
|
734 | + */ |
|
735 | + public function getHighlightFields() {} |
|
736 | + |
|
737 | + /** |
|
738 | + * (PECL solr >= 0.9.2)<br/> |
|
739 | + * Returns the formatter for the highlighted output |
|
740 | + * @link https://php.net/manual/en/solrquery.gethighlightformatter.php |
|
741 | + * @param string $field_override [optional] <p> |
|
742 | + * The name of the field |
|
743 | + * </p> |
|
744 | + * @return string|null <p> |
|
745 | + * Returns a string on success and <b>NULL</b> if not set |
|
746 | + * </p> |
|
747 | + */ |
|
748 | + public function getHighlightFormatter($field_override) {} |
|
749 | + |
|
750 | + /** |
|
751 | + * (PECL solr >= 0.9.2)<br/> |
|
752 | + * Returns the text snippet generator for highlighted text |
|
753 | + * @link https://php.net/manual/en/solrquery.gethighlightfragmenter.php |
|
754 | + * @param string $field_override [optional] <p> |
|
755 | + * The name of the field |
|
756 | + * </p> |
|
757 | + * @return string|null <p> |
|
758 | + * Returns a string on success and <b>NULL</b> if not set |
|
759 | + * </p> |
|
760 | + */ |
|
761 | + public function getHighlightFragmenter($field_override) {} |
|
762 | + |
|
763 | + /** |
|
764 | + * (PECL solr >= 0.9.2)<br/> |
|
765 | + * Returns the number of characters of fragments to consider for highlighting |
|
766 | + * @link https://php.net/manual/en/solrquery.gethighlightfragsize.php |
|
767 | + * @param string $field_override [optional] <p> |
|
768 | + * The name of the field |
|
769 | + * </p> |
|
770 | + * @return int|null <p> |
|
771 | + * Returns an integer on success and <b>NULL</b> if not set |
|
772 | + * </p> |
|
773 | + */ |
|
774 | + public function getHighlightFragsize($field_override) {} |
|
775 | + |
|
776 | + /** |
|
777 | + * (PECL solr >= 0.9.2)<br/> |
|
778 | + * Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries |
|
779 | + * @link https://php.net/manual/en/solrquery.gethighlighthighlightmultiterm.php |
|
780 | + * @return bool|null <p> |
|
781 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
782 | + * </p> |
|
783 | + */ |
|
784 | + public function getHighlightHighlightMultiTerm() {} |
|
785 | + |
|
786 | + /** |
|
787 | + * (PECL solr >= 0.9.2)<br/> |
|
788 | + * Returns the maximum number of characters of the field to return |
|
789 | + * @link https://php.net/manual/en/solrquery.gethighlightmaxalternatefieldlength.php |
|
790 | + * @param string $field_override [optional] <p> |
|
791 | + * The name of the field |
|
792 | + * </p> |
|
793 | + * @return int|null <p> |
|
794 | + * Returns an integer on success and <b>NULL</b> if not set |
|
795 | + * </p> |
|
796 | + */ |
|
797 | + public function getHighlightMaxAlternateFieldLength($field_override) {} |
|
798 | + |
|
799 | + /** |
|
800 | + * (PECL solr >= 0.9.2)<br/> |
|
801 | + * Returns the maximum number of characters into a document to look for suitable snippets |
|
802 | + * @link https://php.net/manual/en/solrquery.gethighlightmaxanalyzedchars.php |
|
803 | + * @return int|null <p> |
|
804 | + * Returns an integer on success and <b>NULL</b> if not set |
|
805 | + * </p> |
|
806 | + */ |
|
807 | + public function getHighlightMaxAnalyzedChars() {} |
|
808 | + |
|
809 | + /** |
|
810 | + * (PECL solr >= 0.9.2)<br/> |
|
811 | + * Returns whether or not the collapse contiguous fragments into a single fragment |
|
812 | + * @link https://php.net/manual/en/solrquery.gethighlightmergecontiguous.php |
|
813 | + * @param string $field_override [optional] <p> |
|
814 | + * The name of the field |
|
815 | + * </p> |
|
816 | + * @return bool|null <p> |
|
817 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
818 | + * </p> |
|
819 | + */ |
|
820 | + public function getHighlightMergeContiguous($field_override) {} |
|
821 | + |
|
822 | + /** |
|
823 | + * (PECL solr >= 0.9.2)<br/> |
|
824 | + * Returns the maximum number of characters from a field when using the regex fragmenter |
|
825 | + * @link https://php.net/manual/en/solrquery.gethighlightregexmaxanalyzedchars.php |
|
826 | + * @return int|null <p> |
|
827 | + * Returns an integer on success and <b>NULL</b> if not set |
|
828 | + * </p> |
|
829 | + */ |
|
830 | + public function getHighlightRegexMaxAnalyzedChars() {} |
|
831 | + |
|
832 | + /** |
|
833 | + * (PECL solr >= 0.9.2)<br/> |
|
834 | + * Returns the regular expression for fragmenting |
|
835 | + * @link https://php.net/manual/en/solrquery.gethighlightregexpattern.php |
|
836 | + * @return string <p> |
|
837 | + * Returns a string on success and <b>NULL</b> if not set |
|
838 | + * </p> |
|
839 | + */ |
|
840 | + public function getHighlightRegexPattern() {} |
|
841 | + |
|
842 | + /** |
|
843 | + * (PECL solr >= 0.9.2)<br/> |
|
844 | + * Returns the deviation factor from the ideal fragment size |
|
845 | + * @link https://php.net/manual/en/solrquery.gethighlightregexslop.php |
|
846 | + * @return float|null <p> |
|
847 | + * Returns a double on success and <b>NULL</b> if not set. |
|
848 | + * </p> |
|
849 | + */ |
|
850 | + public function getHighlightRegexSlop() {} |
|
851 | + |
|
852 | + /** |
|
853 | + * (PECL solr >= 0.9.2)<br/> |
|
854 | + * Returns if a field will only be highlighted if the query matched in this particular field |
|
855 | + * @link https://php.net/manual/en/solrquery.gethighlightrequirefieldmatch.php |
|
856 | + * @return bool|null <p> |
|
857 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
858 | + * </p> |
|
859 | + */ |
|
860 | + public function getHighlightRequireFieldMatch() {} |
|
861 | + |
|
862 | + /** |
|
863 | + * (PECL solr >= 0.9.2)<br/> |
|
864 | + * Returns the text which appears after a highlighted term |
|
865 | + * @link https://php.net/manual/en/solrquery.gethighlightsimplepost.php |
|
866 | + * @param string $field_override [optional] <p> |
|
867 | + * The name of the field |
|
868 | + * </p> |
|
869 | + * @return string|null <p> |
|
870 | + * Returns a string on success and <b>NULL</b> if not set |
|
871 | + * </p> |
|
872 | + */ |
|
873 | + public function getHighlightSimplePost($field_override) {} |
|
874 | + |
|
875 | + /** |
|
876 | + * (PECL solr >= 0.9.2)<br/> |
|
877 | + * Returns the text which appears before a highlighted term |
|
878 | + * @link https://php.net/manual/en/solrquery.gethighlightsimplepre.php |
|
879 | + * @param string $field_override [optional] <p> |
|
880 | + * The name of the field |
|
881 | + * </p> |
|
882 | + * @return string|null <p> |
|
883 | + * Returns a string on success and <b>NULL</b> if not set |
|
884 | + * </p> |
|
885 | + */ |
|
886 | + public function getHighlightSimplePre($field_override) {} |
|
887 | + |
|
888 | + /** |
|
889 | + * (PECL solr >= 0.9.2)<br/> |
|
890 | + * Returns the maximum number of highlighted snippets to generate per field |
|
891 | + * @link https://php.net/manual/en/solrquery.gethighlightsnippets.php |
|
892 | + * @param string $field_override [optional] <p> |
|
893 | + * The name of the field |
|
894 | + * </p> |
|
895 | + * @return int|null <p> |
|
896 | + * Returns an integer on success and <b>NULL</b> if not set |
|
897 | + * </p> |
|
898 | + */ |
|
899 | + public function getHighlightSnippets($field_override) {} |
|
900 | + |
|
901 | + /** |
|
902 | + * (PECL solr >= 0.9.2)<br/> |
|
903 | + * Returns the state of the hl.usePhraseHighlighter parameter |
|
904 | + * @link https://php.net/manual/en/solrquery.gethighlightusephrasehighlighter.php |
|
905 | + * @return bool|null <p> |
|
906 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
907 | + * </p> |
|
908 | + */ |
|
909 | + public function getHighlightUsePhraseHighlighter() {} |
|
910 | + |
|
911 | + /** |
|
912 | + * (PECL solr >= 0.9.2)<br/> |
|
913 | + * Returns whether or not MoreLikeThis results should be enabled |
|
914 | + * @link https://php.net/manual/en/solrquery.getmlt.php |
|
915 | + * @return bool|null <p> |
|
916 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
917 | + * </p> |
|
918 | + */ |
|
919 | + public function getMlt() {} |
|
920 | + |
|
921 | + /** |
|
922 | + * (PECL solr >= 0.9.2)<br/> |
|
923 | + * Returns whether or not the query will be boosted by the interesting term relevance |
|
924 | + * @link https://php.net/manual/en/solrquery.getmltboost.php |
|
925 | + * @return bool|null <p> |
|
926 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
927 | + * </p> |
|
928 | + */ |
|
929 | + public function getMltBoost() {} |
|
930 | + |
|
931 | + /** |
|
932 | + * (PECL solr >= 0.9.2)<br/> |
|
933 | + * Returns the number of similar documents to return for each result |
|
934 | + * @link https://php.net/manual/en/solrquery.getmltcount.php |
|
935 | + * @return int|null <p> |
|
936 | + * Returns an integer on success and <b>NULL</b> if not set |
|
937 | + * </p> |
|
938 | + */ |
|
939 | + public function getMltCount() {} |
|
940 | + |
|
941 | + /** |
|
942 | + * (PECL solr >= 0.9.2)<br/> |
|
943 | + * Returns all the fields to use for similarity |
|
944 | + * @link https://php.net/manual/en/solrquery.getmltfields.php |
|
945 | + * @return array <p> |
|
946 | + * Returns an array on success and <b>NULL</b> if not set |
|
947 | + * </p> |
|
948 | + */ |
|
949 | + public function getMltFields() {} |
|
950 | + |
|
951 | + /** |
|
952 | + * (PECL solr >= 0.9.2)<br/> |
|
953 | + * Returns the maximum number of query terms that will be included in any generated query |
|
954 | + * @link https://php.net/manual/en/solrquery.getmltmaxnumqueryterms.php |
|
955 | + * @return int|null <p> |
|
956 | + * Returns an integer on success and <b>NULL</b> if not set |
|
957 | + * </p> |
|
958 | + */ |
|
959 | + public function getMltMaxNumQueryTerms() {} |
|
960 | + |
|
961 | + /** |
|
962 | + * (PECL solr >= 0.9.2)<br/> |
|
963 | + * Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support |
|
964 | + * @link https://php.net/manual/en/solrquery.getmltmaxnumtokens.php |
|
965 | + * @return int <p> |
|
966 | + * Returns an integer on success and <b>NULL</b> if not set |
|
967 | + * </p> |
|
968 | + */ |
|
969 | + public function getMltMaxNumTokens() {} |
|
970 | + |
|
971 | + /** |
|
972 | + * (PECL solr >= 0.9.2)<br/> |
|
973 | + * Returns the maximum word length above which words will be ignored |
|
974 | + * @link https://php.net/manual/en/solrquery.getmltmaxwordlength.php |
|
975 | + * @return int|null <p> |
|
976 | + * Returns an integer on success and <b>NULL</b> if not set |
|
977 | + * </p> |
|
978 | + */ |
|
979 | + public function getMltMaxWordLength() {} |
|
980 | + |
|
981 | + /** |
|
982 | + * (PECL solr >= 0.9.2)<br/> |
|
983 | + * Returns the threshold frequency at which words will be ignored which do not occur in at least this many docs |
|
984 | + * @link https://php.net/manual/en/solrquery.getmltmindocfrequency.php |
|
985 | + * @return int|null <p> |
|
986 | + * Returns an integer on success and <b>NULL</b> if not set |
|
987 | + * </p> |
|
988 | + */ |
|
989 | + public function getMltMinDocFrequency() {} |
|
990 | + |
|
991 | + /** |
|
992 | + * (PECL solr >= 0.9.2)<br/> |
|
993 | + * Returns the frequency below which terms will be ignored in the source document |
|
994 | + * @link https://php.net/manual/en/solrquery.getmltmintermfrequency.php |
|
995 | + * @return int|null <p> |
|
996 | + * Returns an integer on success and <b>NULL</b> if not set |
|
997 | + * </p> |
|
998 | + */ |
|
999 | + public function getMltMinTermFrequency() {} |
|
1000 | + |
|
1001 | + /** |
|
1002 | + * (PECL solr >= 0.9.2)<br/> |
|
1003 | + * Returns the minimum word length below which words will be ignored |
|
1004 | + * @link https://php.net/manual/en/solrquery.getmltminwordlength.php |
|
1005 | + * @return int <p> |
|
1006 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1007 | + * </p> |
|
1008 | + */ |
|
1009 | + public function getMltMinWordLength() {} |
|
1010 | + |
|
1011 | + /** |
|
1012 | + * (PECL solr >= 0.9.2)<br/> |
|
1013 | + * Returns the query fields and their boosts |
|
1014 | + * @link https://php.net/manual/en/solrquery.getmltqueryfields.php |
|
1015 | + * @return array|null <p> |
|
1016 | + * Returns an array on success and <b>NULL</b> if not set |
|
1017 | + * </p> |
|
1018 | + */ |
|
1019 | + public function getMltQueryFields() {} |
|
1020 | + |
|
1021 | + /** |
|
1022 | + * (PECL solr >= 0.9.2)<br/> |
|
1023 | + * Returns the main query |
|
1024 | + * @link https://php.net/manual/en/solrquery.getquery.php |
|
1025 | + * @return string <p> |
|
1026 | + * Returns a string on success and <b>NULL</b> if not set |
|
1027 | + * </p> |
|
1028 | + */ |
|
1029 | + public function getQuery() {} |
|
1030 | + |
|
1031 | + /** |
|
1032 | + * (PECL solr >= 0.9.2)<br/> |
|
1033 | + * Returns the maximum number of documents |
|
1034 | + * @link https://php.net/manual/en/solrquery.getrows.php |
|
1035 | + * @return int|null <p> |
|
1036 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1037 | + * </p> |
|
1038 | + */ |
|
1039 | + public function getRows() {} |
|
1040 | + |
|
1041 | + /** |
|
1042 | + * (PECL solr >= 0.9.2)<br/> |
|
1043 | + * Returns all the sort fields |
|
1044 | + * @link https://php.net/manual/en/solrquery.getsortfields.php |
|
1045 | + * @return array <p> |
|
1046 | + * Returns an array on success and <b>NULL</b> if none of the parameters was set. |
|
1047 | + * </p> |
|
1048 | + */ |
|
1049 | + public function getSortFields() {} |
|
1050 | + |
|
1051 | + /** |
|
1052 | + * (PECL solr >= 0.9.2)<br/> |
|
1053 | + * Returns the offset in the complete result set |
|
1054 | + * @link https://php.net/manual/en/solrquery.getstart.php |
|
1055 | + * @return int|null <p> |
|
1056 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1057 | + * </p> |
|
1058 | + */ |
|
1059 | + public function getStart() {} |
|
1060 | + |
|
1061 | + /** |
|
1062 | + * (PECL solr >= 0.9.2)<br/> |
|
1063 | + * Returns whether or not stats is enabled |
|
1064 | + * @link https://php.net/manual/en/solrquery.getstats.php |
|
1065 | + * @return bool|null <p> |
|
1066 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
1067 | + * </p> |
|
1068 | + */ |
|
1069 | + public function getStats() {} |
|
1070 | + |
|
1071 | + /** |
|
1072 | + * (PECL solr >= 0.9.2)<br/> |
|
1073 | + * Returns all the stats facets that were set |
|
1074 | + * @link https://php.net/manual/en/solrquery.getstatsfacets.php |
|
1075 | + * @return array|null <p> |
|
1076 | + * Returns an array on success and <b>NULL</b> if not set |
|
1077 | + * </p> |
|
1078 | + */ |
|
1079 | + public function getStatsFacets() {} |
|
1080 | + |
|
1081 | + /** |
|
1082 | + * (PECL solr >= 0.9.2)<br/> |
|
1083 | + * Returns all the statistics fields |
|
1084 | + * @link https://php.net/manual/en/solrquery.getstatsfields.php |
|
1085 | + * @return array|null <p> |
|
1086 | + * Returns an array on success and <b>NULL</b> if not set |
|
1087 | + * </p> |
|
1088 | + */ |
|
1089 | + public function getStatsFields() {} |
|
1090 | + |
|
1091 | + /** |
|
1092 | + * (PECL solr >= 0.9.2)<br/> |
|
1093 | + * Returns whether or not the TermsComponent is enabled |
|
1094 | + * @link https://php.net/manual/en/solrquery.getterms.php |
|
1095 | + * @return bool|null <p> |
|
1096 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
1097 | + * </p> |
|
1098 | + */ |
|
1099 | + public function getTerms() {} |
|
1100 | + |
|
1101 | + /** |
|
1102 | + * (PECL solr >= 0.9.2)<br/> |
|
1103 | + * Returns the field from which the terms are retrieved |
|
1104 | + * @link https://php.net/manual/en/solrquery.gettermsfield.php |
|
1105 | + * @return string|null <p> |
|
1106 | + * Returns a string on success and <b>NULL</b> if not set |
|
1107 | + * </p> |
|
1108 | + */ |
|
1109 | + public function getTermsField() {} |
|
1110 | + |
|
1111 | + /** |
|
1112 | + * (PECL solr >= 0.9.2)<br/> |
|
1113 | + * Returns whether or not to include the lower bound in the result set |
|
1114 | + * @link https://php.net/manual/en/solrquery.gettermsincludelowerbound.php |
|
1115 | + * @return bool|null <p> |
|
1116 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
1117 | + * </p> |
|
1118 | + */ |
|
1119 | + public function getTermsIncludeLowerBound() {} |
|
1120 | + |
|
1121 | + /** |
|
1122 | + * (PECL solr >= 0.9.2)<br/> |
|
1123 | + * Returns whether or not to include the upper bound term in the result set |
|
1124 | + * @link https://php.net/manual/en/solrquery.gettermsincludeupperbound.php |
|
1125 | + * @return bool|null <p> |
|
1126 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
1127 | + * </p> |
|
1128 | + */ |
|
1129 | + public function getTermsIncludeUpperBound() {} |
|
1130 | + |
|
1131 | + /** |
|
1132 | + * (PECL solr >= 0.9.2)<br/> |
|
1133 | + * Returns the maximum number of terms Solr should return |
|
1134 | + * @link https://php.net/manual/en/solrquery.gettermslimit.php |
|
1135 | + * @return int|null <p> |
|
1136 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1137 | + * </p> |
|
1138 | + */ |
|
1139 | + public function getTermsLimit() {} |
|
1140 | + |
|
1141 | + /** |
|
1142 | + * (PECL solr >= 0.9.2)<br/> |
|
1143 | + * Returns the term to start at |
|
1144 | + * @link https://php.net/manual/en/solrquery.gettermslowerbound.php |
|
1145 | + * @return string|null <p> |
|
1146 | + * Returns a string on success and <b>NULL</b> if not set |
|
1147 | + * </p> |
|
1148 | + */ |
|
1149 | + public function getTermsLowerBound() {} |
|
1150 | + |
|
1151 | + /** |
|
1152 | + * (PECL solr >= 0.9.2)<br/> |
|
1153 | + * Returns the maximum document frequency |
|
1154 | + * @link https://php.net/manual/en/solrquery.gettermsmaxcount.php |
|
1155 | + * @return int|null <p> |
|
1156 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1157 | + * </p> |
|
1158 | + */ |
|
1159 | + public function getTermsMaxCount() {} |
|
1160 | + |
|
1161 | + /** |
|
1162 | + * (PECL solr >= 0.9.2)<br/> |
|
1163 | + * Returns the minimum document frequency to return in order to be included |
|
1164 | + * @link https://php.net/manual/en/solrquery.gettermsmincount.php |
|
1165 | + * @return int|null <p> |
|
1166 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1167 | + * </p> |
|
1168 | + */ |
|
1169 | + public function getTermsMinCount() {} |
|
1170 | + |
|
1171 | + /** |
|
1172 | + * (PECL solr >= 0.9.2)<br/> |
|
1173 | + * Returns the term prefix |
|
1174 | + * @link https://php.net/manual/en/solrquery.gettermsprefix.php |
|
1175 | + * @return string|null <p> |
|
1176 | + * Returns a string on success and <b>NULL</b> if not set |
|
1177 | + * </p> |
|
1178 | + */ |
|
1179 | + public function getTermsPrefix() {} |
|
1180 | + |
|
1181 | + /** |
|
1182 | + * (PECL solr >= 0.9.2)<br/> |
|
1183 | + * Whether or not to return raw characters |
|
1184 | + * @link https://php.net/manual/en/solrquery.gettermsreturnraw.php |
|
1185 | + * @return bool|null <p> |
|
1186 | + * Returns a boolean on success and <b>NULL</b> if not set |
|
1187 | + * </p> |
|
1188 | + */ |
|
1189 | + public function getTermsReturnRaw() {} |
|
1190 | + |
|
1191 | + /** |
|
1192 | + * (PECL solr >= 0.9.2)<br/> |
|
1193 | + * Returns an integer indicating how terms are sorted |
|
1194 | + * @link https://php.net/manual/en/solrquery.gettermssort.php |
|
1195 | + * @return int|null <p> |
|
1196 | + * Returns an integer on success and <b>NULL</b> if not set<br/> |
|
1197 | + * SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.<br/> |
|
1198 | + * SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first) |
|
1199 | + * </p> |
|
1200 | + */ |
|
1201 | + public function getTermsSort() {} |
|
1202 | + |
|
1203 | + /** |
|
1204 | + * (PECL solr >= 0.9.2)<br/> |
|
1205 | + * Returns the term to stop at |
|
1206 | + * @link https://php.net/manual/en/solrquery.gettermsupperbound.php |
|
1207 | + * @return string|null <p> |
|
1208 | + * Returns a string on success and <b>NULL</b> if not set |
|
1209 | + * </p> |
|
1210 | + */ |
|
1211 | + public function getTermsUpperBound() {} |
|
1212 | + |
|
1213 | + /** |
|
1214 | + * (PECL solr >= 0.9.2)<br/> |
|
1215 | + * Returns the time in milliseconds allowed for the query to finish |
|
1216 | + * @link https://php.net/manual/en/solrquery.gettimeallowed.php |
|
1217 | + * @return int|null <p> |
|
1218 | + * Returns an integer on success and <b>NULL</b> if not set |
|
1219 | + * </p> |
|
1220 | + */ |
|
1221 | + public function getTimeAllowed() {} |
|
1222 | + |
|
1223 | + /** |
|
1224 | + * (PECL solr >= 2.2.0)<br/> |
|
1225 | + * Removes an expand filter query |
|
1226 | + * @link https://php.net/manual/en/solrquery.removeexpandfilterquery.php |
|
1227 | + * @param string $fq |
|
1228 | + * @return SolrQuery <p> |
|
1229 | + * Returns the current SolrQuery object, if the return value is used. |
|
1230 | + * </p> |
|
1231 | + */ |
|
1232 | + public function removeExpandFilterQuery($fq) {} |
|
1233 | + |
|
1234 | + /** |
|
1235 | + * (PECL solr >= 2.2.0)<br/> |
|
1236 | + * Removes an expand sort field from the expand.sort parameter. |
|
1237 | + * @link https://php.net/manual/en/solrquery.removeexpandsortfield.php |
|
1238 | + * @param string $field <p> |
|
1239 | + * Field name |
|
1240 | + * </p> |
|
1241 | + * @return SolrQuery <p> |
|
1242 | + * Returns the current SolrQuery object, if the return value is used. |
|
1243 | + * </p> |
|
1244 | + */ |
|
1245 | + public function removeExpandSortField($field) {} |
|
1246 | + |
|
1247 | + /** |
|
1248 | + * (PECL solr >= 0.9.2)<br/> |
|
1249 | + * Removes one of the facet date fields |
|
1250 | + * @link https://php.net/manual/en/solrquery.removefacetdatefield.php |
|
1251 | + * @param string $field <p> |
|
1252 | + * The name of the date field to remove |
|
1253 | + * </p> |
|
1254 | + * @return SolrQuery <p> |
|
1255 | + * Returns the current SolrQuery object, if the return value is used. |
|
1256 | + * </p> |
|
1257 | + */ |
|
1258 | + public function removeFacetDateField($field) {} |
|
1259 | + |
|
1260 | + /** |
|
1261 | + * (PECL solr >= 0.9.2)<br/> |
|
1262 | + * Removes one of the facet.date.other parameters |
|
1263 | + * @link https://php.net/manual/en/solrquery.removefacetdateother.php |
|
1264 | + * @param string $value <p> |
|
1265 | + * The value |
|
1266 | + * </p> |
|
1267 | + * @param string $field_override [optional] <p> |
|
1268 | + * The name of the field. |
|
1269 | + * </p> |
|
1270 | + * @return SolrQuery <p> |
|
1271 | + * Returns the current SolrQuery object, if the return value is used. |
|
1272 | + * </p> |
|
1273 | + */ |
|
1274 | + public function removeFacetDateOther($value, $field_override) {} |
|
1275 | + |
|
1276 | + /** |
|
1277 | + * (PECL solr >= 0.9.2)<br/> |
|
1278 | + * Removes one of the facet.date parameters |
|
1279 | + * @link https://php.net/manual/en/solrquery.removefacetfield.php |
|
1280 | + * @param string $field <p> |
|
1281 | + * The name of the field |
|
1282 | + * </p> |
|
1283 | + * @return SolrQuery <p> |
|
1284 | + * Returns the current SolrQuery object, if the return value is used. |
|
1285 | + * </p> |
|
1286 | + */ |
|
1287 | + public function removeFacetField($field) {} |
|
1288 | + |
|
1289 | + /** |
|
1290 | + * (PECL solr >= 0.9.2)<br/> |
|
1291 | + * Removes one of the facet.query parameters |
|
1292 | + * @link https://php.net/manual/en/solrquery.removefacetquery.php |
|
1293 | + * @param string $value <p> |
|
1294 | + * The value |
|
1295 | + * </p> |
|
1296 | + * @return SolrQuery <p> |
|
1297 | + * Returns the current SolrQuery object, if the return value is used. |
|
1298 | + * </p> |
|
1299 | + */ |
|
1300 | + public function removeFacetQuery($value) {} |
|
1301 | + |
|
1302 | + /** |
|
1303 | + * (PECL solr >= 0.9.2)<br/> |
|
1304 | + * Removes a field from the list of fields |
|
1305 | + * @link https://php.net/manual/en/solrquery.removefield.php |
|
1306 | + * @param string $field <p> |
|
1307 | + * The name of the field |
|
1308 | + * </p> |
|
1309 | + * @return SolrQuery <p> |
|
1310 | + * Returns the current SolrQuery object, if the return value is used. |
|
1311 | + * </p> |
|
1312 | + */ |
|
1313 | + public function removeField($field) {} |
|
1314 | + |
|
1315 | + /** |
|
1316 | + * (PECL solr >= 0.9.2)<br/> |
|
1317 | + * Removes a filter query |
|
1318 | + * @link https://php.net/manual/en/solrquery.removefilterquery.php |
|
1319 | + * @param string $fq |
|
1320 | + * @return SolrQuery <p> |
|
1321 | + * Returns the current SolrQuery object, if the return value is used. |
|
1322 | + * </p> |
|
1323 | + */ |
|
1324 | + public function removeFilterQuery($fq) {} |
|
1325 | + |
|
1326 | + /** |
|
1327 | + * (PECL solr >= 0.9.2)<br/> |
|
1328 | + * Removes one of the fields used for highlighting |
|
1329 | + * @link https://php.net/manual/en/solrquery.removehighlightfield.php |
|
1330 | + * @param string $field <p> |
|
1331 | + * The name of the field |
|
1332 | + * </p> |
|
1333 | + * @return SolrQuery <p> |
|
1334 | + * Returns the current SolrQuery object, if the return value is used. |
|
1335 | + * </p> |
|
1336 | + */ |
|
1337 | + public function removeHighlightField($field) {} |
|
1338 | + |
|
1339 | + /** |
|
1340 | + * (PECL solr >= 0.9.2)<br/> |
|
1341 | + * Removes one of the moreLikeThis fields |
|
1342 | + * @link https://php.net/manual/en/solrquery.removemltfield.php |
|
1343 | + * @param string $field <p> |
|
1344 | + * The name of the field |
|
1345 | + * </p> |
|
1346 | + * @return SolrQuery <p> |
|
1347 | + * Returns the current SolrQuery object, if the return value is used. |
|
1348 | + * </p> |
|
1349 | + */ |
|
1350 | + public function removeMltField($field) {} |
|
1351 | + |
|
1352 | + /** |
|
1353 | + * (PECL solr >= 0.9.2)<br/> |
|
1354 | + * Removes one of the moreLikeThis query fields |
|
1355 | + * @link https://php.net/manual/en/solrquery.removemltqueryfield.php |
|
1356 | + * @param string $queryField <p> |
|
1357 | + * The query field |
|
1358 | + * </p> |
|
1359 | + * @return SolrQuery <p> |
|
1360 | + * Returns the current SolrQuery object, if the return value is used. |
|
1361 | + * </p> |
|
1362 | + */ |
|
1363 | + public function removeMltQueryField($queryField) {} |
|
1364 | + |
|
1365 | + /** |
|
1366 | + * (PECL solr >= 0.9.2)<br/> |
|
1367 | + * Removes one of the sort fields |
|
1368 | + * @link https://php.net/manual/en/solrquery.removesortfield.php |
|
1369 | + * @param string $field <p> |
|
1370 | + * The name of the field |
|
1371 | + * </p> |
|
1372 | + * @return SolrQuery <p> |
|
1373 | + * Returns the current SolrQuery object, if the return value is used. |
|
1374 | + * </p> |
|
1375 | + */ |
|
1376 | + public function removeSortField($field) {} |
|
1377 | + |
|
1378 | + /** |
|
1379 | + * (PECL solr >= 0.9.2)<br/> |
|
1380 | + * Removes one of the stats.facet parameters |
|
1381 | + * @link https://php.net/manual/en/solrquery.removestatsfacet.php |
|
1382 | + * @param string $value <p> |
|
1383 | + * The value |
|
1384 | + * </p> |
|
1385 | + * @return SolrQuery <p> |
|
1386 | + * Returns the current SolrQuery object, if the return value is used. |
|
1387 | + * </p> |
|
1388 | + */ |
|
1389 | + public function removeStatsFacet($value) {} |
|
1390 | + |
|
1391 | + /** |
|
1392 | + * (PECL solr >= 0.9.2)<br/> |
|
1393 | + * Removes one of the stats.field parameters |
|
1394 | + * @link https://php.net/manual/en/solrquery.removestatsfield.php |
|
1395 | + * @param string $field <p> |
|
1396 | + * The name of the field |
|
1397 | + * </p> |
|
1398 | + * @return SolrQuery <p> |
|
1399 | + * Returns the current SolrQuery object, if the return value is used. |
|
1400 | + * </p> |
|
1401 | + */ |
|
1402 | + public function removeStatsField($field) {} |
|
1403 | + |
|
1404 | + /** |
|
1405 | + * (PECL solr >= 0.9.2)<br/> |
|
1406 | + * Toggles the echoHandler parameter |
|
1407 | + * @link https://php.net/manual/en/solrquery.setechohandler.php |
|
1408 | + * @param bool $flag <p> |
|
1409 | + * <b>TRUE</b> or <b>FALSE</b> |
|
1410 | + * </p> |
|
1411 | + * @return SolrQuery <p> |
|
1412 | + * Returns the current SolrQuery object, if the return value is used. |
|
1413 | + * </p> |
|
1414 | + */ |
|
1415 | + public function setEchoHandler($flag) {} |
|
1416 | + |
|
1417 | + /** |
|
1418 | + * (PECL solr >= 0.9.2)<br/> |
|
1419 | + * Determines what kind of parameters to include in the response |
|
1420 | + * @link https://php.net/manual/en/solrquery.setechoparams.php |
|
1421 | + * @param string $type <p> |
|
1422 | + * The type of parameters to include: |
|
1423 | + * </p> |
|
1424 | + * <ul> |
|
1425 | + * <li><b>none</b>: don't include any request parameters for debugging</li> |
|
1426 | + * <li><b>explicit</b>: include the parameters explicitly specified by the client in the request</li> |
|
1427 | + * <li><b>all</b>: include all parameters involved in this request, either specified explicitly by the client, or |
|
1428 | + * implicit because of the request handler configuration.</li> |
|
1429 | + * </ul> |
|
1430 | + * @return SolrQuery <p> |
|
1431 | + * Returns the current SolrQuery object, if the return value is used. |
|
1432 | + * </p> |
|
1433 | + */ |
|
1434 | + public function setEchoParams($type) {} |
|
1435 | + |
|
1436 | + /** |
|
1437 | + * (PECL solr >= 2.2.0)<br/> |
|
1438 | + * Enables/Disables the Expand Component |
|
1439 | + * @link https://php.net/manual/en/solrquery.setexpand.php |
|
1440 | + * @param bool $value <p> |
|
1441 | + * Bool flag |
|
1442 | + * </b> |
|
1443 | + * @return SolrQuery <p> |
|
1444 | + * Returns the current SolrQuery object, if the return value is used. |
|
1445 | + * </p> |
|
1446 | + */ |
|
1447 | + public function setExpand($value) {} |
|
1448 | + |
|
1449 | + /** |
|
1450 | + * (PECL solr >= 2.2.0)<br/> |
|
1451 | + * Sets the expand.q parameter |
|
1452 | + * @link https://php.net/manual/en/solrquery.setexpandquery.php |
|
1453 | + * @param string $q |
|
1454 | + * @return SolrQuery <p> |
|
1455 | + * Returns the current SolrQuery object, if the return value is used. |
|
1456 | + * </p> |
|
1457 | + */ |
|
1458 | + public function setExpandQuery($q) {} |
|
1459 | + |
|
1460 | + /** |
|
1461 | + * (PECL solr >= 2.2.0)<br/> |
|
1462 | + * Sets the number of rows to display in each group (expand.rows). Server Default 5 |
|
1463 | + * @link https://php.net/manual/en/solrquery.setexpandrows.php |
|
1464 | + * @param int $value |
|
1465 | + * @return SolrQuery <p> |
|
1466 | + * Returns the current SolrQuery object, if the return value is used. |
|
1467 | + * </p> |
|
1468 | + */ |
|
1469 | + public function setExpandRows($value) {} |
|
1470 | + |
|
1471 | + /** |
|
1472 | + * (PECL solr >= 0.9.2)<br/> |
|
1473 | + * Sets the explainOther common query parameter |
|
1474 | + * @link https://php.net/manual/en/solrquery.setexplainother.php |
|
1475 | + * @param string $query <p> |
|
1476 | + * The Lucene query to identify a set of documents |
|
1477 | + * </p> |
|
1478 | + * @return SolrQuery <p> |
|
1479 | + * Returns the current SolrQuery object, if the return value is used. |
|
1480 | + * </p> |
|
1481 | + */ |
|
1482 | + public function setExplainOther($query) {} |
|
1483 | + |
|
1484 | + /** |
|
1485 | + * (PECL solr >= 0.9.2)<br/> |
|
1486 | + * Maps to the facet parameter. Enables or disables facetting |
|
1487 | + * @link https://php.net/manual/en/solrquery.setfacet.php |
|
1488 | + * @param bool $flag <p> |
|
1489 | + * <b>TRUE</b> enables faceting and <b>FALSE</b> disables it. |
|
1490 | + * </p> |
|
1491 | + * @return SolrQuery <p> |
|
1492 | + * Returns the current SolrQuery object, if the return value is used. |
|
1493 | + * </p> |
|
1494 | + */ |
|
1495 | + public function setFacet($flag) {} |
|
1496 | + |
|
1497 | + /** |
|
1498 | + * (PECL solr >= 0.9.2)<br/> |
|
1499 | + * Maps to facet.date.end |
|
1500 | + * @link https://php.net/manual/en/solrquery.setfacetdateend.php |
|
1501 | + * @param string $value <p> |
|
1502 | + * See facet.date.end |
|
1503 | + * </p> |
|
1504 | + * @param string $field_override [optional] <p> |
|
1505 | + * Name of the field |
|
1506 | + * </p> |
|
1507 | + * @return SolrQuery <p> |
|
1508 | + * Returns the current SolrQuery object, if the return value is used. |
|
1509 | + * </p> |
|
1510 | + */ |
|
1511 | + public function setFacetDateEnd($value, $field_override) {} |
|
1512 | + |
|
1513 | + /** |
|
1514 | + * (PECL solr >= 0.9.2)<br/> |
|
1515 | + * Maps to facet.date.gap |
|
1516 | + * @link https://php.net/manual/en/solrquery.setfacetdategap.php |
|
1517 | + * @param string $value <p> |
|
1518 | + * See facet.date.gap |
|
1519 | + * </p> |
|
1520 | + * @param string $field_override [optional] <p> |
|
1521 | + * Name of the field |
|
1522 | + * </p> |
|
1523 | + * @return SolrQuery <p> |
|
1524 | + * Returns the current SolrQuery object, if the return value is used. |
|
1525 | + * </p> |
|
1526 | + */ |
|
1527 | + public function setFacetDateGap($value, $field_override) {} |
|
1528 | + |
|
1529 | + /** |
|
1530 | + * (PECL solr >= 0.9.2)<br/> |
|
1531 | + * Maps to facet.date.hardend |
|
1532 | + * @link https://php.net/manual/en/solrquery.setfacetdatehardend.php |
|
1533 | + * @param bool $value <p> |
|
1534 | + * See facet.date.hardend |
|
1535 | + * </p> |
|
1536 | + * @param string $field_override [optional] <p> |
|
1537 | + * Name of the field |
|
1538 | + * </p> |
|
1539 | + * @return SolrQuery <p> |
|
1540 | + * Returns the current SolrQuery object, if the return value is used. |
|
1541 | + * </p> |
|
1542 | + */ |
|
1543 | + public function setFacetDateHardEnd($value, $field_override) {} |
|
1544 | + |
|
1545 | + /** |
|
1546 | + * (PECL solr >= 0.9.2)<br/> |
|
1547 | + * Maps to facet.date.start |
|
1548 | + * @link https://php.net/manual/en/solrquery.setfacetdatestart.php |
|
1549 | + * @param string $value <p> |
|
1550 | + * See facet.date.start |
|
1551 | + * </p> |
|
1552 | + * @param string $field_override [optional] <p> |
|
1553 | + * Name of the field |
|
1554 | + * </p> |
|
1555 | + * @return SolrQuery <p> |
|
1556 | + * Returns the current SolrQuery object, if the return value is used. |
|
1557 | + * </p> |
|
1558 | + */ |
|
1559 | + public function setFacetDateStart($value, $field_override) {} |
|
1560 | + |
|
1561 | + /** |
|
1562 | + * (PECL solr >= 0.9.2)<br/> |
|
1563 | + * Sets the minimum document frequency used for determining term count |
|
1564 | + * @link https://php.net/manual/en/solrquery.setfacetenumcachemindefaultfrequency.php |
|
1565 | + * @param int $frequency <p> |
|
1566 | + * The minimum frequency |
|
1567 | + * </p> |
|
1568 | + * @param string $field_override [optional] <p> |
|
1569 | + * Name of the field |
|
1570 | + * </p> |
|
1571 | + * @return SolrQuery <p> |
|
1572 | + * Returns the current SolrQuery object, if the return value is used. |
|
1573 | + * </p> |
|
1574 | + */ |
|
1575 | + public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override) {} |
|
1576 | + |
|
1577 | + /** |
|
1578 | + * (PECL solr >= 0.9.2)<br/> |
|
1579 | + * Maps to facet.limit |
|
1580 | + * @link https://php.net/manual/en/solrquery.setfacetlimit.php |
|
1581 | + * @param int $limit <p> |
|
1582 | + * The maximum number of constraint counts |
|
1583 | + * </p> |
|
1584 | + * @param string $field_override [optional] <p> |
|
1585 | + * Name of the field |
|
1586 | + * </p> |
|
1587 | + * @return SolrQuery <p> |
|
1588 | + * Returns the current SolrQuery object, if the return value is used. |
|
1589 | + * </p> |
|
1590 | + */ |
|
1591 | + public function setFacetLimit($limit, $field_override) {} |
|
1592 | + |
|
1593 | + /** |
|
1594 | + * (PECL solr >= 0.9.2)<br/> |
|
1595 | + * Specifies the type of algorithm to use when faceting a field |
|
1596 | + * @link https://php.net/manual/en/solrquery.setfacetmethod.php |
|
1597 | + * @param string $method <p> |
|
1598 | + * The method to use. |
|
1599 | + * </p> |
|
1600 | + * @param string $field_override [optional] <p> |
|
1601 | + * Name of the field |
|
1602 | + * </p> |
|
1603 | + * @return SolrQuery <p> |
|
1604 | + * Returns the current SolrQuery object, if the return value is used. |
|
1605 | + * </p> |
|
1606 | + */ |
|
1607 | + public function setFacetMethod($method, $field_override) {} |
|
1608 | + |
|
1609 | + /** |
|
1610 | + * (PECL solr >= 0.9.2)<br/> |
|
1611 | + * Maps to facet.mincount |
|
1612 | + * @link https://php.net/manual/en/solrquery.setfacetmincount.php |
|
1613 | + * @param int $mincount <p> |
|
1614 | + * The minimum count |
|
1615 | + * </p> |
|
1616 | + * @param string $field_override [optional] <p> |
|
1617 | + * Name of the field |
|
1618 | + * </p> |
|
1619 | + * @return SolrQuery <p> |
|
1620 | + * Returns the current SolrQuery object, if the return value is used. |
|
1621 | + * </p> |
|
1622 | + */ |
|
1623 | + public function setFacetMinCount($mincount, $field_override) {} |
|
1624 | + |
|
1625 | + /** |
|
1626 | + * (PECL solr >= 0.9.2)<br/> |
|
1627 | + * Maps to facet.missing |
|
1628 | + * @link https://php.net/manual/en/solrquery.setfacetmissing.php |
|
1629 | + * @param bool $flag <p> |
|
1630 | + * <b>TRUE</b> turns this feature on. <b>FALSE</b> disables it. |
|
1631 | + * </p> |
|
1632 | + * @param string $field_override [optional] <p> |
|
1633 | + * Name of the field |
|
1634 | + * </p> |
|
1635 | + * @return SolrQuery <p> |
|
1636 | + * Returns the current SolrQuery object, if the return value is used. |
|
1637 | + * </p> |
|
1638 | + */ |
|
1639 | + public function setFacetMissing($flag, $field_override) {} |
|
1640 | + |
|
1641 | + /** |
|
1642 | + * (PECL solr >= 0.9.2)<br/> |
|
1643 | + * Sets the offset into the list of constraints to allow for pagination |
|
1644 | + * @link https://php.net/manual/en/solrquery.setfacetoffset.php |
|
1645 | + * @param int $offset <p> |
|
1646 | + * The offset |
|
1647 | + * </p> |
|
1648 | + * @param string $field_override [optional] <p> |
|
1649 | + * Name of the field |
|
1650 | + * </p> |
|
1651 | + * @return SolrQuery <p> |
|
1652 | + * Returns the current SolrQuery object, if the return value is used. |
|
1653 | + * </p> |
|
1654 | + */ |
|
1655 | + public function setFacetOffset($offset, $field_override) {} |
|
1656 | + |
|
1657 | + /** |
|
1658 | + * (PECL solr >= 0.9.2)<br/> |
|
1659 | + * Specifies a string prefix with which to limits the terms on which to facet |
|
1660 | + * @link https://php.net/manual/en/solrquery.setfacetprefix.php |
|
1661 | + * @param string $prefix <p> |
|
1662 | + * The prefix string |
|
1663 | + * </p> |
|
1664 | + * @param string $field_override [optional] <p> |
|
1665 | + * Name of the field |
|
1666 | + * </p> |
|
1667 | + * @return SolrQuery <p> |
|
1668 | + * Returns the current SolrQuery object, if the return value is used. |
|
1669 | + * </p> |
|
1670 | + */ |
|
1671 | + public function setFacetPrefix($prefix, $field_override) {} |
|
1672 | + |
|
1673 | + /** |
|
1674 | + * (PECL solr >= 0.9.2)<br/> |
|
1675 | + * Determines the ordering of the facet field constraints |
|
1676 | + * @link https://php.net/manual/en/solrquery.setfacetsort.php |
|
1677 | + * @param int $facetSort <p> |
|
1678 | + * Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count. |
|
1679 | + * </p> |
|
1680 | + * @param string $field_override [optional] <p> |
|
1681 | + * Name of the field |
|
1682 | + * </p> |
|
1683 | + * @return SolrQuery <p> |
|
1684 | + * Returns the current SolrQuery object, if the return value is used. |
|
1685 | + * </p> |
|
1686 | + */ |
|
1687 | + public function setFacetSort($facetSort, $field_override) {} |
|
1688 | + |
|
1689 | + /** |
|
1690 | + * (PECL solr >= 2.2.0)<br/> |
|
1691 | + * Enable/Disable result grouping (group parameter) |
|
1692 | + * @link https://php.net/manual/en/solrquery.setgroup.php |
|
1693 | + * @param bool $value |
|
1694 | + * @return SolrQuery <p> |
|
1695 | + * Returns the current SolrQuery object, if the return value is used. |
|
1696 | + * </p> |
|
1697 | + */ |
|
1698 | + public function setGroup($value) {} |
|
1699 | + |
|
1700 | + /** |
|
1701 | + * (PECL solr >= 2.2.0)<br/> |
|
1702 | + * Enables caching for result grouping |
|
1703 | + * @link https://php.net/manual/en/solrquery.setgroupcachepercent.php |
|
1704 | + * @param int $percent <p> |
|
1705 | + * Setting this parameter to a number greater than 0 enables caching for result grouping. Result Grouping executes |
|
1706 | + * two searches; this option caches the second search. The server default value is 0. Testing has shown that group |
|
1707 | + * caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or |
|
1708 | + * "match all" queries, group caching degrades performance. group.cache.percent parameter. |
|
1709 | + * </p> |
|
1710 | + * @return SolrQuery <p> |
|
1711 | + * Returns the current SolrQuery object, if the return value is used. |
|
1712 | + * </p> |
|
1713 | + */ |
|
1714 | + public function setGroupCachePercent($percent) {} |
|
1715 | + |
|
1716 | + /** |
|
1717 | + * (PECL solr >= 2.2.0)<br/> |
|
1718 | + * Sets group.facet parameter |
|
1719 | + * @link https://php.net/manual/en/solrquery.setgroupfacet.php |
|
1720 | + * @param bool $value |
|
1721 | + * @return SolrQuery <p> |
|
1722 | + * Returns the current SolrQuery object, if the return value is used. |
|
1723 | + * </p> |
|
1724 | + */ |
|
1725 | + public function setGroupFacet($value) {} |
|
1726 | + |
|
1727 | + /** |
|
1728 | + * (PECL solr >= 2.2.0)<br/> |
|
1729 | + * Sets the group format, result structure (group.format parameter). |
|
1730 | + * @link https://php.net/manual/en/solrquery.setgroupformat.php |
|
1731 | + * @param string $value <p> |
|
1732 | + * Sets the group.format parameter. If this parameter is set to simple, the grouped documents are presented in a |
|
1733 | + * single flat list, and the start and rows parameters affect the numbers of documents instead of groups.<br/> |
|
1734 | + * Accepts: grouped/simple |
|
1735 | + * </p> |
|
1736 | + * @return SolrQuery <p> |
|
1737 | + * Returns the current SolrQuery object, if the return value is used. |
|
1738 | + * </p> |
|
1739 | + */ |
|
1740 | + public function setGroupFormat($value) {} |
|
1741 | + |
|
1742 | + /** |
|
1743 | + * (PECL solr >= 2.2.0)<br/> |
|
1744 | + * Specifies the number of results to return for each group. The server default value is 1. |
|
1745 | + * @link https://php.net/manual/en/solrquery.setgrouplimit.php |
|
1746 | + * @param int $value |
|
1747 | + * @return SolrQuery <p> |
|
1748 | + * Returns the current SolrQuery object, if the return value is used. |
|
1749 | + * </p> |
|
1750 | + */ |
|
1751 | + public function setGroupLimit($value) {} |
|
1752 | + |
|
1753 | + /** |
|
1754 | + * (PECL solr >= 2.2.0)<br/> |
|
1755 | + * If true, the result of the first field grouping command is used as the main result list in the response, using |
|
1756 | + * group.format=simple. |
|
1757 | + * @link https://php.net/manual/en/solrquery.setgroupmain.php |
|
1758 | + * @param string $value |
|
1759 | + * @return SolrQuery <p> |
|
1760 | + * Returns the current SolrQuery object, if the return value is used. |
|
1761 | + * </p> |
|
1762 | + */ |
|
1763 | + public function setGroupMain($value) {} |
|
1764 | + |
|
1765 | + /** |
|
1766 | + * (PECL solr >= 2.2.0)<br/> |
|
1767 | + * If true, Solr includes the number of groups that have matched the query in the results. |
|
1768 | + * @link https://php.net/manual/en/solrquery.setgroupngroups.php |
|
1769 | + * @param bool $value |
|
1770 | + * @return SolrQuery <p> |
|
1771 | + * Returns the current SolrQuery object, if the return value is used. |
|
1772 | + * </p> |
|
1773 | + */ |
|
1774 | + public function setGroupNGroups($value) {} |
|
1775 | + |
|
1776 | + /** |
|
1777 | + * (PECL solr >= 2.2.0)<br/> |
|
1778 | + * Sets the group.offset parameter. |
|
1779 | + * @link https://php.net/manual/en/solrquery.setgroupoffset.php |
|
1780 | + * @param int $value |
|
1781 | + * @return SolrQuery <p> |
|
1782 | + * Returns the current SolrQuery object, if the return value is used. |
|
1783 | + * </p> |
|
1784 | + */ |
|
1785 | + public function setGroupOffset($value) {} |
|
1786 | + |
|
1787 | + /** |
|
1788 | + * (PECL solr >= 2.2.0)<br/> |
|
1789 | + * If true, facet counts are based on the most relevant document of each group matching the query. |
|
1790 | + * @link https://php.net/manual/en/solrquery.setgrouptruncate.php |
|
1791 | + * @param bool $value |
|
1792 | + * @return SolrQuery <p> |
|
1793 | + * Returns the current SolrQuery object, if the return value is used. |
|
1794 | + * </p> |
|
1795 | + */ |
|
1796 | + public function setGroupTruncate($value) {} |
|
1797 | + |
|
1798 | + /** |
|
1799 | + * (PECL solr >= 0.9.2)<br/> |
|
1800 | + * Enables or disables highlighting |
|
1801 | + * @link https://php.net/manual/en/solrquery.sethighlight.php |
|
1802 | + * @param bool $flag <p> |
|
1803 | + * Setting it to <b>TRUE</b> enables highlighted snippets to be generated in the query response.<br/> |
|
1804 | + * Setting it to <b>FALSE</b> disables highlighting |
|
1805 | + * </p> |
|
1806 | + * @return SolrQuery <p> |
|
1807 | + * Returns the current SolrQuery object, if the return value is used. |
|
1808 | + * </p> |
|
1809 | + */ |
|
1810 | + public function setHighlight($flag) {} |
|
1811 | + |
|
1812 | + /** |
|
1813 | + * (PECL solr >= 0.9.2)<br/> |
|
1814 | + * Specifies the backup field to use |
|
1815 | + * @link https://php.net/manual/en/solrquery.sethighlightalternatefield.php |
|
1816 | + * @param string $field <p> |
|
1817 | + * The name of the backup field |
|
1818 | + * </p> |
|
1819 | + * @param string $field_override [optional] <p> |
|
1820 | + * Name of the field |
|
1821 | + * </p> |
|
1822 | + * @return SolrQuery <p> |
|
1823 | + * Returns the current SolrQuery object, if the return value is used. |
|
1824 | + * </p> |
|
1825 | + */ |
|
1826 | + public function setHighlightAlternateField($field, $field_override) {} |
|
1827 | + |
|
1828 | + /** |
|
1829 | + * (PECL solr >= 0.9.2)<br/> |
|
1830 | + * Specify a formatter for the highlight output |
|
1831 | + * @link https://php.net/manual/en/solrquery.sethighlightformatter.php |
|
1832 | + * @param string $formatter <p> |
|
1833 | + * Currently the only legal value is "simple" |
|
1834 | + * </p> |
|
1835 | + * @param string $field_override [optional] <p> |
|
1836 | + * Name of the field |
|
1837 | + * </p> |
|
1838 | + * @return SolrQuery <p> |
|
1839 | + * Returns the current SolrQuery object, if the return value is used. |
|
1840 | + * </p> |
|
1841 | + */ |
|
1842 | + public function setHighlightFormatter($formatter, $field_override) {} |
|
1843 | + |
|
1844 | + /** |
|
1845 | + * (PECL solr >= 0.9.2)<br/> |
|
1846 | + * Sets a text snippet generator for highlighted text |
|
1847 | + * @link https://php.net/manual/en/solrquery.sethighlightfragmenter.php |
|
1848 | + * @param string $fragmenter <p> |
|
1849 | + * The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain |
|
1850 | + * regular expression |
|
1851 | + * </p> |
|
1852 | + * @param string $field_override [optional] <p> |
|
1853 | + * Name of the field |
|
1854 | + * </p> |
|
1855 | + * @return SolrQuery <p> |
|
1856 | + * Returns the current SolrQuery object, if the return value is used. |
|
1857 | + * </p> |
|
1858 | + */ |
|
1859 | + public function setHighlightFragmenter($fragmenter, $field_override) {} |
|
1860 | + |
|
1861 | + /** |
|
1862 | + * (PECL solr >= 0.9.2)<br/> |
|
1863 | + * The size of fragments to consider for highlighting |
|
1864 | + * @link https://php.net/manual/en/solrquery.sethighlightfragsize.php |
|
1865 | + * @param int $size <p> |
|
1866 | + * The size, in characters, of fragments to consider for highlighting |
|
1867 | + * </p> |
|
1868 | + * @param string $field_override [optional] <p> |
|
1869 | + * Name of the field |
|
1870 | + * </p> |
|
1871 | + * @return SolrQuery <p> |
|
1872 | + * Returns the current SolrQuery object, if the return value is used. |
|
1873 | + * </p> |
|
1874 | + */ |
|
1875 | + public function setHighlightFragsize($size, $field_override) {} |
|
1876 | + |
|
1877 | + /** |
|
1878 | + * (PECL solr >= 0.9.2)<br/> |
|
1879 | + * Use SpanScorer to highlight phrase terms |
|
1880 | + * @link https://php.net/manual/en/solrquery.sethighlighthighlightmultiterm.php |
|
1881 | + * @param bool $flag <p> |
|
1882 | + * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the |
|
1883 | + * document. |
|
1884 | + * </p> |
|
1885 | + * @return SolrQuery <p> |
|
1886 | + * Returns the current SolrQuery object, if the return value is used. |
|
1887 | + * </p> |
|
1888 | + */ |
|
1889 | + public function setHighlightHighlightMultiTerm($flag) {} |
|
1890 | + |
|
1891 | + /** |
|
1892 | + * (PECL solr >= 0.9.2)<br/> |
|
1893 | + * Sets the maximum number of characters of the field to return |
|
1894 | + * @link https://php.net/manual/en/solrquery.sethighlightmaxalternatefieldlength.php |
|
1895 | + * @param int $fieldLength <p> |
|
1896 | + * The length of the field |
|
1897 | + * </p> |
|
1898 | + * <p> |
|
1899 | + * If SolrQuery::setHighlightAlternateField() was passed the value <b>TRUE</b>, this parameter specifies the maximum |
|
1900 | + * number of characters of the field to return |
|
1901 | + * </p> |
|
1902 | + * <p> |
|
1903 | + * Any value less than or equal to 0 means unlimited. |
|
1904 | + * </p> |
|
1905 | + * @param string $field_override [optional] <p> |
|
1906 | + * Name of the field |
|
1907 | + * </p> |
|
1908 | + * @return SolrQuery <p> |
|
1909 | + * Returns the current SolrQuery object, if the return value is used. |
|
1910 | + * </p> |
|
1911 | + */ |
|
1912 | + public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override) {} |
|
1913 | + |
|
1914 | + /** |
|
1915 | + * (PECL solr >= 0.9.2)<br/> |
|
1916 | + * Specifies the number of characters into a document to look for suitable snippets |
|
1917 | + * @link https://php.net/manual/en/solrquery.sethighlightmaxanalyzedchars.php |
|
1918 | + * @param int $value <p> |
|
1919 | + * The number of characters into a document to look for suitable snippets |
|
1920 | + * </p> |
|
1921 | + * @return SolrQuery <p> |
|
1922 | + * Returns the current SolrQuery object, if the return value is used. |
|
1923 | + * </p> |
|
1924 | + */ |
|
1925 | + public function setHighlightMaxAnalyzedChars($value) {} |
|
1926 | + |
|
1927 | + /** |
|
1928 | + * (PECL solr >= 0.9.2)<br/> |
|
1929 | + * Whether or not to collapse contiguous fragments into a single fragment |
|
1930 | + * @link https://php.net/manual/en/solrquery.sethighlightmergecontiguous.php |
|
1931 | + * @param bool $flag <p> |
|
1932 | + * Whether or not to collapse contiguous fragments into a single fragment |
|
1933 | + * </p> |
|
1934 | + * @param string $field_override [optional] <p> |
|
1935 | + * Name of the field |
|
1936 | + * </p> |
|
1937 | + * @return SolrQuery <p> |
|
1938 | + * Returns the current SolrQuery object, if the return value is used. |
|
1939 | + * </p> |
|
1940 | + */ |
|
1941 | + public function setHighlightMergeContiguous($flag, $field_override) {} |
|
1942 | + |
|
1943 | + /** |
|
1944 | + * (PECL solr >= 0.9.2)<br/> |
|
1945 | + * Specify the maximum number of characters to analyze |
|
1946 | + * @link https://php.net/manual/en/solrquery.sethighlightregexmaxanalyzedchars.php |
|
1947 | + * @param int $maxAnalyzedChars <p> |
|
1948 | + * The maximum number of characters to analyze from a field when using the regex fragmenter |
|
1949 | + * </p> |
|
1950 | + * @return SolrQuery <p> |
|
1951 | + * Returns the current SolrQuery object, if the return value is used. |
|
1952 | + * </p> |
|
1953 | + */ |
|
1954 | + public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars) {} |
|
1955 | + |
|
1956 | + /** |
|
1957 | + * (PECL solr >= 0.9.2)<br/> |
|
1958 | + * Specify the regular expression for fragmenting |
|
1959 | + * @link https://php.net/manual/en/solrquery.sethighlightregexpattern.php |
|
1960 | + * @param string $value <p> |
|
1961 | + * The regular expression for fragmenting. This could be used to extract sentences |
|
1962 | + * </p> |
|
1963 | + * @return SolrQuery <p> |
|
1964 | + * Returns the current SolrQuery object, if the return value is used. |
|
1965 | + * </p> |
|
1966 | + */ |
|
1967 | + public function setHighlightRegexPattern($value) {} |
|
1968 | + |
|
1969 | + /** |
|
1970 | + * (PECL solr >= 0.9.2)<br/> |
|
1971 | + * Sets the factor by which the regex fragmenter can stray from the ideal fragment size |
|
1972 | + * @link https://php.net/manual/en/solrquery.sethighlightregexslop.php |
|
1973 | + * @param float $factor <p> |
|
1974 | + * The factor by which the regex fragmenter can stray from the ideal fragment size (specified by |
|
1975 | + * SolrQuery::setHighlightFragsize) to accommodate the regular expression. |
|
1976 | + * </p> |
|
1977 | + * @return SolrQuery <p> |
|
1978 | + * Returns the current SolrQuery object, if the return value is used. |
|
1979 | + * </p> |
|
1980 | + */ |
|
1981 | + public function setHighlightRegexSlop($factor) {} |
|
1982 | + |
|
1983 | + /** |
|
1984 | + * (PECL solr >= 0.9.2)<br/> |
|
1985 | + * Require field matching during highlighting |
|
1986 | + * @link https://php.net/manual/en/solrquery.sethighlightrequirefieldmatch.php |
|
1987 | + * @param bool $flag <p> |
|
1988 | + * If <b>TRUE</b>, then a field will only be highlighted if the query matched in this particular field.<br/> |
|
1989 | + * This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <b>TRUE</b>. |
|
1990 | + * </p> |
|
1991 | + * @return SolrQuery <p> |
|
1992 | + * Returns the current SolrQuery object, if the return value is used. |
|
1993 | + * </p> |
|
1994 | + */ |
|
1995 | + public function setHighlightRequireFieldMatch($flag) {} |
|
1996 | + |
|
1997 | + /** |
|
1998 | + * (PECL solr >= 0.9.2)<br/> |
|
1999 | + * Sets the text which appears after a highlighted term |
|
2000 | + * @link https://php.net/manual/en/solrquery.sethighlightsimplepost.php |
|
2001 | + * @param string $simplePost <p> |
|
2002 | + * Sets the text which appears after a highlighted term. The default is </em> |
|
2003 | + * </p> |
|
2004 | + * @param string $field_override [optional] <p> |
|
2005 | + * Name of the field |
|
2006 | + * </p> |
|
2007 | + * @return SolrQuery <p> |
|
2008 | + * Returns the current SolrQuery object, if the return value is used. |
|
2009 | + * </p> |
|
2010 | + */ |
|
2011 | + public function setHighlightSimplePost($simplePost, $field_override) {} |
|
2012 | + |
|
2013 | + /** |
|
2014 | + * (PECL solr >= 0.9.2)<br/> |
|
2015 | + * Sets the text which appears before a highlighted term |
|
2016 | + * @link https://php.net/manual/en/solrquery.sethighlightsimplepre.php |
|
2017 | + * @param string $simplePre <p> |
|
2018 | + * Sets the text which appears before a highlighted term. The default is <em> |
|
2019 | + * </p> |
|
2020 | + * @param string $field_override [optional] <p> |
|
2021 | + * Name of the field |
|
2022 | + * </p> |
|
2023 | + * @return SolrQuery <p> |
|
2024 | + * Returns the current SolrQuery object, if the return value is used. |
|
2025 | + * </p> |
|
2026 | + */ |
|
2027 | + public function setHighlightSimplePre($simplePre, $field_override) {} |
|
2028 | + |
|
2029 | + /** |
|
2030 | + * (PECL solr >= 0.9.2)<br/> |
|
2031 | + * Sets the maximum number of highlighted snippets to generate per field |
|
2032 | + * @link https://php.net/manual/en/solrquery.sethighlightsnippets.php |
|
2033 | + * @param int $value <p> |
|
2034 | + * The maximum number of highlighted snippets to generate per field |
|
2035 | + * </p> |
|
2036 | + * @param string $field_override [optional] <p> |
|
2037 | + * Name of the field |
|
2038 | + * </p> |
|
2039 | + * @return SolrQuery <p> |
|
2040 | + * Returns the current SolrQuery object, if the return value is used. |
|
2041 | + * </p> |
|
2042 | + */ |
|
2043 | + public function setHighlightSnippets($value, $field_override) {} |
|
2044 | + |
|
2045 | + /** |
|
2046 | + * (PECL solr >= 0.9.2)<br/> |
|
2047 | + * Whether to highlight phrase terms only when they appear within the query phrase |
|
2048 | + * @link https://php.net/manual/en/solrquery.sethighlightusephrasehighlighter.php |
|
2049 | + * @param bool $flag <p> |
|
2050 | + * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the |
|
2051 | + * document. |
|
2052 | + * </p> |
|
2053 | + * @return SolrQuery <p> |
|
2054 | + * Returns the current SolrQuery object, if the return value is used. |
|
2055 | + * </p> |
|
2056 | + */ |
|
2057 | + public function setHighlightUsePhraseHighlighter($flag) {} |
|
2058 | + |
|
2059 | + /** |
|
2060 | + * (PECL solr >= 0.9.2)<br/> |
|
2061 | + * Enables or disables moreLikeThis |
|
2062 | + * @link https://php.net/manual/en/solrquery.setmlt.php |
|
2063 | + * @param bool $flag <p> |
|
2064 | + * <b>TRUE</b> enables it and <b>FALSE</b> turns it off. |
|
2065 | + * </p> |
|
2066 | + * @return SolrQuery <p> |
|
2067 | + * Returns the current SolrQuery object, if the return value is used. |
|
2068 | + * </p> |
|
2069 | + */ |
|
2070 | + public function setMlt($flag) {} |
|
2071 | + |
|
2072 | + /** |
|
2073 | + * (PECL solr >= 0.9.2)<br/> |
|
2074 | + * Set if the query will be boosted by the interesting term relevance |
|
2075 | + * @link https://php.net/manual/en/solrquery.setmltboost.php |
|
2076 | + * @param bool $flag <p> |
|
2077 | + * Sets to <b>TRUE</b> or <b>FALSE</b> |
|
2078 | + * </p> |
|
2079 | + * @return SolrQuery <p> |
|
2080 | + * Returns the current SolrQuery object, if the return value is used. |
|
2081 | + * </p> |
|
2082 | + */ |
|
2083 | + public function setMltBoost($flag) {} |
|
2084 | + |
|
2085 | + /** |
|
2086 | + * (PECL solr >= 0.9.2)<br/> |
|
2087 | + * Set the number of similar documents to return for each result |
|
2088 | + * @link https://php.net/manual/en/solrquery.setmltcount.php |
|
2089 | + * @param int $count <p> |
|
2090 | + * The number of similar documents to return for each result |
|
2091 | + * </p> |
|
2092 | + * @return SolrQuery <p> |
|
2093 | + * Returns the current SolrQuery object, if the return value is used. |
|
2094 | + * </p> |
|
2095 | + */ |
|
2096 | + public function setMltCount($count) {} |
|
2097 | + |
|
2098 | + /** |
|
2099 | + * (PECL solr >= 0.9.2)<br/> |
|
2100 | + * Sets the maximum number of query terms included |
|
2101 | + * @link https://php.net/manual/en/solrquery.setmltmaxnumqueryterms.php |
|
2102 | + * @param int $value <p> |
|
2103 | + * The maximum number of query terms that will be included in any generated query |
|
2104 | + * </p> |
|
2105 | + * @return SolrQuery <p> |
|
2106 | + * Returns the current SolrQuery object, if the return value is used. |
|
2107 | + * </p> |
|
2108 | + */ |
|
2109 | + public function setMltMaxNumQueryTerms($value) {} |
|
2110 | + |
|
2111 | + /** |
|
2112 | + * (PECL solr >= 0.9.2)<br/> |
|
2113 | + * Specifies the maximum number of tokens to parse |
|
2114 | + * @link https://php.net/manual/en/solrquery.setmltmaxnumtokens.php |
|
2115 | + * @param int $value <p> |
|
2116 | + * The maximum number of tokens to parse |
|
2117 | + * </p> |
|
2118 | + * @return SolrQuery <p> |
|
2119 | + * Returns the current SolrQuery object, if the return value is used. |
|
2120 | + * </p> |
|
2121 | + */ |
|
2122 | + public function setMltMaxNumTokens($value) {} |
|
2123 | + |
|
2124 | + /** |
|
2125 | + * (PECL solr >= 0.9.2)<br/> |
|
2126 | + * Sets the maximum word length |
|
2127 | + * @link https://php.net/manual/en/solrquery.setmltmaxwordlength.php |
|
2128 | + * @param int $maxWordLength <p> |
|
2129 | + * The maximum word length above which words will be ignored |
|
2130 | + * </p> |
|
2131 | + * @return SolrQuery <p> |
|
2132 | + * Returns the current SolrQuery object, if the return value is used. |
|
2133 | + * </p> |
|
2134 | + */ |
|
2135 | + public function setMltMaxWordLength($maxWordLength) {} |
|
2136 | + |
|
2137 | + /** |
|
2138 | + * (PECL solr >= 0.9.2)<br/> |
|
2139 | + * Sets the mltMinDoc frequency |
|
2140 | + * @link https://php.net/manual/en/solrquery.setmltmindocfrequency.php |
|
2141 | + * @param int $minDocFrequency <p> |
|
2142 | + * Sets the frequency at which words will be ignored which do not occur in at least this many docs. |
|
2143 | + * </p> |
|
2144 | + * @return SolrQuery <p> |
|
2145 | + * Returns the current SolrQuery object, if the return value is used. |
|
2146 | + * </p> |
|
2147 | + */ |
|
2148 | + public function setMltMinDocFrequency($minDocFrequency) {} |
|
2149 | + |
|
2150 | + /** |
|
2151 | + * (PECL solr >= 0.9.2)<br/> |
|
2152 | + * Sets the frequency below which terms will be ignored in the source docs |
|
2153 | + * @link https://php.net/manual/en/solrquery.setmltmintermfrequency.php |
|
2154 | + * @param int $minTermFrequency <p> |
|
2155 | + * The frequency below which terms will be ignored in the source docs |
|
2156 | + * </p> |
|
2157 | + * @return SolrQuery <p> |
|
2158 | + * Returns the current SolrQuery object, if the return value is used. |
|
2159 | + * </p> |
|
2160 | + */ |
|
2161 | + public function setMltMinTermFrequency($minTermFrequency) {} |
|
2162 | + |
|
2163 | + /** |
|
2164 | + * (PECL solr >= 0.9.2)<br/> |
|
2165 | + * Sets the minimum word length |
|
2166 | + * @link https://php.net/manual/en/solrquery.setmltminwordlength.php |
|
2167 | + * @param int $minWordLength <p> |
|
2168 | + * The minimum word length below which words will be ignored |
|
2169 | + * </p> |
|
2170 | + * @return SolrQuery <p> |
|
2171 | + * Returns the current SolrQuery object, if the return value is used. |
|
2172 | + * </p> |
|
2173 | + */ |
|
2174 | + public function setMltMinWordLength($minWordLength) {} |
|
2175 | + |
|
2176 | + /** |
|
2177 | + * (PECL solr >= 0.9.2)<br/> |
|
2178 | + * Exclude the header from the returned results |
|
2179 | + * @link https://php.net/manual/en/solrquery.setomitheader.php |
|
2180 | + * @param bool $flag <p> |
|
2181 | + * <b>TRUE</b> excludes the header from the result. |
|
2182 | + * </p> |
|
2183 | + * @return SolrQuery <p> |
|
2184 | + * Returns the current SolrQuery object, if the return value is used. |
|
2185 | + * </p> |
|
2186 | + */ |
|
2187 | + public function setOmitHeader($flag) {} |
|
2188 | + |
|
2189 | + /** |
|
2190 | + * (PECL solr >= 0.9.2)<br/> |
|
2191 | + * Sets the search query |
|
2192 | + * @link https://php.net/manual/en/solrquery.setquery.php |
|
2193 | + * @param string $query <p> |
|
2194 | + * The search query |
|
2195 | + * </p> |
|
2196 | + * @return SolrQuery <p> |
|
2197 | + * Returns the current SolrQuery object, if the return value is used. |
|
2198 | + * </p> |
|
2199 | + */ |
|
2200 | + public function setQuery($query) {} |
|
2201 | + |
|
2202 | + /** |
|
2203 | + * (PECL solr >= 0.9.2)<br/> |
|
2204 | + * Specifies the maximum number of rows to return in the result |
|
2205 | + * @link https://php.net/manual/en/solrquery.setrows.php |
|
2206 | + * @param int $rows <p> |
|
2207 | + * The maximum number of rows to return |
|
2208 | + * </p> |
|
2209 | + * @return SolrQuery <p> |
|
2210 | + * Returns the current SolrQuery object, if the return value is used. |
|
2211 | + * </p> |
|
2212 | + */ |
|
2213 | + public function setRows($rows) {} |
|
2214 | + |
|
2215 | + /** |
|
2216 | + * (PECL solr >= 0.9.2)<br/> |
|
2217 | + * Flag to show debug information |
|
2218 | + * @link https://php.net/manual/en/solrquery.setshowdebuginfo.php |
|
2219 | + * @param bool $flag <p> |
|
2220 | + * Whether to show debug info. <b>TRUE</b> or <b>FALSE</b> |
|
2221 | + * </p> |
|
2222 | + * @return SolrQuery <p> |
|
2223 | + * Returns the current SolrQuery object, if the return value is used. |
|
2224 | + * </p> |
|
2225 | + */ |
|
2226 | + public function setShowDebugInfo($flag) {} |
|
2227 | + |
|
2228 | + /** |
|
2229 | + * (PECL solr >= 0.9.2)<br/> |
|
2230 | + * Specifies the number of rows to skip |
|
2231 | + * @link https://php.net/manual/en/solrquery.setstart.php |
|
2232 | + * @param int $start <p> |
|
2233 | + * The number of rows to skip. |
|
2234 | + * </p> |
|
2235 | + * @return SolrQuery <p> |
|
2236 | + * Returns the current SolrQuery object, if the return value is used. |
|
2237 | + * </p> |
|
2238 | + */ |
|
2239 | + public function setStart($start) {} |
|
2240 | + |
|
2241 | + /** |
|
2242 | + * (PECL solr >= 0.9.2)<br/> |
|
2243 | + * Enables or disables the Stats component |
|
2244 | + * @link https://php.net/manual/en/solrquery.setstats.php |
|
2245 | + * @param bool $flag <p> |
|
2246 | + * <b>TRUE</b> turns on the stats component and <b>FALSE</b> disables it. |
|
2247 | + * </p> |
|
2248 | + * @return SolrQuery <p> |
|
2249 | + * Returns the current SolrQuery object, if the return value is used. |
|
2250 | + * </p> |
|
2251 | + */ |
|
2252 | + public function setStats($flag) {} |
|
2253 | + |
|
2254 | + /** |
|
2255 | + * (PECL solr >= 0.9.2)<br/> |
|
2256 | + * Enables or disables the TermsComponent |
|
2257 | + * @link https://php.net/manual/en/solrquery.setterms.php |
|
2258 | + * @param bool $flag <p> |
|
2259 | + * <b>TRUE</b> enables it. <b>FALSE</b> turns it off |
|
2260 | + * </p> |
|
2261 | + * @return SolrQuery <p> |
|
2262 | + * Returns the current SolrQuery object, if the return value is used. |
|
2263 | + * </p> |
|
2264 | + */ |
|
2265 | + public function setTerms($flag) {} |
|
2266 | + |
|
2267 | + /** |
|
2268 | + * (PECL solr >= 0.9.2)<br/> |
|
2269 | + * Sets the name of the field to get the Terms from |
|
2270 | + * @link https://php.net/manual/en/solrquery.settermsfield.php |
|
2271 | + * @param string $fieldname <p> |
|
2272 | + * The field name |
|
2273 | + * </p> |
|
2274 | + * @return SolrQuery <p> |
|
2275 | + * Returns the current SolrQuery object, if the return value is used. |
|
2276 | + * </p> |
|
2277 | + */ |
|
2278 | + public function setTermsField($fieldname) {} |
|
2279 | + |
|
2280 | + /** |
|
2281 | + * (PECL solr >= 0.9.2)<br/> |
|
2282 | + * Include the lower bound term in the result set |
|
2283 | + * @link https://php.net/manual/en/solrquery.settermsincludelowerbound.php |
|
2284 | + * @param bool $flag <p> |
|
2285 | + * Include the lower bound term in the result set |
|
2286 | + * </p> |
|
2287 | + * @return SolrQuery <p> |
|
2288 | + * Returns the current SolrQuery object, if the return value is used. |
|
2289 | + * </p> |
|
2290 | + */ |
|
2291 | + public function setTermsIncludeLowerBound($flag) {} |
|
2292 | + |
|
2293 | + /** |
|
2294 | + * (PECL solr >= 0.9.2)<br/> |
|
2295 | + * Include the upper bound term in the result set |
|
2296 | + * @link https://php.net/manual/en/solrquery.settermsincludeupperbound.php |
|
2297 | + * @param bool $flag <p> |
|
2298 | + * <b>TRUE</b> or <b>FALSE</b> |
|
2299 | + * </p> |
|
2300 | + * @return SolrQuery <p> |
|
2301 | + * Returns the current SolrQuery object, if the return value is used. |
|
2302 | + * </p> |
|
2303 | + */ |
|
2304 | + public function setTermsIncludeUpperBound($flag) {} |
|
2305 | + |
|
2306 | + /** |
|
2307 | + * (PECL solr >= 0.9.2)<br/> |
|
2308 | + * Sets the maximum number of terms to return |
|
2309 | + * @link https://php.net/manual/en/solrquery.settermslimit.php |
|
2310 | + * @param int $limit <p> |
|
2311 | + * The maximum number of terms to return. All the terms will be returned if the limit is negative. |
|
2312 | + * </p> |
|
2313 | + * @return SolrQuery <p> |
|
2314 | + * Returns the current SolrQuery object, if the return value is used. |
|
2315 | + * </p> |
|
2316 | + */ |
|
2317 | + public function setTermsLimit($limit) {} |
|
2318 | + |
|
2319 | + /** |
|
2320 | + * (PECL solr >= 0.9.2)<br/> |
|
2321 | + * Specifies the Term to start from |
|
2322 | + * @link https://php.net/manual/en/solrquery.settermslowerbound.php |
|
2323 | + * @param string $lowerBound <p> |
|
2324 | + * The lower bound Term |
|
2325 | + * </p> |
|
2326 | + * @return SolrQuery <p> |
|
2327 | + * Returns the current SolrQuery object, if the return value is used. |
|
2328 | + * </p> |
|
2329 | + */ |
|
2330 | + public function setTermsLowerBound($lowerBound) {} |
|
2331 | + |
|
2332 | + /** |
|
2333 | + * (PECL solr >= 0.9.2)<br/> |
|
2334 | + * Sets the maximum document frequency |
|
2335 | + * @link https://php.net/manual/en/solrquery.settermsmaxcount.php |
|
2336 | + * @param int $frequency <p> |
|
2337 | + * The maximum document frequency. |
|
2338 | + * </p> |
|
2339 | + * @return SolrQuery <p> |
|
2340 | + * Returns the current SolrQuery object, if the return value is used. |
|
2341 | + * </p> |
|
2342 | + */ |
|
2343 | + public function setTermsMaxCount($frequency) {} |
|
2344 | + |
|
2345 | + /** |
|
2346 | + * (PECL solr >= 0.9.2)<br/> |
|
2347 | + * Sets the minimum document frequency |
|
2348 | + * @link https://php.net/manual/en/solrquery.settermsmincount.php |
|
2349 | + * @param int $frequency <p> |
|
2350 | + * The minimum frequency |
|
2351 | + * </p> |
|
2352 | + * @return SolrQuery <p> |
|
2353 | + * Returns the current SolrQuery object, if the return value is used. |
|
2354 | + * </p> |
|
2355 | + */ |
|
2356 | + public function setTermsMinCount($frequency) {} |
|
2357 | + |
|
2358 | + /** |
|
2359 | + * (PECL solr >= 0.9.2)<br/> |
|
2360 | + * Restrict matches to terms that start with the prefix |
|
2361 | + * @link https://php.net/manual/en/solrquery.settermsprefix.php |
|
2362 | + * @param string $prefix <p> |
|
2363 | + * Restrict matches to terms that start with the prefix |
|
2364 | + * </p> |
|
2365 | + * @return SolrQuery <p> |
|
2366 | + * Returns the current SolrQuery object, if the return value is used. |
|
2367 | + * </p> |
|
2368 | + */ |
|
2369 | + public function setTermsPrefix($prefix) {} |
|
2370 | + |
|
2371 | + /** |
|
2372 | + * (PECL solr >= 0.9.2)<br/> |
|
2373 | + * Return the raw characters of the indexed term |
|
2374 | + * @link https://php.net/manual/en/solrquery.settermsreturnraw.php |
|
2375 | + * @param bool $flag <p> |
|
2376 | + * <b>TRUE</b> or <b>FALSE</b> |
|
2377 | + * </p> |
|
2378 | + * @return SolrQuery <p> |
|
2379 | + * Returns the current SolrQuery object, if the return value is used. |
|
2380 | + * </p> |
|
2381 | + */ |
|
2382 | + public function setTermsReturnRaw($flag) {} |
|
2383 | + |
|
2384 | + /** |
|
2385 | + * (PECL solr >= 0.9.2)<br/> |
|
2386 | + * Specifies how to sort the returned terms |
|
2387 | + * @link https://php.net/manual/en/solrquery.settermssort.php |
|
2388 | + * @param int $sortType <p> |
|
2389 | + * If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first).<br/> |
|
2390 | + * If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order |
|
2391 | + * </p> |
|
2392 | + * @return SolrQuery <p> |
|
2393 | + * Returns the current SolrQuery object, if the return value is used. |
|
2394 | + * </p> |
|
2395 | + */ |
|
2396 | + public function setTermsSort($sortType) {} |
|
2397 | + |
|
2398 | + /** |
|
2399 | + * (PECL solr >= 0.9.2)<br/> |
|
2400 | + * Sets the term to stop at |
|
2401 | + * @link https://php.net/manual/en/solrquery.settermsupperbound.php |
|
2402 | + * @param string $upperBound <p> |
|
2403 | + * The term to stop at |
|
2404 | + * </p> |
|
2405 | + * @return SolrQuery <p> |
|
2406 | + * Returns the current SolrQuery object, if the return value is used. |
|
2407 | + * </p> |
|
2408 | + */ |
|
2409 | + public function setTermsUpperBound($upperBound) {} |
|
2410 | + |
|
2411 | + /** |
|
2412 | + * (PECL solr >= 0.9.2)<br/> |
|
2413 | + * The time allowed for search to finish |
|
2414 | + * @link https://php.net/manual/en/solrquery.settimeallowed.php |
|
2415 | + * @param int $timeAllowed <p> |
|
2416 | + * The time allowed for a search to finish. This value only applies to the search and not to requests in general. |
|
2417 | + * Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be |
|
2418 | + * returned, if there are any. |
|
2419 | + * </p> |
|
2420 | + * @return SolrQuery <p> |
|
2421 | + * Returns the current SolrQuery object, if the return value is used. |
|
2422 | + * </p> |
|
2423 | + */ |
|
2424 | + public function setTimeAllowed($timeAllowed) {} |
|
2425 | 2425 | } |
@@ -12,8 +12,7 @@ |
||
12 | 12 | * This class represents a collection of name-value pairs sent to the Solr server during a request. |
13 | 13 | * @link https://php.net/manual/en/class.solrquery.php |
14 | 14 | */ |
15 | -class SolrQuery extends SolrModifiableParams implements Serializable |
|
16 | -{ |
|
15 | +class SolrQuery extends SolrModifiableParams implements Serializable { |
|
17 | 16 | /** @var int Used to specify that the sorting should be in acending order */ |
18 | 17 | public const ORDER_ASC = 0; |
19 | 18 |
@@ -14,146 +14,146 @@ |
||
14 | 14 | */ |
15 | 15 | abstract class SolrParams implements Serializable |
16 | 16 | { |
17 | - /** |
|
18 | - * (PECL solr >= 0.9.2)<br/> |
|
19 | - * This is an alias for SolrParams::addParam |
|
20 | - * @link https://php.net/manual/en/solrparams.add.php |
|
21 | - * @param string $name <p> |
|
22 | - * The name of the parameter |
|
23 | - * </p> |
|
24 | - * @param string $value <p> |
|
25 | - * The value of the parameter |
|
26 | - * </p> |
|
27 | - * @return SolrParams|false <p> |
|
28 | - * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
29 | - * </p> |
|
30 | - */ |
|
31 | - public function add($name, $value) {} |
|
17 | + /** |
|
18 | + * (PECL solr >= 0.9.2)<br/> |
|
19 | + * This is an alias for SolrParams::addParam |
|
20 | + * @link https://php.net/manual/en/solrparams.add.php |
|
21 | + * @param string $name <p> |
|
22 | + * The name of the parameter |
|
23 | + * </p> |
|
24 | + * @param string $value <p> |
|
25 | + * The value of the parameter |
|
26 | + * </p> |
|
27 | + * @return SolrParams|false <p> |
|
28 | + * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
29 | + * </p> |
|
30 | + */ |
|
31 | + public function add($name, $value) {} |
|
32 | 32 | |
33 | - /** |
|
34 | - * (PECL solr >= 0.9.2)<br/> |
|
35 | - * Adds a parameter to the object |
|
36 | - * @link https://php.net/manual/en/solrparams.addparam.php |
|
37 | - * @param string $name <p> |
|
38 | - * The name of the parameter |
|
39 | - * </p> |
|
40 | - * @param string $value <p> |
|
41 | - * The value of the parameter |
|
42 | - * </p> |
|
43 | - * @return SolrParams|false <p> |
|
44 | - * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
45 | - * </p> |
|
46 | - */ |
|
47 | - public function addParam($name, $value) {} |
|
33 | + /** |
|
34 | + * (PECL solr >= 0.9.2)<br/> |
|
35 | + * Adds a parameter to the object |
|
36 | + * @link https://php.net/manual/en/solrparams.addparam.php |
|
37 | + * @param string $name <p> |
|
38 | + * The name of the parameter |
|
39 | + * </p> |
|
40 | + * @param string $value <p> |
|
41 | + * The value of the parameter |
|
42 | + * </p> |
|
43 | + * @return SolrParams|false <p> |
|
44 | + * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
45 | + * </p> |
|
46 | + */ |
|
47 | + public function addParam($name, $value) {} |
|
48 | 48 | |
49 | - /** |
|
50 | - * (PECL solr >= 0.9.2)<br/> |
|
51 | - * This is an alias for SolrParams::getParam |
|
52 | - * @link https://php.net/manual/en/solrparams.get.php |
|
53 | - * @param string $param_name <p> |
|
54 | - * The name of the parameter |
|
55 | - * </p> |
|
56 | - * @return mixed <p> |
|
57 | - * Returns an array or string depending on the type of parameter |
|
58 | - * </p> |
|
59 | - */ |
|
60 | - final public function get($param_name) {} |
|
49 | + /** |
|
50 | + * (PECL solr >= 0.9.2)<br/> |
|
51 | + * This is an alias for SolrParams::getParam |
|
52 | + * @link https://php.net/manual/en/solrparams.get.php |
|
53 | + * @param string $param_name <p> |
|
54 | + * The name of the parameter |
|
55 | + * </p> |
|
56 | + * @return mixed <p> |
|
57 | + * Returns an array or string depending on the type of parameter |
|
58 | + * </p> |
|
59 | + */ |
|
60 | + final public function get($param_name) {} |
|
61 | 61 | |
62 | - /** |
|
63 | - * (PECL solr >= 0.9.2)<br/> |
|
64 | - * Returns a parameter value |
|
65 | - * @link https://php.net/manual/en/solrparams.getparam.php |
|
66 | - * @param string $param_name <p> |
|
67 | - * The name of the parameter |
|
68 | - * </p> |
|
69 | - * @return mixed <p> |
|
70 | - * Returns an array or string depending on the type of parameter |
|
71 | - * </p> |
|
72 | - */ |
|
73 | - final public function getParam($param_name) {} |
|
62 | + /** |
|
63 | + * (PECL solr >= 0.9.2)<br/> |
|
64 | + * Returns a parameter value |
|
65 | + * @link https://php.net/manual/en/solrparams.getparam.php |
|
66 | + * @param string $param_name <p> |
|
67 | + * The name of the parameter |
|
68 | + * </p> |
|
69 | + * @return mixed <p> |
|
70 | + * Returns an array or string depending on the type of parameter |
|
71 | + * </p> |
|
72 | + */ |
|
73 | + final public function getParam($param_name) {} |
|
74 | 74 | |
75 | - /** |
|
76 | - * (PECL solr >= 0.9.2)<br/> |
|
77 | - * Returns an array of non URL-encoded parameters |
|
78 | - * @link https://php.net/manual/en/solrparams.getparams.php |
|
79 | - * @return array <p> |
|
80 | - * Returns an array of non URL-encoded parameters |
|
81 | - * </p> |
|
82 | - */ |
|
83 | - final public function getParams() {} |
|
75 | + /** |
|
76 | + * (PECL solr >= 0.9.2)<br/> |
|
77 | + * Returns an array of non URL-encoded parameters |
|
78 | + * @link https://php.net/manual/en/solrparams.getparams.php |
|
79 | + * @return array <p> |
|
80 | + * Returns an array of non URL-encoded parameters |
|
81 | + * </p> |
|
82 | + */ |
|
83 | + final public function getParams() {} |
|
84 | 84 | |
85 | - /** |
|
86 | - * (PECL solr >= 0.9.2)<br/> |
|
87 | - * Returns an array of URL-encoded parameters |
|
88 | - * @link https://php.net/manual/en/solrparams.getpreparedparams.php |
|
89 | - * @return array <p> |
|
90 | - * Returns an array of URL-encoded parameters |
|
91 | - * </p> |
|
92 | - */ |
|
93 | - final public function getPreparedParams() {} |
|
85 | + /** |
|
86 | + * (PECL solr >= 0.9.2)<br/> |
|
87 | + * Returns an array of URL-encoded parameters |
|
88 | + * @link https://php.net/manual/en/solrparams.getpreparedparams.php |
|
89 | + * @return array <p> |
|
90 | + * Returns an array of URL-encoded parameters |
|
91 | + * </p> |
|
92 | + */ |
|
93 | + final public function getPreparedParams() {} |
|
94 | 94 | |
95 | - /** |
|
96 | - * (PECL solr >= 0.9.2)<br/> |
|
97 | - * Used for custom serialization |
|
98 | - * @link https://php.net/manual/en/solrparams.serialize.php |
|
99 | - * @return string <p> |
|
100 | - * Used for custom serialization |
|
101 | - * </p> |
|
102 | - */ |
|
103 | - final public function serialize() {} |
|
95 | + /** |
|
96 | + * (PECL solr >= 0.9.2)<br/> |
|
97 | + * Used for custom serialization |
|
98 | + * @link https://php.net/manual/en/solrparams.serialize.php |
|
99 | + * @return string <p> |
|
100 | + * Used for custom serialization |
|
101 | + * </p> |
|
102 | + */ |
|
103 | + final public function serialize() {} |
|
104 | 104 | |
105 | - /** |
|
106 | - * (PECL solr >= 0.9.2)<br/> |
|
107 | - * An alias of SolrParams::setParam |
|
108 | - * @link https://php.net/manual/en/solrparams.set.php |
|
109 | - * @param string $name <p> |
|
110 | - * The name of the parameter |
|
111 | - * </p> |
|
112 | - * @param string $value <p> |
|
113 | - * The parameter value |
|
114 | - * </p> |
|
115 | - * @return SolrParams|false <p> |
|
116 | - * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
117 | - * </p> |
|
118 | - */ |
|
119 | - final public function set($name, $value) {} |
|
105 | + /** |
|
106 | + * (PECL solr >= 0.9.2)<br/> |
|
107 | + * An alias of SolrParams::setParam |
|
108 | + * @link https://php.net/manual/en/solrparams.set.php |
|
109 | + * @param string $name <p> |
|
110 | + * The name of the parameter |
|
111 | + * </p> |
|
112 | + * @param string $value <p> |
|
113 | + * The parameter value |
|
114 | + * </p> |
|
115 | + * @return SolrParams|false <p> |
|
116 | + * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
117 | + * </p> |
|
118 | + */ |
|
119 | + final public function set($name, $value) {} |
|
120 | 120 | |
121 | - /** |
|
122 | - * (PECL solr >= 0.9.2)<br/> |
|
123 | - * Sets the parameter to the specified value |
|
124 | - * @link https://php.net/manual/en/solrparams.setparam.php |
|
125 | - * @param string $name <p> |
|
126 | - * The name of the parameter |
|
127 | - * </p> |
|
128 | - * @param string $value <p> |
|
129 | - * The parameter value |
|
130 | - * </p> |
|
131 | - * @return SolrParams|false <p> |
|
132 | - * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
133 | - * </p> |
|
134 | - */ |
|
135 | - public function setParam($name, $value) {} |
|
121 | + /** |
|
122 | + * (PECL solr >= 0.9.2)<br/> |
|
123 | + * Sets the parameter to the specified value |
|
124 | + * @link https://php.net/manual/en/solrparams.setparam.php |
|
125 | + * @param string $name <p> |
|
126 | + * The name of the parameter |
|
127 | + * </p> |
|
128 | + * @param string $value <p> |
|
129 | + * The parameter value |
|
130 | + * </p> |
|
131 | + * @return SolrParams|false <p> |
|
132 | + * Returns a SolrParams instance on success and <b>FALSE</b> on failure. |
|
133 | + * </p> |
|
134 | + */ |
|
135 | + public function setParam($name, $value) {} |
|
136 | 136 | |
137 | - /** |
|
138 | - * (PECL solr >= 0.9.2)<br/> |
|
139 | - * Returns all the name-value pair parameters in the object |
|
140 | - * @link https://php.net/manual/en/solrparams.tostring.php |
|
141 | - * @param bool $url_encode <p> |
|
142 | - * Whether to return URL-encoded values |
|
143 | - * </p> |
|
144 | - * @return string|false <p> |
|
145 | - * Returns a string on success and <b>FALSE</b> on failure. |
|
146 | - * </p> |
|
147 | - */ |
|
148 | - final public function toString($url_encode = false) {} |
|
137 | + /** |
|
138 | + * (PECL solr >= 0.9.2)<br/> |
|
139 | + * Returns all the name-value pair parameters in the object |
|
140 | + * @link https://php.net/manual/en/solrparams.tostring.php |
|
141 | + * @param bool $url_encode <p> |
|
142 | + * Whether to return URL-encoded values |
|
143 | + * </p> |
|
144 | + * @return string|false <p> |
|
145 | + * Returns a string on success and <b>FALSE</b> on failure. |
|
146 | + * </p> |
|
147 | + */ |
|
148 | + final public function toString($url_encode = false) {} |
|
149 | 149 | |
150 | - /** |
|
151 | - * (PECL solr >= 0.9.2)<br/> |
|
152 | - * Used for custom serialization |
|
153 | - * @link https://php.net/manual/en/solrparams.unserialize.php |
|
154 | - * @param string $serialized <p> |
|
155 | - * The serialized representation of the object |
|
156 | - * </p> |
|
157 | - */ |
|
158 | - final public function unserialize($serialized) {} |
|
150 | + /** |
|
151 | + * (PECL solr >= 0.9.2)<br/> |
|
152 | + * Used for custom serialization |
|
153 | + * @link https://php.net/manual/en/solrparams.unserialize.php |
|
154 | + * @param string $serialized <p> |
|
155 | + * The serialized representation of the object |
|
156 | + * </p> |
|
157 | + */ |
|
158 | + final public function unserialize($serialized) {} |
|
159 | 159 | } |
@@ -12,8 +12,7 @@ |
||
12 | 12 | * This class represents a a collection of name-value pairs sent to the Solr server during a request. |
13 | 13 | * @link https://php.net/manual/en/class.solrparams.php |
14 | 14 | */ |
15 | -abstract class SolrParams implements Serializable |
|
16 | -{ |
|
15 | +abstract class SolrParams implements Serializable { |
|
17 | 16 | /** |
18 | 17 | * (PECL solr >= 0.9.2)<br/> |
19 | 18 | * This is an alias for SolrParams::addParam |
@@ -15,62 +15,62 @@ |
||
15 | 15 | */ |
16 | 16 | abstract class SolrUtils |
17 | 17 | { |
18 | - /** |
|
19 | - * (PECL solr >= 0.9.2)<br/> |
|
20 | - * Parses an response XML string into a SolrObject |
|
21 | - * @link https://php.net/manual/en/solrutils.digestxmlresponse.php |
|
22 | - * @param string $xmlresponse <p> |
|
23 | - * The XML response string from the Solr server. |
|
24 | - * </p> |
|
25 | - * @param int $parse_mode [optional] <p> |
|
26 | - * Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC |
|
27 | - * </p> |
|
28 | - * @return SolrObject <p> |
|
29 | - * Returns the SolrObject representing the XML response. |
|
30 | - * </p> |
|
31 | - * <p> |
|
32 | - * If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances. |
|
33 | - * </p> |
|
34 | - * <p> |
|
35 | - * If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances. |
|
36 | - * </p> |
|
37 | - * @throws SolrException |
|
38 | - */ |
|
39 | - public static function digestXmlResponse($xmlresponse, $parse_mode = 0) {} |
|
18 | + /** |
|
19 | + * (PECL solr >= 0.9.2)<br/> |
|
20 | + * Parses an response XML string into a SolrObject |
|
21 | + * @link https://php.net/manual/en/solrutils.digestxmlresponse.php |
|
22 | + * @param string $xmlresponse <p> |
|
23 | + * The XML response string from the Solr server. |
|
24 | + * </p> |
|
25 | + * @param int $parse_mode [optional] <p> |
|
26 | + * Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC |
|
27 | + * </p> |
|
28 | + * @return SolrObject <p> |
|
29 | + * Returns the SolrObject representing the XML response. |
|
30 | + * </p> |
|
31 | + * <p> |
|
32 | + * If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances. |
|
33 | + * </p> |
|
34 | + * <p> |
|
35 | + * If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances. |
|
36 | + * </p> |
|
37 | + * @throws SolrException |
|
38 | + */ |
|
39 | + public static function digestXmlResponse($xmlresponse, $parse_mode = 0) {} |
|
40 | 40 | |
41 | - /** |
|
42 | - * (PECL solr >= 0.9.2)<br/> |
|
43 | - * Escapes a lucene query string |
|
44 | - * @link https://php.net/manual/en/solrutils.escapequerychars.php |
|
45 | - * @param string $str <p> |
|
46 | - * This is the query string to be escaped. |
|
47 | - * </p> |
|
48 | - * @return string|false <p> |
|
49 | - * Returns the escaped string or <b>FALSE</b> on failure. |
|
50 | - * </p> |
|
51 | - */ |
|
52 | - public static function escapeQueryChars($str) {} |
|
41 | + /** |
|
42 | + * (PECL solr >= 0.9.2)<br/> |
|
43 | + * Escapes a lucene query string |
|
44 | + * @link https://php.net/manual/en/solrutils.escapequerychars.php |
|
45 | + * @param string $str <p> |
|
46 | + * This is the query string to be escaped. |
|
47 | + * </p> |
|
48 | + * @return string|false <p> |
|
49 | + * Returns the escaped string or <b>FALSE</b> on failure. |
|
50 | + * </p> |
|
51 | + */ |
|
52 | + public static function escapeQueryChars($str) {} |
|
53 | 53 | |
54 | - /** |
|
55 | - * (PECL solr >= 0.9.2)<br/> |
|
56 | - * Returns the current version of the Solr extension |
|
57 | - * @link https://php.net/manual/en/solrutils.getsolrversion.php |
|
58 | - * @return string <p> |
|
59 | - * The current version of the Apache Solr extension. |
|
60 | - * </p> |
|
61 | - */ |
|
62 | - public static function getSolrVersion() {} |
|
54 | + /** |
|
55 | + * (PECL solr >= 0.9.2)<br/> |
|
56 | + * Returns the current version of the Solr extension |
|
57 | + * @link https://php.net/manual/en/solrutils.getsolrversion.php |
|
58 | + * @return string <p> |
|
59 | + * The current version of the Apache Solr extension. |
|
60 | + * </p> |
|
61 | + */ |
|
62 | + public static function getSolrVersion() {} |
|
63 | 63 | |
64 | - /** |
|
65 | - * (PECL solr >= 0.9.2)<br/> |
|
66 | - * Prepares a phrase from an unescaped lucene string |
|
67 | - * @link https://php.net/manual/en/solrutils.queryphrase.php |
|
68 | - * @param string $str <p> |
|
69 | - * The lucene phrase. |
|
70 | - * </p> |
|
71 | - * @return string <p> |
|
72 | - * Returns the phrase contained in double quotes. |
|
73 | - * </p> |
|
74 | - */ |
|
75 | - public static function queryPhrase($str) {} |
|
64 | + /** |
|
65 | + * (PECL solr >= 0.9.2)<br/> |
|
66 | + * Prepares a phrase from an unescaped lucene string |
|
67 | + * @link https://php.net/manual/en/solrutils.queryphrase.php |
|
68 | + * @param string $str <p> |
|
69 | + * The lucene phrase. |
|
70 | + * </p> |
|
71 | + * @return string <p> |
|
72 | + * Returns the phrase contained in double quotes. |
|
73 | + * </p> |
|
74 | + */ |
|
75 | + public static function queryPhrase($str) {} |
|
76 | 76 | } |
@@ -13,8 +13,7 @@ |
||
13 | 13 | * Also contains method for escaping query strings and parsing XML responses. |
14 | 14 | * @link https://php.net/manual/en/class.solrutils.php |
15 | 15 | */ |
16 | -abstract class SolrUtils |
|
17 | -{ |
|
16 | +abstract class SolrUtils { |
|
18 | 17 | /** |
19 | 18 | * (PECL solr >= 0.9.2)<br/> |
20 | 19 | * Parses an response XML string into a SolrObject |
@@ -15,77 +15,77 @@ |
||
15 | 15 | */ |
16 | 16 | final class SolrObject implements ArrayAccess |
17 | 17 | { |
18 | - /** |
|
19 | - * (PECL solr >= 0.9.2)<br/> |
|
20 | - * SolrObject constructor. |
|
21 | - * @link https://php.net/manual/en/solrobject.construct.php |
|
22 | - */ |
|
23 | - public function __construct() {} |
|
18 | + /** |
|
19 | + * (PECL solr >= 0.9.2)<br/> |
|
20 | + * SolrObject constructor. |
|
21 | + * @link https://php.net/manual/en/solrobject.construct.php |
|
22 | + */ |
|
23 | + public function __construct() {} |
|
24 | 24 | |
25 | - /** |
|
26 | - * (PECL solr >= 0.9.2)<br/> |
|
27 | - * Destructor |
|
28 | - * @link https://php.net/manual/en/solrobject.destruct.php |
|
29 | - */ |
|
30 | - public function __destruct() {} |
|
25 | + /** |
|
26 | + * (PECL solr >= 0.9.2)<br/> |
|
27 | + * Destructor |
|
28 | + * @link https://php.net/manual/en/solrobject.destruct.php |
|
29 | + */ |
|
30 | + public function __destruct() {} |
|
31 | 31 | |
32 | - /** |
|
33 | - * (PECL solr >= 0.9.2)<br/> |
|
34 | - * Returns an array of all the names of the properties |
|
35 | - * @link https://php.net/manual/en/solrobject.getpropertynames.php |
|
36 | - * @return array <p> |
|
37 | - * Returns an array. |
|
38 | - * </p> |
|
39 | - */ |
|
40 | - public function getPropertyNames() {} |
|
32 | + /** |
|
33 | + * (PECL solr >= 0.9.2)<br/> |
|
34 | + * Returns an array of all the names of the properties |
|
35 | + * @link https://php.net/manual/en/solrobject.getpropertynames.php |
|
36 | + * @return array <p> |
|
37 | + * Returns an array. |
|
38 | + * </p> |
|
39 | + */ |
|
40 | + public function getPropertyNames() {} |
|
41 | 41 | |
42 | - /** |
|
43 | - * (PECL solr >= 0.9.2)<br/> |
|
44 | - * Checks if the property exists |
|
45 | - * @link https://php.net/manual/en/solrobject.offsetexists.php |
|
46 | - * @param string $property_name <p> |
|
47 | - * The name of the property. |
|
48 | - * </p> |
|
49 | - * @return bool <p> |
|
50 | - * Returns <b>TRUE</b> on success or <b>FALSE</b> on failure. |
|
51 | - * </p> |
|
52 | - */ |
|
53 | - public function offsetExists($property_name) {} |
|
42 | + /** |
|
43 | + * (PECL solr >= 0.9.2)<br/> |
|
44 | + * Checks if the property exists |
|
45 | + * @link https://php.net/manual/en/solrobject.offsetexists.php |
|
46 | + * @param string $property_name <p> |
|
47 | + * The name of the property. |
|
48 | + * </p> |
|
49 | + * @return bool <p> |
|
50 | + * Returns <b>TRUE</b> on success or <b>FALSE</b> on failure. |
|
51 | + * </p> |
|
52 | + */ |
|
53 | + public function offsetExists($property_name) {} |
|
54 | 54 | |
55 | - /** |
|
56 | - * (PECL solr >= 0.9.2)<br/> |
|
57 | - * Used to retrieve a property |
|
58 | - * @link https://php.net/manual/en/solrobject.offsetget.php |
|
59 | - * @param string $property_name <p> |
|
60 | - * The name of the property. |
|
61 | - * </p> |
|
62 | - * @return SolrDocumentField <p> |
|
63 | - * Returns the property value. |
|
64 | - * </p> |
|
65 | - */ |
|
66 | - public function offsetGet($property_name) {} |
|
55 | + /** |
|
56 | + * (PECL solr >= 0.9.2)<br/> |
|
57 | + * Used to retrieve a property |
|
58 | + * @link https://php.net/manual/en/solrobject.offsetget.php |
|
59 | + * @param string $property_name <p> |
|
60 | + * The name of the property. |
|
61 | + * </p> |
|
62 | + * @return SolrDocumentField <p> |
|
63 | + * Returns the property value. |
|
64 | + * </p> |
|
65 | + */ |
|
66 | + public function offsetGet($property_name) {} |
|
67 | 67 | |
68 | - /** |
|
69 | - * (PECL solr >= 0.9.2)<br/> |
|
70 | - * Sets the value for a property |
|
71 | - * @link https://php.net/manual/en/solrobject.offsetset.php |
|
72 | - * @param string $property_name <p> |
|
73 | - * The name of the property. |
|
74 | - * </p> |
|
75 | - * @param string $property_value <p> |
|
76 | - * The new value. |
|
77 | - * </p> |
|
78 | - */ |
|
79 | - public function offsetSet($property_name, $property_value) {} |
|
68 | + /** |
|
69 | + * (PECL solr >= 0.9.2)<br/> |
|
70 | + * Sets the value for a property |
|
71 | + * @link https://php.net/manual/en/solrobject.offsetset.php |
|
72 | + * @param string $property_name <p> |
|
73 | + * The name of the property. |
|
74 | + * </p> |
|
75 | + * @param string $property_value <p> |
|
76 | + * The new value. |
|
77 | + * </p> |
|
78 | + */ |
|
79 | + public function offsetSet($property_name, $property_value) {} |
|
80 | 80 | |
81 | - /** |
|
82 | - * (PECL solr >= 0.9.2)<br/> |
|
83 | - * Unsets the value for the property |
|
84 | - * @link https://php.net/manual/en/solrobject.offsetunset.php |
|
85 | - * @param string $property_name <p> |
|
86 | - * The name of the property. |
|
87 | - * </p> |
|
88 | - * @return bool |
|
89 | - */ |
|
90 | - public function offsetUnset($property_name) {} |
|
81 | + /** |
|
82 | + * (PECL solr >= 0.9.2)<br/> |
|
83 | + * Unsets the value for the property |
|
84 | + * @link https://php.net/manual/en/solrobject.offsetunset.php |
|
85 | + * @param string $property_name <p> |
|
86 | + * The name of the property. |
|
87 | + * </p> |
|
88 | + * @return bool |
|
89 | + */ |
|
90 | + public function offsetUnset($property_name) {} |
|
91 | 91 | } |
@@ -13,8 +13,7 @@ |
||
13 | 13 | * read-only. |
14 | 14 | * @link https://php.net/manual/en/class.solrobject.php |
15 | 15 | */ |
16 | -final class SolrObject implements ArrayAccess |
|
17 | -{ |
|
16 | +final class SolrObject implements ArrayAccess { |
|
18 | 17 | /** |
19 | 18 | * (PECL solr >= 0.9.2)<br/> |
20 | 19 | * SolrObject constructor. |
@@ -15,483 +15,483 @@ |
||
15 | 15 | */ |
16 | 16 | final class SolrClient |
17 | 17 | { |
18 | - /** @var int Used when updating the search servlet. */ |
|
19 | - public const SEARCH_SERVLET_TYPE = 1; |
|
20 | - |
|
21 | - /** @var int Used when updating the update servlet. */ |
|
22 | - public const UPDATE_SERVLET_TYPE = 2; |
|
23 | - |
|
24 | - /** @var int Used when updating the threads servlet. */ |
|
25 | - public const THREADS_SERVLET_TYPE = 4; |
|
26 | - |
|
27 | - /** @var int Used when updating the ping servlet. */ |
|
28 | - public const PING_SERVLET_TYPE = 8; |
|
29 | - |
|
30 | - /** @var int Used when updating the terms servlet. */ |
|
31 | - public const TERMS_SERVLET_TYPE = 16; |
|
32 | - |
|
33 | - /** @var int Used when retrieving system information from the system servlet. */ |
|
34 | - public const SYSTEM_SERVLET_TYPE = 32; |
|
35 | - |
|
36 | - /** @var string This is the initial value for the search servlet. */ |
|
37 | - public const DEFAULT_SEARCH_SERVLET = 'select'; |
|
38 | - |
|
39 | - /** @var string This is the initial value for the update servlet. */ |
|
40 | - public const DEFAULT_UPDATE_SERVLET = 'update'; |
|
41 | - |
|
42 | - /** @var string This is the initial value for the threads servlet. */ |
|
43 | - public const DEFAULT_THREADS_SERVLET = 'admin/threads'; |
|
44 | - |
|
45 | - /** @var string This is the initial value for the ping servlet. */ |
|
46 | - public const DEFAULT_PING_SERVLET = 'admin/ping'; |
|
47 | - |
|
48 | - /** @var string This is the initial value for the terms servlet used for the TermsComponent. */ |
|
49 | - public const DEFAULT_TERMS_SERVLET = 'terms'; |
|
50 | - |
|
51 | - /** @var string This is the initial value for the system servlet used to obtain Solr Server information. */ |
|
52 | - public const DEFAULT_SYSTEM_SERVLET = 'admin/system'; |
|
53 | - |
|
54 | - /** |
|
55 | - * (PECL solr >= 0.9.2)<br/> |
|
56 | - * Adds a document to the index |
|
57 | - * @link https://php.net/manual/en/solrclient.adddocument.php |
|
58 | - * @param SolrInputDocument $doc <p> |
|
59 | - * The SolrInputDocument instance. |
|
60 | - * </p> |
|
61 | - * @param bool $overwrite [optional] <p> |
|
62 | - * Whether to overwrite existing document or not. If <b>FALSE</b> there will be duplicates (several documents with |
|
63 | - * the same ID). |
|
64 | - * </p> |
|
65 | - * <div> |
|
66 | - * <b>Warning</b><br/> |
|
67 | - * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite |
|
68 | - * bool flag.<br/> |
|
69 | - * <br/> |
|
70 | - * $allowDups = false is the same as $overwrite = true |
|
71 | - * </div> |
|
72 | - * @param int $commitWithin [optional] <p> |
|
73 | - * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means |
|
74 | - * disabled. |
|
75 | - * </p> |
|
76 | - * <p> |
|
77 | - * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of |
|
78 | - * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a |
|
79 | - * commit when the oldest add in the buffer is due. |
|
80 | - * </p> |
|
81 | - * @return SolrUpdateResponse <p> |
|
82 | - * Returns a SolrUpdateResponse object or throws an Exception on failure. |
|
83 | - * </p> |
|
84 | - * @throws SolrClientException <p> |
|
85 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
86 | - * </p> |
|
87 | - * @throws SolrServerException <p> |
|
88 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
89 | - * </p> |
|
90 | - */ |
|
91 | - public function addDocument(SolrInputDocument $doc, $overwrite = true, $commitWithin = 0) {} |
|
92 | - |
|
93 | - /** |
|
94 | - * (PECL solr >= 0.9.2)<br/> |
|
95 | - * Adds a collection of SolrInputDocument instances to the index |
|
96 | - * @link https://php.net/manual/en/solrclient.adddocuments.php |
|
97 | - * @param array $docs <p> |
|
98 | - * An array containing the collection of SolrInputDocument instances. This array must be an actual variable. |
|
99 | - * </p> |
|
100 | - * @param bool $overwrite [optional] <p> |
|
101 | - * Whether to overwrite existing document or not. If <b>FALSE</b> there will be duplicates (several documents with |
|
102 | - * the same ID). |
|
103 | - * </p> |
|
104 | - * <div> |
|
105 | - * <b>Warning</b><br/> |
|
106 | - * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite |
|
107 | - * bool flag.<br/> |
|
108 | - * <br/> |
|
109 | - * $allowDups = false is the same as $overwrite = true |
|
110 | - * </div> |
|
111 | - * @param int $commitWithin [optional] <p> |
|
112 | - * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means |
|
113 | - * disabled. |
|
114 | - * </p> |
|
115 | - * <p> |
|
116 | - * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of |
|
117 | - * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a |
|
118 | - * commit when the oldest add in the buffer is due. |
|
119 | - * </p> |
|
120 | - * @return SolrUpdateResponse <p> |
|
121 | - * Returns a SolrUpdateResponse object or throws an Exception on failure. |
|
122 | - * </p> |
|
123 | - * @throws SolrClientException <p> |
|
124 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
125 | - * </p> |
|
126 | - * @throws SolrServerException <p> |
|
127 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
128 | - * </p> |
|
129 | - */ |
|
130 | - public function addDocuments(array $docs, $overwrite = true, $commitWithin = 0) {} |
|
131 | - |
|
132 | - /** |
|
133 | - * (PECL solr >= 0.9.2)<br/> |
|
134 | - * Finalizes all add/deletes made to the index |
|
135 | - * @link https://php.net/manual/en/solrclient.commit.php |
|
136 | - * @param bool $softCommit [optional] <p> |
|
137 | - * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. |
|
138 | - * (Solr4.0+) |
|
139 | - * </p> |
|
140 | - * <p> |
|
141 | - * A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a |
|
142 | - * new index descriptor. If the JVM crashes or there is a loss of power, changes that occurred after the last hard |
|
143 | - * commit will be lost. Search collections that have near-real-time requirements (that want index changes to be |
|
144 | - * quickly visible to searches) will want to soft commit often but hard commit less frequently. |
|
145 | - * </p> |
|
146 | - * @param bool $waitSearcher [optional] <p> |
|
147 | - * block until a new searcher is opened and registered as the main query searcher, making the changes visible. |
|
148 | - * </p> |
|
149 | - * @param bool $expungeDeletes [optional] <p> |
|
150 | - * Merge segments with deletes away. (Solr1.4+) |
|
151 | - * </p> |
|
152 | - * @return SolrUpdateResponse <p> |
|
153 | - * Returns a SolrUpdateResponse object or throws an Exception on failure. |
|
154 | - * </p> |
|
155 | - * @throws SolrClientException <p> |
|
156 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
157 | - * </p> |
|
158 | - * @throws SolrServerException <p> |
|
159 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
160 | - * </p> |
|
161 | - */ |
|
162 | - public function commit($softCommit = false, $waitSearcher = true, $expungeDeletes = false) {} |
|
163 | - |
|
164 | - /** |
|
165 | - * (PECL solr >= 0.9.2)<br/> |
|
166 | - * SolrClient constructor. |
|
167 | - * @link https://php.net/manual/en/solrclient.construct.php |
|
168 | - * @param array $clientOptions <p> |
|
169 | - * This is an array containing one of the following keys : |
|
170 | - * </p> |
|
171 | - * <ul> |
|
172 | - * <li><b>secure</b>: (Boolean value indicating whether or not to connect in secure mode)</li> |
|
173 | - * <li><b>hostname</b>: (The hostname for the Solr server)</li> |
|
174 | - * <li><b>port</b>: (The port number)</li> |
|
175 | - * <li><b>path</b>: (The path to solr)</li> |
|
176 | - * <li><b>wt</b>: (The name of the response writer e.g. xml, json)</li> |
|
177 | - * <li><b>login</b>: (The username used for HTTP Authentication, if any)</li> |
|
178 | - * <li><b>password</b>: (The HTTP Authentication password)</li> |
|
179 | - * <li><b>proxy_host</b>: (The hostname for the proxy server, if any)</li> |
|
180 | - * <li><b>proxy_port</b>: (The proxy port)</li> |
|
181 | - * <li><b>proxy_login</b>: (The proxy username)</li> |
|
182 | - * <li><b>proxy_password</b>: (The proxy password)</li> |
|
183 | - * <li><b>timeout</b>: (This is maximum time in seconds allowed for the http data transfer operation. Default is 30 |
|
184 | - * seconds)</li> |
|
185 | - * <li><b>ssl_cert</b>: (File name to a PEM-formatted file containing the private key + private certificate |
|
186 | - * (concatenated in that order) )</li> |
|
187 | - * <li><b>ssl_key</b>: (File name to a PEM-formatted private key file only)</li> |
|
188 | - * <li><b>ssl_keypassword</b>: (Password for private key)</li> |
|
189 | - * <li><b>ssl_cainfo</b>: (Name of file holding one or more CA certificates to verify peer with)</li> |
|
190 | - * <li><b>ssl_capath</b>: (Name of directory holding multiple CA certificates to verify peer with )</li> |
|
191 | - * </ul> |
|
192 | - * <p> |
|
193 | - * Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate |
|
194 | - * ssl_key file. |
|
195 | - * </p> |
|
196 | - * <p> |
|
197 | - * The ssl_keypassword option is required if the ssl_cert or ssl_key options are set. |
|
198 | - * </p> |
|
199 | - * @throws SolrIllegalArgumentException |
|
200 | - */ |
|
201 | - public function __construct(array $clientOptions) {} |
|
202 | - |
|
203 | - /** |
|
204 | - * (PECL solr >= 0.9.2)<br/> |
|
205 | - * Delete by Id |
|
206 | - * @link https://php.net/manual/en/solrclient.deletebyid.php |
|
207 | - * @param string $id <p> |
|
208 | - * The value of the uniqueKey field declared in the schema |
|
209 | - * </p> |
|
210 | - * @return SolrUpdateResponse <p> |
|
211 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
212 | - * </p> |
|
213 | - * @throws SolrClientException <p> |
|
214 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
215 | - * </p> |
|
216 | - * @throws SolrServerException <p> |
|
217 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
218 | - * </p> |
|
219 | - */ |
|
220 | - public function deleteById($id) {} |
|
221 | - |
|
222 | - /** |
|
223 | - * (PECL solr >= 0.9.2)<br/> |
|
224 | - * Deletes by Ids |
|
225 | - * @link https://php.net/manual/en/solrclient.deletebyids.php |
|
226 | - * @param array $ids <p> |
|
227 | - * An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This |
|
228 | - * must be an actual php variable. |
|
229 | - * </p> |
|
230 | - * @return SolrUpdateResponse <p> |
|
231 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
232 | - * </p> |
|
233 | - * @throws SolrClientException <p> |
|
234 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
235 | - * </p> |
|
236 | - * @throws SolrServerException <p> |
|
237 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
238 | - * </p> |
|
239 | - */ |
|
240 | - public function deleteByIds(array $ids) {} |
|
241 | - |
|
242 | - /** |
|
243 | - * (PECL solr >= 0.9.2)<br/> |
|
244 | - * Removes all documents matching any of the queries |
|
245 | - * @link https://php.net/manual/en/solrclient.deletebyqueries.php |
|
246 | - * @param array $queries <p> |
|
247 | - * The array of queries. This must be an actual php variable. |
|
248 | - * </p> |
|
249 | - * @return SolrUpdateResponse <p> |
|
250 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
251 | - * </p> |
|
252 | - * @throws SolrClientException <p> |
|
253 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
254 | - * </p> |
|
255 | - * @throws SolrServerException <p> |
|
256 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
257 | - * </p> |
|
258 | - */ |
|
259 | - public function deleteByQueries(array $queries) {} |
|
260 | - |
|
261 | - /** |
|
262 | - * (PECL solr >= 0.9.2)<br/> |
|
263 | - * Deletes all documents matching the given query |
|
264 | - * @link https://php.net/manual/en/solrclient.deletebyquery.php |
|
265 | - * @param string $query <p> |
|
266 | - * The query |
|
267 | - * </p> |
|
268 | - * @return SolrUpdateResponse <p> |
|
269 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
270 | - * </p> |
|
271 | - * @throws SolrClientException <p> |
|
272 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
273 | - * </p> |
|
274 | - * @throws SolrServerException <p> |
|
275 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
276 | - * </p> |
|
277 | - */ |
|
278 | - public function deleteByQuery($query) {} |
|
279 | - |
|
280 | - /** |
|
281 | - * (PECL solr >= 0.9.2)<br/> |
|
282 | - * Destructor for SolrClient |
|
283 | - * @link https://php.net/manual/en/solrclient.destruct.php |
|
284 | - */ |
|
285 | - public function __destruct() {} |
|
286 | - |
|
287 | - /** |
|
288 | - * (PECL solr >= 2.2.0)<br/> |
|
289 | - * Get Document By Id. Utilizes Solr Realtime Get (RTG). |
|
290 | - * @link https://php.net/manual/en/solrclient.getbyid.php |
|
291 | - * @param string $id <p> |
|
292 | - * Document ID |
|
293 | - * </p> |
|
294 | - * @return SolrQueryResponse |
|
295 | - */ |
|
296 | - public function getById($id) {} |
|
297 | - |
|
298 | - /** |
|
299 | - * (PECL solr >= 2.2.0)<br/> |
|
300 | - * Get Documents by their Ids. Utilizes Solr Realtime Get (RTG). |
|
301 | - * @link https://php.net/manual/en/solrclient.getbyids.php |
|
302 | - * @param array $ids <p> |
|
303 | - * Document ids |
|
304 | - * </p> |
|
305 | - * @return SolrQueryResponse |
|
306 | - */ |
|
307 | - public function getByIds(array $ids) {} |
|
308 | - |
|
309 | - /** |
|
310 | - * (PECL solr >= 0.9.7)<br/> |
|
311 | - * Returns the debug data for the last connection attempt |
|
312 | - * @link https://php.net/manual/en/solrclient.getdebug.php |
|
313 | - * @return string <p> |
|
314 | - * Returns a string on success and null if there is nothing to return. |
|
315 | - * </p> |
|
316 | - */ |
|
317 | - public function getDebug() {} |
|
318 | - |
|
319 | - /** |
|
320 | - * (PECL solr >= 0.9.6)<br/> |
|
321 | - * Returns the client options set internally |
|
322 | - * @link https://php.net/manual/en/solrclient.getoptions.php |
|
323 | - * @return array <p> |
|
324 | - * Returns an array containing all the options for the SolrClient object set internally. |
|
325 | - * </p> |
|
326 | - */ |
|
327 | - public function getOptions() {} |
|
328 | - |
|
329 | - /** |
|
330 | - * (PECL solr >= 0.9.2)<br/> |
|
331 | - * Defragments the index |
|
332 | - * @link https://php.net/manual/en/solrclient.optimize.php |
|
333 | - * @param int $maxSegments <p> |
|
334 | - * Optimizes down to at most this number of segments. Since Solr 1.3 |
|
335 | - * </p> |
|
336 | - * @param bool $softCommit <p> |
|
337 | - * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. |
|
338 | - * (Solr4.0+) |
|
339 | - * </p> |
|
340 | - * @param bool $waitSearcher <p> |
|
341 | - * Block until a new searcher is opened and registered as the main query searcher, making the changes visible. |
|
342 | - * </p> |
|
343 | - * @return SolrUpdateResponse <p> |
|
344 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
345 | - * </p> |
|
346 | - * @throws SolrClientException <p> |
|
347 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
348 | - * </p> |
|
349 | - * @throws SolrServerException <p> |
|
350 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
351 | - * </p> |
|
352 | - */ |
|
353 | - public function optimize($maxSegments = 1, $softCommit = true, $waitSearcher = true) {} |
|
354 | - |
|
355 | - /** |
|
356 | - * (PECL solr >= 0.9.2)<br/> |
|
357 | - * Checks if Solr server is still up |
|
358 | - * @link https://php.net/manual/en/solrclient.ping.php |
|
359 | - * @return SolrPingResponse <p> |
|
360 | - * Returns a SolrPingResponse object on success and throws an exception on failure. |
|
361 | - * </p> |
|
362 | - * @throws SolrClientException <p> |
|
363 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
364 | - * </p> |
|
365 | - * @throws SolrServerException <p> |
|
366 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
367 | - * </p> |
|
368 | - */ |
|
369 | - public function ping() {} |
|
370 | - |
|
371 | - /** |
|
372 | - * (PECL solr >= 0.9.2)<br/> |
|
373 | - * Sends a query to the server |
|
374 | - * @link https://php.net/manual/en/solrclient.query.php |
|
375 | - * @param SolrParams $query <p> |
|
376 | - * A SolrParams object. It is recommended to use SolrQuery for advanced queries. |
|
377 | - * </p> |
|
378 | - * @return SolrQueryResponse <p> |
|
379 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
380 | - * </p> |
|
381 | - * @throws SolrClientException <p> |
|
382 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
383 | - * </p> |
|
384 | - * @throws SolrServerException <p> |
|
385 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
386 | - * </p> |
|
387 | - */ |
|
388 | - public function query(SolrParams $query) {} |
|
389 | - |
|
390 | - /** |
|
391 | - * (PECL solr >= 0.9.2)<br/> |
|
392 | - * Sends a raw update request |
|
393 | - * @link https://php.net/manual/en/solrclient.request.php |
|
394 | - * @param string $raw_request <p> |
|
395 | - * An XML string with the raw request to the server. |
|
396 | - * </p> |
|
397 | - * @return SolrUpdateResponse <p> |
|
398 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
399 | - * </p> |
|
400 | - * @throws SolrIllegalArgumentException <p> |
|
401 | - * Throws SolrIllegalArgumentException if raw_request was an empty string. |
|
402 | - * </p> |
|
403 | - * @throws SolrClientException <p> |
|
404 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
405 | - * </p> |
|
406 | - * @throws SolrServerException <p> |
|
407 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
408 | - * </p> |
|
409 | - */ |
|
410 | - public function request($raw_request) {} |
|
411 | - |
|
412 | - /** |
|
413 | - * (PECL solr >= 0.9.2)<br/> |
|
414 | - * Rollbacks all add/deletes made to the index since the last commit |
|
415 | - * @link https://php.net/manual/en/solrclient.rollback.php |
|
416 | - * @return SolrUpdateResponse <p> |
|
417 | - * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
418 | - * </p> |
|
419 | - * @throws SolrClientException <p> |
|
420 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
421 | - * </p> |
|
422 | - * @throws SolrServerException <p> |
|
423 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
424 | - * </p> |
|
425 | - */ |
|
426 | - public function rollback() {} |
|
427 | - |
|
428 | - /** |
|
429 | - * (PECL solr >= 0.9.11)<br/> |
|
430 | - * Sets the response writer used to prepare the response from Solr |
|
431 | - * @link https://php.net/manual/en/solrclient.setresponsewriter.php |
|
432 | - * @param string $responseWriter <p> |
|
433 | - * One of the following: |
|
434 | - * </p> |
|
435 | - * <ul> |
|
436 | - * <li>json</li> |
|
437 | - * <li>phps</li> |
|
438 | - * <li>xml</li> |
|
439 | - * </ul> |
|
440 | - */ |
|
441 | - public function setResponseWriter($responseWriter) {} |
|
442 | - |
|
443 | - /** |
|
444 | - * (PECL solr >= 0.9.2)<br/> |
|
445 | - * Changes the specified servlet type to a new value |
|
446 | - * @link https://php.net/manual/en/solrclient.setservlet.php |
|
447 | - * @param int $type <p> |
|
448 | - * One of the following : |
|
449 | - * </p> |
|
450 | - * <ul> |
|
451 | - * <li>SolrClient::SEARCH_SERVLET_TYPE</li> |
|
452 | - * <li>SolrClient::UPDATE_SERVLET_TYPE</li> |
|
453 | - * <li>SolrClient::THREADS_SERVLET_TYPE</li> |
|
454 | - * <li>SolrClient::PING_SERVLET_TYPE</li> |
|
455 | - * <li>SolrClient::TERMS_SERVLET_TYPE</li> |
|
456 | - * </ul> |
|
457 | - * @param string $value <p> |
|
458 | - * The new value for the servlet |
|
459 | - * </p> |
|
460 | - * @return bool <p> |
|
461 | - * Returns <b>TRUE</b> on success or <b>FALSE</b> on failure. |
|
462 | - * </p> |
|
463 | - */ |
|
464 | - public function setServlet($type, $value) {} |
|
465 | - |
|
466 | - /** |
|
467 | - * (PECL solr >= 2.0.0)<br/> |
|
468 | - * Retrieve Solr Server information |
|
469 | - * @link https://php.net/manual/en/solrclient.system.php |
|
470 | - * @return SolrGenericResponse <p> |
|
471 | - * Returns a SolrGenericResponse object on success. |
|
472 | - * </p> |
|
473 | - * @throws SolrClientException <p> |
|
474 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
475 | - * </p> |
|
476 | - * @throws SolrServerException <p> |
|
477 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
478 | - * </p> |
|
479 | - */ |
|
480 | - public function system() {} |
|
481 | - |
|
482 | - /** |
|
483 | - * (PECL solr >= 0.9.2)<br/> |
|
484 | - * Checks the threads status |
|
485 | - * @link https://php.net/manual/en/solrclient.threads.php |
|
486 | - * @return SolrGenericResponse <p> |
|
487 | - * Returns a SolrGenericResponse object on success. |
|
488 | - * </p> |
|
489 | - * @throws SolrClientException <p> |
|
490 | - * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
491 | - * </p> |
|
492 | - * @throws SolrServerException <p> |
|
493 | - * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
494 | - * </p> |
|
495 | - */ |
|
496 | - public function threads() {} |
|
18 | + /** @var int Used when updating the search servlet. */ |
|
19 | + public const SEARCH_SERVLET_TYPE = 1; |
|
20 | + |
|
21 | + /** @var int Used when updating the update servlet. */ |
|
22 | + public const UPDATE_SERVLET_TYPE = 2; |
|
23 | + |
|
24 | + /** @var int Used when updating the threads servlet. */ |
|
25 | + public const THREADS_SERVLET_TYPE = 4; |
|
26 | + |
|
27 | + /** @var int Used when updating the ping servlet. */ |
|
28 | + public const PING_SERVLET_TYPE = 8; |
|
29 | + |
|
30 | + /** @var int Used when updating the terms servlet. */ |
|
31 | + public const TERMS_SERVLET_TYPE = 16; |
|
32 | + |
|
33 | + /** @var int Used when retrieving system information from the system servlet. */ |
|
34 | + public const SYSTEM_SERVLET_TYPE = 32; |
|
35 | + |
|
36 | + /** @var string This is the initial value for the search servlet. */ |
|
37 | + public const DEFAULT_SEARCH_SERVLET = 'select'; |
|
38 | + |
|
39 | + /** @var string This is the initial value for the update servlet. */ |
|
40 | + public const DEFAULT_UPDATE_SERVLET = 'update'; |
|
41 | + |
|
42 | + /** @var string This is the initial value for the threads servlet. */ |
|
43 | + public const DEFAULT_THREADS_SERVLET = 'admin/threads'; |
|
44 | + |
|
45 | + /** @var string This is the initial value for the ping servlet. */ |
|
46 | + public const DEFAULT_PING_SERVLET = 'admin/ping'; |
|
47 | + |
|
48 | + /** @var string This is the initial value for the terms servlet used for the TermsComponent. */ |
|
49 | + public const DEFAULT_TERMS_SERVLET = 'terms'; |
|
50 | + |
|
51 | + /** @var string This is the initial value for the system servlet used to obtain Solr Server information. */ |
|
52 | + public const DEFAULT_SYSTEM_SERVLET = 'admin/system'; |
|
53 | + |
|
54 | + /** |
|
55 | + * (PECL solr >= 0.9.2)<br/> |
|
56 | + * Adds a document to the index |
|
57 | + * @link https://php.net/manual/en/solrclient.adddocument.php |
|
58 | + * @param SolrInputDocument $doc <p> |
|
59 | + * The SolrInputDocument instance. |
|
60 | + * </p> |
|
61 | + * @param bool $overwrite [optional] <p> |
|
62 | + * Whether to overwrite existing document or not. If <b>FALSE</b> there will be duplicates (several documents with |
|
63 | + * the same ID). |
|
64 | + * </p> |
|
65 | + * <div> |
|
66 | + * <b>Warning</b><br/> |
|
67 | + * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite |
|
68 | + * bool flag.<br/> |
|
69 | + * <br/> |
|
70 | + * $allowDups = false is the same as $overwrite = true |
|
71 | + * </div> |
|
72 | + * @param int $commitWithin [optional] <p> |
|
73 | + * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means |
|
74 | + * disabled. |
|
75 | + * </p> |
|
76 | + * <p> |
|
77 | + * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of |
|
78 | + * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a |
|
79 | + * commit when the oldest add in the buffer is due. |
|
80 | + * </p> |
|
81 | + * @return SolrUpdateResponse <p> |
|
82 | + * Returns a SolrUpdateResponse object or throws an Exception on failure. |
|
83 | + * </p> |
|
84 | + * @throws SolrClientException <p> |
|
85 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
86 | + * </p> |
|
87 | + * @throws SolrServerException <p> |
|
88 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
89 | + * </p> |
|
90 | + */ |
|
91 | + public function addDocument(SolrInputDocument $doc, $overwrite = true, $commitWithin = 0) {} |
|
92 | + |
|
93 | + /** |
|
94 | + * (PECL solr >= 0.9.2)<br/> |
|
95 | + * Adds a collection of SolrInputDocument instances to the index |
|
96 | + * @link https://php.net/manual/en/solrclient.adddocuments.php |
|
97 | + * @param array $docs <p> |
|
98 | + * An array containing the collection of SolrInputDocument instances. This array must be an actual variable. |
|
99 | + * </p> |
|
100 | + * @param bool $overwrite [optional] <p> |
|
101 | + * Whether to overwrite existing document or not. If <b>FALSE</b> there will be duplicates (several documents with |
|
102 | + * the same ID). |
|
103 | + * </p> |
|
104 | + * <div> |
|
105 | + * <b>Warning</b><br/> |
|
106 | + * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite |
|
107 | + * bool flag.<br/> |
|
108 | + * <br/> |
|
109 | + * $allowDups = false is the same as $overwrite = true |
|
110 | + * </div> |
|
111 | + * @param int $commitWithin [optional] <p> |
|
112 | + * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means |
|
113 | + * disabled. |
|
114 | + * </p> |
|
115 | + * <p> |
|
116 | + * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of |
|
117 | + * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a |
|
118 | + * commit when the oldest add in the buffer is due. |
|
119 | + * </p> |
|
120 | + * @return SolrUpdateResponse <p> |
|
121 | + * Returns a SolrUpdateResponse object or throws an Exception on failure. |
|
122 | + * </p> |
|
123 | + * @throws SolrClientException <p> |
|
124 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
125 | + * </p> |
|
126 | + * @throws SolrServerException <p> |
|
127 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
128 | + * </p> |
|
129 | + */ |
|
130 | + public function addDocuments(array $docs, $overwrite = true, $commitWithin = 0) {} |
|
131 | + |
|
132 | + /** |
|
133 | + * (PECL solr >= 0.9.2)<br/> |
|
134 | + * Finalizes all add/deletes made to the index |
|
135 | + * @link https://php.net/manual/en/solrclient.commit.php |
|
136 | + * @param bool $softCommit [optional] <p> |
|
137 | + * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. |
|
138 | + * (Solr4.0+) |
|
139 | + * </p> |
|
140 | + * <p> |
|
141 | + * A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a |
|
142 | + * new index descriptor. If the JVM crashes or there is a loss of power, changes that occurred after the last hard |
|
143 | + * commit will be lost. Search collections that have near-real-time requirements (that want index changes to be |
|
144 | + * quickly visible to searches) will want to soft commit often but hard commit less frequently. |
|
145 | + * </p> |
|
146 | + * @param bool $waitSearcher [optional] <p> |
|
147 | + * block until a new searcher is opened and registered as the main query searcher, making the changes visible. |
|
148 | + * </p> |
|
149 | + * @param bool $expungeDeletes [optional] <p> |
|
150 | + * Merge segments with deletes away. (Solr1.4+) |
|
151 | + * </p> |
|
152 | + * @return SolrUpdateResponse <p> |
|
153 | + * Returns a SolrUpdateResponse object or throws an Exception on failure. |
|
154 | + * </p> |
|
155 | + * @throws SolrClientException <p> |
|
156 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
157 | + * </p> |
|
158 | + * @throws SolrServerException <p> |
|
159 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
160 | + * </p> |
|
161 | + */ |
|
162 | + public function commit($softCommit = false, $waitSearcher = true, $expungeDeletes = false) {} |
|
163 | + |
|
164 | + /** |
|
165 | + * (PECL solr >= 0.9.2)<br/> |
|
166 | + * SolrClient constructor. |
|
167 | + * @link https://php.net/manual/en/solrclient.construct.php |
|
168 | + * @param array $clientOptions <p> |
|
169 | + * This is an array containing one of the following keys : |
|
170 | + * </p> |
|
171 | + * <ul> |
|
172 | + * <li><b>secure</b>: (Boolean value indicating whether or not to connect in secure mode)</li> |
|
173 | + * <li><b>hostname</b>: (The hostname for the Solr server)</li> |
|
174 | + * <li><b>port</b>: (The port number)</li> |
|
175 | + * <li><b>path</b>: (The path to solr)</li> |
|
176 | + * <li><b>wt</b>: (The name of the response writer e.g. xml, json)</li> |
|
177 | + * <li><b>login</b>: (The username used for HTTP Authentication, if any)</li> |
|
178 | + * <li><b>password</b>: (The HTTP Authentication password)</li> |
|
179 | + * <li><b>proxy_host</b>: (The hostname for the proxy server, if any)</li> |
|
180 | + * <li><b>proxy_port</b>: (The proxy port)</li> |
|
181 | + * <li><b>proxy_login</b>: (The proxy username)</li> |
|
182 | + * <li><b>proxy_password</b>: (The proxy password)</li> |
|
183 | + * <li><b>timeout</b>: (This is maximum time in seconds allowed for the http data transfer operation. Default is 30 |
|
184 | + * seconds)</li> |
|
185 | + * <li><b>ssl_cert</b>: (File name to a PEM-formatted file containing the private key + private certificate |
|
186 | + * (concatenated in that order) )</li> |
|
187 | + * <li><b>ssl_key</b>: (File name to a PEM-formatted private key file only)</li> |
|
188 | + * <li><b>ssl_keypassword</b>: (Password for private key)</li> |
|
189 | + * <li><b>ssl_cainfo</b>: (Name of file holding one or more CA certificates to verify peer with)</li> |
|
190 | + * <li><b>ssl_capath</b>: (Name of directory holding multiple CA certificates to verify peer with )</li> |
|
191 | + * </ul> |
|
192 | + * <p> |
|
193 | + * Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate |
|
194 | + * ssl_key file. |
|
195 | + * </p> |
|
196 | + * <p> |
|
197 | + * The ssl_keypassword option is required if the ssl_cert or ssl_key options are set. |
|
198 | + * </p> |
|
199 | + * @throws SolrIllegalArgumentException |
|
200 | + */ |
|
201 | + public function __construct(array $clientOptions) {} |
|
202 | + |
|
203 | + /** |
|
204 | + * (PECL solr >= 0.9.2)<br/> |
|
205 | + * Delete by Id |
|
206 | + * @link https://php.net/manual/en/solrclient.deletebyid.php |
|
207 | + * @param string $id <p> |
|
208 | + * The value of the uniqueKey field declared in the schema |
|
209 | + * </p> |
|
210 | + * @return SolrUpdateResponse <p> |
|
211 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
212 | + * </p> |
|
213 | + * @throws SolrClientException <p> |
|
214 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
215 | + * </p> |
|
216 | + * @throws SolrServerException <p> |
|
217 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
218 | + * </p> |
|
219 | + */ |
|
220 | + public function deleteById($id) {} |
|
221 | + |
|
222 | + /** |
|
223 | + * (PECL solr >= 0.9.2)<br/> |
|
224 | + * Deletes by Ids |
|
225 | + * @link https://php.net/manual/en/solrclient.deletebyids.php |
|
226 | + * @param array $ids <p> |
|
227 | + * An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This |
|
228 | + * must be an actual php variable. |
|
229 | + * </p> |
|
230 | + * @return SolrUpdateResponse <p> |
|
231 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
232 | + * </p> |
|
233 | + * @throws SolrClientException <p> |
|
234 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
235 | + * </p> |
|
236 | + * @throws SolrServerException <p> |
|
237 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
238 | + * </p> |
|
239 | + */ |
|
240 | + public function deleteByIds(array $ids) {} |
|
241 | + |
|
242 | + /** |
|
243 | + * (PECL solr >= 0.9.2)<br/> |
|
244 | + * Removes all documents matching any of the queries |
|
245 | + * @link https://php.net/manual/en/solrclient.deletebyqueries.php |
|
246 | + * @param array $queries <p> |
|
247 | + * The array of queries. This must be an actual php variable. |
|
248 | + * </p> |
|
249 | + * @return SolrUpdateResponse <p> |
|
250 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
251 | + * </p> |
|
252 | + * @throws SolrClientException <p> |
|
253 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
254 | + * </p> |
|
255 | + * @throws SolrServerException <p> |
|
256 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
257 | + * </p> |
|
258 | + */ |
|
259 | + public function deleteByQueries(array $queries) {} |
|
260 | + |
|
261 | + /** |
|
262 | + * (PECL solr >= 0.9.2)<br/> |
|
263 | + * Deletes all documents matching the given query |
|
264 | + * @link https://php.net/manual/en/solrclient.deletebyquery.php |
|
265 | + * @param string $query <p> |
|
266 | + * The query |
|
267 | + * </p> |
|
268 | + * @return SolrUpdateResponse <p> |
|
269 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
270 | + * </p> |
|
271 | + * @throws SolrClientException <p> |
|
272 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
273 | + * </p> |
|
274 | + * @throws SolrServerException <p> |
|
275 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
276 | + * </p> |
|
277 | + */ |
|
278 | + public function deleteByQuery($query) {} |
|
279 | + |
|
280 | + /** |
|
281 | + * (PECL solr >= 0.9.2)<br/> |
|
282 | + * Destructor for SolrClient |
|
283 | + * @link https://php.net/manual/en/solrclient.destruct.php |
|
284 | + */ |
|
285 | + public function __destruct() {} |
|
286 | + |
|
287 | + /** |
|
288 | + * (PECL solr >= 2.2.0)<br/> |
|
289 | + * Get Document By Id. Utilizes Solr Realtime Get (RTG). |
|
290 | + * @link https://php.net/manual/en/solrclient.getbyid.php |
|
291 | + * @param string $id <p> |
|
292 | + * Document ID |
|
293 | + * </p> |
|
294 | + * @return SolrQueryResponse |
|
295 | + */ |
|
296 | + public function getById($id) {} |
|
297 | + |
|
298 | + /** |
|
299 | + * (PECL solr >= 2.2.0)<br/> |
|
300 | + * Get Documents by their Ids. Utilizes Solr Realtime Get (RTG). |
|
301 | + * @link https://php.net/manual/en/solrclient.getbyids.php |
|
302 | + * @param array $ids <p> |
|
303 | + * Document ids |
|
304 | + * </p> |
|
305 | + * @return SolrQueryResponse |
|
306 | + */ |
|
307 | + public function getByIds(array $ids) {} |
|
308 | + |
|
309 | + /** |
|
310 | + * (PECL solr >= 0.9.7)<br/> |
|
311 | + * Returns the debug data for the last connection attempt |
|
312 | + * @link https://php.net/manual/en/solrclient.getdebug.php |
|
313 | + * @return string <p> |
|
314 | + * Returns a string on success and null if there is nothing to return. |
|
315 | + * </p> |
|
316 | + */ |
|
317 | + public function getDebug() {} |
|
318 | + |
|
319 | + /** |
|
320 | + * (PECL solr >= 0.9.6)<br/> |
|
321 | + * Returns the client options set internally |
|
322 | + * @link https://php.net/manual/en/solrclient.getoptions.php |
|
323 | + * @return array <p> |
|
324 | + * Returns an array containing all the options for the SolrClient object set internally. |
|
325 | + * </p> |
|
326 | + */ |
|
327 | + public function getOptions() {} |
|
328 | + |
|
329 | + /** |
|
330 | + * (PECL solr >= 0.9.2)<br/> |
|
331 | + * Defragments the index |
|
332 | + * @link https://php.net/manual/en/solrclient.optimize.php |
|
333 | + * @param int $maxSegments <p> |
|
334 | + * Optimizes down to at most this number of segments. Since Solr 1.3 |
|
335 | + * </p> |
|
336 | + * @param bool $softCommit <p> |
|
337 | + * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. |
|
338 | + * (Solr4.0+) |
|
339 | + * </p> |
|
340 | + * @param bool $waitSearcher <p> |
|
341 | + * Block until a new searcher is opened and registered as the main query searcher, making the changes visible. |
|
342 | + * </p> |
|
343 | + * @return SolrUpdateResponse <p> |
|
344 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
345 | + * </p> |
|
346 | + * @throws SolrClientException <p> |
|
347 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
348 | + * </p> |
|
349 | + * @throws SolrServerException <p> |
|
350 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
351 | + * </p> |
|
352 | + */ |
|
353 | + public function optimize($maxSegments = 1, $softCommit = true, $waitSearcher = true) {} |
|
354 | + |
|
355 | + /** |
|
356 | + * (PECL solr >= 0.9.2)<br/> |
|
357 | + * Checks if Solr server is still up |
|
358 | + * @link https://php.net/manual/en/solrclient.ping.php |
|
359 | + * @return SolrPingResponse <p> |
|
360 | + * Returns a SolrPingResponse object on success and throws an exception on failure. |
|
361 | + * </p> |
|
362 | + * @throws SolrClientException <p> |
|
363 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
364 | + * </p> |
|
365 | + * @throws SolrServerException <p> |
|
366 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
367 | + * </p> |
|
368 | + */ |
|
369 | + public function ping() {} |
|
370 | + |
|
371 | + /** |
|
372 | + * (PECL solr >= 0.9.2)<br/> |
|
373 | + * Sends a query to the server |
|
374 | + * @link https://php.net/manual/en/solrclient.query.php |
|
375 | + * @param SolrParams $query <p> |
|
376 | + * A SolrParams object. It is recommended to use SolrQuery for advanced queries. |
|
377 | + * </p> |
|
378 | + * @return SolrQueryResponse <p> |
|
379 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
380 | + * </p> |
|
381 | + * @throws SolrClientException <p> |
|
382 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
383 | + * </p> |
|
384 | + * @throws SolrServerException <p> |
|
385 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
386 | + * </p> |
|
387 | + */ |
|
388 | + public function query(SolrParams $query) {} |
|
389 | + |
|
390 | + /** |
|
391 | + * (PECL solr >= 0.9.2)<br/> |
|
392 | + * Sends a raw update request |
|
393 | + * @link https://php.net/manual/en/solrclient.request.php |
|
394 | + * @param string $raw_request <p> |
|
395 | + * An XML string with the raw request to the server. |
|
396 | + * </p> |
|
397 | + * @return SolrUpdateResponse <p> |
|
398 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
399 | + * </p> |
|
400 | + * @throws SolrIllegalArgumentException <p> |
|
401 | + * Throws SolrIllegalArgumentException if raw_request was an empty string. |
|
402 | + * </p> |
|
403 | + * @throws SolrClientException <p> |
|
404 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
405 | + * </p> |
|
406 | + * @throws SolrServerException <p> |
|
407 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
408 | + * </p> |
|
409 | + */ |
|
410 | + public function request($raw_request) {} |
|
411 | + |
|
412 | + /** |
|
413 | + * (PECL solr >= 0.9.2)<br/> |
|
414 | + * Rollbacks all add/deletes made to the index since the last commit |
|
415 | + * @link https://php.net/manual/en/solrclient.rollback.php |
|
416 | + * @return SolrUpdateResponse <p> |
|
417 | + * Returns a SolrUpdateResponse on success and throws an exception on failure. |
|
418 | + * </p> |
|
419 | + * @throws SolrClientException <p> |
|
420 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
421 | + * </p> |
|
422 | + * @throws SolrServerException <p> |
|
423 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
424 | + * </p> |
|
425 | + */ |
|
426 | + public function rollback() {} |
|
427 | + |
|
428 | + /** |
|
429 | + * (PECL solr >= 0.9.11)<br/> |
|
430 | + * Sets the response writer used to prepare the response from Solr |
|
431 | + * @link https://php.net/manual/en/solrclient.setresponsewriter.php |
|
432 | + * @param string $responseWriter <p> |
|
433 | + * One of the following: |
|
434 | + * </p> |
|
435 | + * <ul> |
|
436 | + * <li>json</li> |
|
437 | + * <li>phps</li> |
|
438 | + * <li>xml</li> |
|
439 | + * </ul> |
|
440 | + */ |
|
441 | + public function setResponseWriter($responseWriter) {} |
|
442 | + |
|
443 | + /** |
|
444 | + * (PECL solr >= 0.9.2)<br/> |
|
445 | + * Changes the specified servlet type to a new value |
|
446 | + * @link https://php.net/manual/en/solrclient.setservlet.php |
|
447 | + * @param int $type <p> |
|
448 | + * One of the following : |
|
449 | + * </p> |
|
450 | + * <ul> |
|
451 | + * <li>SolrClient::SEARCH_SERVLET_TYPE</li> |
|
452 | + * <li>SolrClient::UPDATE_SERVLET_TYPE</li> |
|
453 | + * <li>SolrClient::THREADS_SERVLET_TYPE</li> |
|
454 | + * <li>SolrClient::PING_SERVLET_TYPE</li> |
|
455 | + * <li>SolrClient::TERMS_SERVLET_TYPE</li> |
|
456 | + * </ul> |
|
457 | + * @param string $value <p> |
|
458 | + * The new value for the servlet |
|
459 | + * </p> |
|
460 | + * @return bool <p> |
|
461 | + * Returns <b>TRUE</b> on success or <b>FALSE</b> on failure. |
|
462 | + * </p> |
|
463 | + */ |
|
464 | + public function setServlet($type, $value) {} |
|
465 | + |
|
466 | + /** |
|
467 | + * (PECL solr >= 2.0.0)<br/> |
|
468 | + * Retrieve Solr Server information |
|
469 | + * @link https://php.net/manual/en/solrclient.system.php |
|
470 | + * @return SolrGenericResponse <p> |
|
471 | + * Returns a SolrGenericResponse object on success. |
|
472 | + * </p> |
|
473 | + * @throws SolrClientException <p> |
|
474 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
475 | + * </p> |
|
476 | + * @throws SolrServerException <p> |
|
477 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
478 | + * </p> |
|
479 | + */ |
|
480 | + public function system() {} |
|
481 | + |
|
482 | + /** |
|
483 | + * (PECL solr >= 0.9.2)<br/> |
|
484 | + * Checks the threads status |
|
485 | + * @link https://php.net/manual/en/solrclient.threads.php |
|
486 | + * @return SolrGenericResponse <p> |
|
487 | + * Returns a SolrGenericResponse object on success. |
|
488 | + * </p> |
|
489 | + * @throws SolrClientException <p> |
|
490 | + * Throws SolrClientException if the client had failed, or there was a connection issue. |
|
491 | + * </p> |
|
492 | + * @throws SolrServerException <p> |
|
493 | + * Throws SolrServerException if the Solr Server had failed to satisfy the request. |
|
494 | + * </p> |
|
495 | + */ |
|
496 | + public function threads() {} |
|
497 | 497 | } |
@@ -13,8 +13,7 @@ |
||
13 | 13 | * not supported. |
14 | 14 | * @link https://php.net/manual/en/class.solrclient.php |
15 | 15 | */ |
16 | -final class SolrClient |
|
17 | -{ |
|
16 | +final class SolrClient { |
|
18 | 17 | /** @var int Used when updating the search servlet. */ |
19 | 18 | public const SEARCH_SERVLET_TYPE = 1; |
20 | 19 |