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
|
<?php
namespace Elastica\Aggregation;
/**
* Class Terms
* @package Elastica\Aggregation
* @link http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-aggregations-bucket-terms-aggregation.html
*/
class Terms extends AbstractSimpleAggregation
{
/**
* Set the bucket sort order
* @param string $order "_count", "_term", or the name of a sub-aggregation or sub-aggregation response field
* @param string $direction "asc" or "desc"
* @return Terms
*/
public function setOrder($order, $direction)
{
return $this->setParam("order", array($order => $direction));
}
/**
* Set the minimum number of documents in which a term must appear in order to be returned in a bucket
* @param int $count
* @return Terms
*/
public function setMinimumDocumentCount($count)
{
return $this->setParam("min_doc_count", $count);
}
/**
* Filter documents to include based on a regular expression
* @param string $pattern a regular expression
* @param string $flags Java Pattern flags
* @return Terms
*/
public function setInclude($pattern, $flags = null)
{
if (is_null($flags)) {
return $this->setParam("include", $pattern);
}
return $this->setParam("include", array(
"pattern" => $pattern,
"flags" => $flags
));
}
/**
* Filter documents to exclude based on a regular expression
* @param string $pattern a regular expression
* @param string $flags Java Pattern flags
* @return Terms
*/
public function setExclude($pattern, $flags = null)
{
if (is_null($flags)) {
return $this->setParam("exclude", $pattern);
}
return $this->setParam("exclude", array(
"pattern" => $pattern,
"flags" => $flags
));
}
/**
* Sets the amount of terms to be returned.
* @param int $size The amount of terms to be returned.
* @return \Elastica\Aggregation\Terms
*/
public function setSize($size)
{
return $this->setParam('size', $size);
}
/**
* Sets how many terms the coordinating node will request from each shard.
* @param int $shard_size The amount of terms to be returned.
* @return \Elastica\Aggregation\Terms
*/
public function setShardSize($shard_size)
{
return $this->setParam('shard_size', $shard_size);
}
/**
* Instruct Elasticsearch to use direct field data or ordinals of the field values to execute this aggregation.
* The execution hint will be ignored if it is not applicable.
* @param string $hint map or ordinals
* @return Terms
*/
public function setExecutionHint($hint)
{
return $this->setParam("execution_hint", $hint);
}
}
|
