-
Notifications
You must be signed in to change notification settings - Fork 0
/
Response.php
252 lines (215 loc) · 5.39 KB
/
Response.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
<?php
namespace Elastica;
use Elastica\Exception\NotFoundException;
/**
* Elastica Response object
*
* Stores query time, and result array -> is given to result set, returned by ...
*
* @category Xodoa
* @package Elastica
* @author Nicolas Ruflin <spam@ruflin.com>
*/
class Response
{
/**
* Query time
*
* @var float Query time
*/
protected $_queryTime = null;
/**
* Response string (json)
*
* @var string Response
*/
protected $_responseString = '';
/**
* Error
*
* @var boolean Error
*/
protected $_error = false;
/**
* Transfer info
*
* @var array transfer info
*/
protected $_transferInfo = array();
/**
* Response
*
* @var \Elastica\Response Response object
*/
protected $_response = null;
/**
* Construct
*
* @param string|array $responseString Response string (json)
*/
public function __construct($responseString)
{
if (is_array($responseString)) {
$this->_response = $responseString;
} else {
$this->_responseString = $responseString;
}
}
/**
* Error message
*
* @return string Error message
*/
public function getError()
{
$message = '';
$response = $this->getData();
if (isset($response['error'])) {
$message = $response['error'];
}
return $message;
}
/**
* True if response has error
*
* @return bool True if response has error
*/
public function hasError()
{
$response = $this->getData();
if (isset($response['error'])) {
return true;
}
return false;
}
/**
* Checks if the query returned ok
*
* @return bool True if ok
*/
public function isOk()
{
$data = $this->getData();
// Bulk insert checks. Check every item
if (isset($data['items'])) {
foreach ($data['items'] as $item) {
if (false == $item['index']['ok']) {
return false;
}
}
return true;
}
return (isset($data['ok']) && $data['ok']);
}
/**
* Response data array
*
* @return array Response data array
*/
public function getData()
{
if ($this->_response == null) {
$response = $this->_responseString;
if ($response === false) {
$this->_error = true;
} else {
$tempResponse = json_decode($response, true);
// If error is returned, json_decode makes empty string of string
if (!empty($tempResponse)) {
$response = $tempResponse;
}
}
if (empty($response)) {
$response = array();
}
if (is_string($response)) {
$response = array('message' => $response);
}
$this->_response = $response;
}
return $this->_response;
}
/**
* Gets the transfer information.
*
* @return array Information about the curl request.
*/
public function getTransferInfo()
{
return $this->_transferInfo;
}
/**
* Sets the transfer info of the curl request. This function is called
* from the \Elastica\Client::_callService .
*
* @param array $transferInfo The curl transfer information.
* @return \Elastica\Response Current object
*/
public function setTransferInfo(array $transferInfo)
{
$this->_transferInfo = $transferInfo;
return $this;
}
/**
* This is only available if DEBUG constant is set to true
*
* @return float Query time
*/
public function getQueryTime()
{
return $this->_queryTime;
}
/**
* Sets the query time
*
* @param float $queryTime Query time
* @return \Elastica\Response Current object
*/
public function setQueryTime($queryTime)
{
$this->_queryTime = $queryTime;
return $this;
}
/**
* Time request took
*
* @throws \Elastica\Exception\NotFoundException
* @return int Time request took
*/
public function getEngineTime()
{
$data = $this->getData();
if (!isset($data['took'])) {
throw new NotFoundException("Unable to find the field [took]from the response");
}
return $data['took'];
}
/**
* Get the _shard statistics for the response
*
* @throws \Elastica\Exception\NotFoundException
* @return array
*/
public function getShardsStatistics()
{
$data = $this->getData();
if (!isset($data['_shards'])) {
throw new NotFoundException("Unable to find the field [_shards] from the response");
}
return $data['_shards'];
}
/**
* Get the _scroll value for the response
*
* @throws \Elastica\Exception\NotFoundException
* @return string
*/
public function getScrollId()
{
$data = $this->getData();
if (!isset($data['_scroll_id'])) {
throw new NotFoundException("Unable to find the field [_scroll_id] from the response");
}
return $data['_scroll_id'];
}
}