/
RequestBuilder.php
284 lines (256 loc) · 8.59 KB
/
RequestBuilder.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<?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\QueryType\Update;
use Solarium\Core\Client\Request;
use Solarium\QueryType\Update\Query\Query as UpdateQuery;
use Solarium\Core\Query\AbstractRequestBuilder as BaseRequestBuilder;
use Solarium\Core\Query\QueryInterface;
use Solarium\Exception\RuntimeException;
/**
* Build an update request.
*/
class RequestBuilder extends BaseRequestBuilder
{
/**
* Build request for an update query.
*
* @param QueryInterface|UpdateQuery $query
*
* @return Request
*/
public function build(QueryInterface $query)
{
$request = parent::build($query);
$request->setMethod(Request::METHOD_POST);
$request->setRawData($this->getRawData($query));
return $request;
}
/**
* Generates raw POST data.
*
* Each commandtype is delegated to a separate builder method.
*
* @param UpdateQuery $query
*
* @throws RuntimeException
*
* @return string
*/
public function getRawData($query)
{
$xml = '<update>';
foreach ($query->getCommands() as $command) {
switch ($command->getType()) {
case UpdateQuery::COMMAND_ADD:
$xml .= $this->buildAddXml($command, $query);
break;
case UpdateQuery::COMMAND_DELETE:
$xml .= $this->buildDeleteXml($command);
break;
case UpdateQuery::COMMAND_OPTIMIZE:
$xml .= $this->buildOptimizeXml($command);
break;
case UpdateQuery::COMMAND_COMMIT:
$xml .= $this->buildCommitXml($command);
break;
case UpdateQuery::COMMAND_ROLLBACK:
$xml .= $this->buildRollbackXml();
break;
default:
throw new RuntimeException('Unsupported command type');
break;
}
}
$xml .= '</update>';
return $xml;
}
/**
* Build XML for an add command.
*
* @param \Solarium\QueryType\Update\Query\Command\Add $command
* @param UpdateQuery $query
*
* @return string
*/
public function buildAddXml($command, $query = null)
{
$xml = '<add';
$xml .= $this->boolAttrib('overwrite', $command->getOverwrite());
$xml .= $this->attrib('commitWithin', $command->getCommitWithin());
$xml .= '>';
foreach ($command->getDocuments() as $doc) {
$xml .= '<doc';
$xml .= $this->attrib('boost', $doc->getBoost());
$xml .= '>';
foreach ($doc->getFields() as $name => $value) {
$boost = $doc->getFieldBoost($name);
$modifier = $doc->getFieldModifier($name);
$xml .= $this->buildFieldsXml($name, $boost, $value, $modifier, $query);
}
$version = $doc->getVersion();
if ($version !== null) {
$xml .= $this->buildFieldXml('_version_', null, $version);
}
$xml .= '</doc>';
}
$xml .= '</add>';
return $xml;
}
/**
* Build XML for a delete command.
*
* @param \Solarium\QueryType\Update\Query\Command\Delete $command
*
* @return string
*/
public function buildDeleteXml($command)
{
$xml = '<delete>';
foreach ($command->getIds() as $id) {
$xml .= '<id>' . htmlspecialchars($id, ENT_NOQUOTES, 'UTF-8') . '</id>';
}
foreach ($command->getQueries() as $query) {
$xml .= '<query>' . htmlspecialchars($query, ENT_NOQUOTES, 'UTF-8') . '</query>';
}
$xml .= '</delete>';
return $xml;
}
/**
* Build XML for an update command.
*
* @param \Solarium\QueryType\Update\Query\Command\Optimize $command
*
* @return string
*/
public function buildOptimizeXml($command)
{
$xml = '<optimize';
$xml .= $this->boolAttrib('softCommit', $command->getSoftCommit());
$xml .= $this->boolAttrib('waitSearcher', $command->getWaitSearcher());
$xml .= $this->attrib('maxSegments', $command->getMaxSegments());
$xml .= '/>';
return $xml;
}
/**
* Build XML for a commit command.
*
* @param \Solarium\QueryType\Update\Query\Command\Commit $command
*
* @return string
*/
public function buildCommitXml($command)
{
$xml = '<commit';
$xml .= $this->boolAttrib('softCommit', $command->getSoftCommit());
$xml .= $this->boolAttrib('waitSearcher', $command->getWaitSearcher());
$xml .= $this->boolAttrib('expungeDeletes', $command->getExpungeDeletes());
$xml .= '/>';
return $xml;
}
/**
* Build XMl for a rollback command.
*
* @return string
*/
public function buildRollbackXml()
{
return '<rollback/>';
}
/**
* Build XML for a field.
*
* Used in the add command
*
* @param string $name
* @param float $boost
* @param mixed $value
* @param string $modifier
* @param UpdateQuery $query
*
* @return string
*/
protected function buildFieldXml($name, $boost, $value, $modifier = null, $query = null)
{
$xml = '<field name="' . $name . '"';
$xml .= $this->attrib('boost', $boost);
$xml .= $this->attrib('update', $modifier);
if ($value === null) {
$xml .= $this->attrib('null', 'true');
} elseif ($value === false) {
$value = 'false';
} elseif ($value === true) {
$value = 'true';
} elseif ($value instanceof \DateTime) {
$value = $query->getHelper()->formatDate($value);
} else {
$value = htmlspecialchars($value, ENT_NOQUOTES, 'UTF-8');
}
$xml .= '>' . $value . '</field>';
return $xml;
}
/**
* @param string $key
*
* @param float $boost
* @param mixed $value
* @param string $modifier
* @param UpdateQuery $query
* @return string
*/
private function buildFieldsXml($key, $boost, $value, $modifier, $query)
{
$xml = '';
if (is_array($value)) {
foreach ($value as $multival) {
if (is_array($multival)) {
$xml .= '<doc>';
foreach ($multival as $k => $v) {
$xml .= $this->buildFieldsXml($k, $boost, $v, $modifier, $query);
}
$xml .= '</doc>';
} else {
$xml .= $this->buildFieldXml($key, $boost, $multival, $modifier, $query);
}
}
} else {
$xml .= $this->buildFieldXml($key, $boost, $value, $modifier, $query);
}
return $xml;
}
}