/
AbstractQuery.php
238 lines (216 loc) · 5.97 KB
/
AbstractQuery.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<?php
/**
* Copyright 2011 Bas de Nooijer. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this listof conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of the copyright holder.
*
* @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
* @license http://github.com/basdenooijer/solarium/raw/master/COPYING
*
* @link http://www.solarium-project.org/
*/
/**
* @namespace
*/
namespace Solarium\Core\Query;
use Solarium\Core\Configurable;
/**
* Base class for all query types, not intended for direct usage.
*/
abstract class AbstractQuery extends Configurable implements QueryInterface
{
const WT_JSON = 'json';
const WT_PHPS = 'phps';
/**
* Helper instance.
*
* @var Helper
*/
protected $helper;
/**
* Extra query params (e.g. dereferenced params).
*
* @var array
*/
protected $params = array();
/**
* Set handler option.
*
* @param string $handler
*
* @return self Provides fluent interface
*/
public function setHandler($handler)
{
return $this->setOption('handler', $handler);
}
/**
* Get handler option.
*
* @return string
*/
public function getHandler()
{
return $this->getOption('handler');
}
/**
* Set resultclass option.
*
* If you set a custom result class it must be available through autoloading
* or a manual require before calling this method. This is your
* responsibility.
*
* Also you need to make sure it extends the orginal result class of the
* query or has an identical API.
*
* @param string $classname
*
* @return self Provides fluent interface
*/
public function setResultClass($classname)
{
return $this->setOption('resultclass', $classname);
}
/**
* Get resultclass option.
*
* @return string
*/
public function getResultClass()
{
return $this->getOption('resultclass');
}
/**
* Set timeAllowed option.
*
* @param int $value
*
* @return self Provides fluent interface
*/
public function setTimeAllowed($value)
{
return $this->setOption('timeallowed', $value);
}
/**
* Get timeAllowed option.
*
* @return int|null
*/
public function getTimeAllowed()
{
return $this->getOption('timeallowed');
}
/**
* Set omitHeader option.
*
* @param boolean $value
*
* @return self Provides fluent interface
*/
public function setOmitHeader($value)
{
return $this->setOption('omitheader', $value);
}
/**
* Get omitHeader option.
*
* @return boolean
*/
public function getOmitHeader()
{
return $this->getOption('omitheader');
}
/**
* Get a helper instance.
*
* Uses lazy loading: the helper is instantiated on first use
*
* @return Helper
*/
public function getHelper()
{
if (null === $this->helper) {
$this->helper = new Helper($this);
}
return $this->helper;
}
/**
* Add extra params to the request.
*
* Only intended for internal use, for instance with dereferenced params.
* Therefore the params are limited in functionality. Only add and get
*
* @param string $name
* @param string $value
*
* @return self Provides fluent interface
*/
public function addParam($name, $value)
{
$this->params[$name] = $value;
return $this;
}
/**
* Get extra params.
*
* @return array
*/
public function getParams()
{
return $this->params;
}
/**
* Set responsewriter option.
*
* @param string $value
*
* @return self Provides fluent interface
*/
public function setResponseWriter($value)
{
return $this->setOption('responsewriter', $value);
}
/**
* Get responsewriter option.
*
* Defaults to json for backwards compatibility and security.
*
* If you can fully trust the Solr responses (phps has a security risk from untrusted sources) you might consider
* setting the responsewriter to 'phps' (serialized php). This can give a performance advantage,
* especially with big resultsets.
*
* @return string
*/
public function getResponseWriter()
{
$responseWriter = $this->getOption('responsewriter');
if ($responseWriter === null) {
$responseWriter = self::WT_JSON;
}
return $responseWriter;
}
}