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
|
<?php
namespace Elastica\Aggregation;
use Elastica\Script;
use Elastica\ScriptFields;
/**
* Class TopHits.
*
* @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html
*/
class TopHits extends AbstractAggregation
{
/**
* @return array
*/
public function toArray()
{
$array = parent::toArray();
// if there are no params, it's ok, but ES will throw exception if json
// will be like {"top_hits":[]} instead of {"top_hits":{}}
if (empty($array['top_hits'])) {
$array['top_hits'] = new \stdClass();
}
return $array;
}
/**
* The maximum number of top matching hits to return per bucket. By default the top three matching hits are returned.
*
* @param int $size
*
* @return $this
*/
public function setSize($size)
{
return $this->setParam('size', (int) $size);
}
/**
* The offset from the first result you want to fetch.
*
* @param int $from
*
* @return $this
*/
public function setFrom($from)
{
return $this->setParam('from', (int) $from);
}
/**
* How the top matching hits should be sorted. By default the hits are sorted by the score of the main query.
*
* @param array $sortArgs
*
* @return $this
*/
public function setSort(array $sortArgs)
{
return $this->setParam('sort', $sortArgs);
}
/**
* Allows to control how the _source field is returned with every hit.
*
* @param array $fields
*
* @return $this
*/
public function setSource(array $fields)
{
return $this->setParam('_source', $fields);
}
/**
* Returns a version for each search hit.
*
* @param bool $version
*
* @return $this
*/
public function setVersion($version)
{
return $this->setParam('version', (bool) $version);
}
/**
* Enables explanation for each hit on how its score was computed.
*
* @param bool $explain
*
* @return $this
*/
public function setExplain($explain)
{
return $this->setParam('explain', (bool) $explain);
}
/**
* Set script fields.
*
* @param array|\Elastica\ScriptFields $scriptFields
*
* @return $this
*/
public function setScriptFields($scriptFields)
{
if (is_array($scriptFields)) {
$scriptFields = new ScriptFields($scriptFields);
}
return $this->setParam('script_fields', $scriptFields->toArray());
}
/**
* Adds a Script to the aggregation.
*
* @param string $name
* @param \Elastica\Script $script
*
* @return $this
*/
public function addScriptField($name, Script $script)
{
$this->_params['script_fields'][$name] = $script->toArray();
return $this;
}
/**
* Sets highlight arguments for the results.
*
* @param array $highlightArgs
*
* @return $this
*/
public function setHighlight(array $highlightArgs)
{
return $this->setParam('highlight', $highlightArgs);
}
/**
* Allows to return the field data representation of a field for each hit.
*
* @param array $fields
*
* @return $this
*/
public function setFieldDataFields(array $fields)
{
return $this->setParam('fielddata_fields', $fields);
}
}
|
