blob: e8aa8e3d1e6bb88c3f9362378df881ab46180ba3 (
plain)
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
|
<?php
namespace Elastica;
/**
* Elastica result item
*
* Stores all information from a result
*
* @category Xodoa
* @package Elastica
* @author Nicolas Ruflin <spam@ruflin.com>
*/
class Result
{
/**
* Hit array
*
* @var array Hit array
*/
protected $_hit = array();
/**
* Constructs a single results object
*
* @param array $hit Hit data
*/
public function __construct(array $hit)
{
$this->_hit = $hit;
}
/**
* Returns a param from the result hit array
*
* This function can be used to retrieve all data for which a specific
* function doesn't exist.
* If the param does not exist, an empty array is returned
*
* @param string $name Param name
* @return array Result data
*/
public function getParam($name)
{
if (isset($this->_hit[$name])) {
return $this->_hit[$name];
}
return array();
}
/**
* Test if a param from the result hit is set
*
* @param string $name Param name to test
* @return boolean True if the param is set, false otherwise
*/
public function hasParam($name)
{
return isset($this->_hit[$name]);
}
/**
* Returns the hit id
*
* @return string Hit id
*/
public function getId()
{
return $this->getParam('_id');
}
/**
* Returns the type of the result
*
* @return string Result type
*/
public function getType()
{
return $this->getParam('_type');
}
/**
* Returns list of fields
*
* @return array Fields list
*/
public function getFields()
{
return $this->getParam('fields');
}
/**
* Returns whether result has fields
*
* @return bool
*/
public function hasFields()
{
return $this->hasParam('fields');
}
/**
* Returns the index name of the result
*
* @return string Index name
*/
public function getIndex()
{
return $this->getParam('_index');
}
/**
* Returns the score of the result
*
* @return float Result score
*/
public function getScore()
{
return $this->getParam('_score');
}
/**
* Returns the raw hit array
*
* @return array Hit array
*/
public function getHit()
{
return $this->_hit;
}
/**
* Returns the version information from the hit
*
* @return string|int Document version
*/
public function getVersion()
{
return $this->getParam('_version');
}
/**
* Returns result data
*
* Checks for partial result data with getFields, falls back to getSource
*
* @return array Result data array
*/
public function getData()
{
if (isset($this->_hit['fields']) && !isset($this->_hit['_source'])) {
return $this->getFields();
}
return $this->getSource();
}
/**
* Returns the result source
*
* @return array Source data array
*/
public function getSource()
{
return $this->getParam('_source');
}
/**
* Returns result data
*
* @return array Result data array
*/
public function getHighlights()
{
return $this->getParam('highlight');
}
/**
* Returns explanation on how its score was computed.
*
* @return array explanations
*/
public function getExplanation()
{
return $this->getParam('_explanation');
}
/**
* Magic function to directly access keys inside the result
*
* Returns null if key does not exist
*
* @param string $key Key name
* @return mixed Key value
*/
public function __get($key)
{
$source = $this->getData();
return array_key_exists($key, $source) ? $source[$key] : null;
}
/**
* Magic function to support isset() calls
*
* @param string $key Key name
* @return bool
*/
public function __isset($key)
{
$source = $this->getData();
return array_key_exists($key, $source) && $source[$key] !== null;
}
}
|
