/
AbstractUpdateAction.php
457 lines (402 loc) · 8.8 KB
/
AbstractUpdateAction.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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<?php
namespace Elastica;
/**
* Base class for things that can be sent to the update api (Document and
* Script).
*
* @author Nik Everett <nik9000@gmail.com>
*/
class AbstractUpdateAction extends Param
{
/**
* @var Document
*/
protected $_upsert;
/**
* Sets the id of the document.
*/
public function setId(?string $id = null): self
{
return $this->setParam('_id', $id);
}
/**
* Returns document id.
*
* @return string|null Document id
*/
public function getId(): ?string
{
return $this->hasParam('_id') ? $this->getParam('_id') : null;
}
public function hasId(): bool
{
return null !== $this->getId();
}
/**
* Sets the document index name.
*
* @param Index|string $index Index name
*/
public function setIndex($index): self
{
if ($index instanceof Index) {
$index = $index->getName();
}
return $this->setParam('_index', $index);
}
/**
* Get the document index name.
*
* @throws \Elastica\Exception\InvalidException
*
* @return string Index name
*/
public function getIndex()
{
return $this->getParam('_index');
}
/**
* Sets the version parameters of a document for use with optimistic concurrency control.
*
* @return $this
*/
public function setVersionParams(array $responseData): self
{
if (isset($responseData['_version'])) {
$this->setVersion($responseData['_version']);
}
if (isset($data['_seq_no'])) {
$this->setSequenceNumber($responseData['_seq_no']);
}
if (isset($data['_primary_term'])) {
$this->setPrimaryTerm($responseData['_primary_term']);
}
return $this;
}
/**
* Sets the sequence number of a document for use with optimistic concurrency control.
*
* @param int $number Sequence Number
*
* @return $this
*
* @see https://www.elastic.co/guide/en/elasticsearch/reference/6.8/optimistic-concurrency-control.html
*/
public function setSequenceNumber(int $number): self
{
return $this->setParam('if_seq_no', $number);
}
/**
* Returns document version.
*
* @return int Document version
*/
public function getSequenceNumber(): int
{
return $this->getParam('if_seq_no');
}
public function hasSequenceNumber(): bool
{
return $this->hasParam('if_seq_no');
}
/**
* Sets the primary term of a document for use with optimistic concurrency control.
*
* @param int $term Primary Term
*
* @return $this
*
* @see https://www.elastic.co/guide/en/elasticsearch/reference/6.8/optimistic-concurrency-control.html
*/
public function setPrimaryTerm(int $term): self
{
return $this->setParam('if_primary_term', $term);
}
/**
* Returns document version.
*
* @return int Document version
*/
public function getPrimaryTerm(): int
{
return $this->getParam('if_primary_term');
}
public function hasPrimaryTerm(): bool
{
return $this->hasParam('if_primary_term');
}
/**
* Sets the version of a document.
*
* @param int $version Document version
*
* @return $this
*
* @see https://www.elastic.co/blog/versioning
*/
public function setVersion($version)
{
return $this->setParam('version', (int) $version);
}
/**
* Returns document version.
*
* @return int|string Document version
*/
public function getVersion()
{
return $this->getParam('version');
}
/**
* @return bool
*/
public function hasVersion()
{
return $this->hasParam('version');
}
/**
* Set operation type.
*
* @param string $opType Only accept create
*
* @return $this
*/
public function setOpType($opType)
{
return $this->setParam('op_type', $opType);
}
/**
* Get operation type.
*
* @return string
*/
public function getOpType()
{
return $this->getParam('op_type');
}
/**
* @return bool
*/
public function hasOpType()
{
return $this->hasParam('op_type');
}
/**
* Set routing query param.
*
* @param string $value routing
*
* @return $this
*/
public function setRouting($value)
{
return $this->setParam('routing', $value);
}
/**
* Get routing parameter.
*
* @return string
*/
public function getRouting()
{
return $this->getParam('routing');
}
/**
* @return bool
*/
public function hasRouting()
{
return $this->hasParam('routing');
}
/**
* @param array|string $fields
*
* @return $this
*/
public function setFields($fields)
{
if (\is_array($fields)) {
$fields = \implode(',', $fields);
}
return $this->setParam('fields', (string) $fields);
}
/**
* @return $this
*/
public function setFieldsSource()
{
return $this->setFields('_source');
}
/**
* @return string
*/
public function getFields()
{
return $this->getParam('fields');
}
/**
* @return bool
*/
public function hasFields()
{
return $this->hasParam('fields');
}
/**
* @param int $num
*
* @return $this
*/
public function setRetryOnConflict($num)
{
return $this->setParam('retry_on_conflict', (int) $num);
}
/**
* @return int
*/
public function getRetryOnConflict()
{
return $this->getParam('retry_on_conflict');
}
/**
* @return bool
*/
public function hasRetryOnConflict()
{
return $this->hasParam('retry_on_conflict');
}
/**
* @param bool|string $refresh
*
* @return $this
*/
public function setRefresh($refresh = true)
{
\is_bool($refresh) && $refresh = $refresh
? Reindex::REFRESH_TRUE
: Reindex::REFRESH_FALSE;
return $this->setParam(Reindex::REFRESH, $refresh);
}
/**
* @return bool|string
*/
public function getRefresh()
{
$refresh = $this->getParam('refresh');
return \in_array($refresh, [Reindex::REFRESH_TRUE, Reindex::REFRESH_FALSE])
? Reindex::REFRESH_TRUE === $refresh
: $refresh;
}
/**
* @return bool
*/
public function hasRefresh()
{
return $this->hasParam('refresh');
}
/**
* @param string $timeout
*
* @return $this
*/
public function setTimeout($timeout)
{
return $this->setParam('timeout', $timeout);
}
/**
* @return bool
*/
public function getTimeout()
{
return $this->getParam('timeout');
}
/**
* @return bool
*/
public function hasTimeout()
{
return $this->hasParam('timeout');
}
/**
* @param string $timeout
*
* @return $this
*/
public function setConsistency($timeout)
{
return $this->setParam('consistency', $timeout);
}
/**
* @return string
*/
public function getConsistency()
{
return $this->getParam('consistency');
}
/**
* @return bool
*/
public function hasConsistency()
{
return $this->hasParam('consistency');
}
/**
* @param string $timeout
*
* @return $this
*/
public function setReplication($timeout)
{
return $this->setParam('replication', $timeout);
}
/**
* @return string
*/
public function getReplication()
{
return $this->getParam('replication');
}
/**
* @return bool
*/
public function hasReplication()
{
return $this->hasParam('replication');
}
/**
* @param array|Document $data
*
* @return $this
*/
public function setUpsert($data)
{
$document = Document::create($data);
$this->_upsert = $document;
return $this;
}
/**
* @return Document
*/
public function getUpsert()
{
return $this->_upsert;
}
/**
* @return bool
*/
public function hasUpsert()
{
return null !== $this->_upsert;
}
/**
* @param array $fields if empty array all options will be returned
*
* @return array
*/
public function getOptions(array $fields = [])
{
if (!empty($fields)) {
return \array_filter(\array_intersect_key($this->getParams(), \array_flip($fields)));
}
return \array_filter($this->getParams());
}
}