blob: 18e60bfbc561b390d4f0bba0eb0b0ae2b947d663 (
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
|
<?php
namespace Elastica\Aggregation;
use Elastica\Exception\InvalidException;
/**
* Class IpRange
* @package Elastica\Aggregation
* @link http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-aggregations-bucket-iprange-aggregation.html
*/
class IpRange extends AbstractAggregation
{
/**
* @param string $name the name of this aggregation
* @param string $field the field on which to perform this aggregation
*/
public function __construct($name, $field)
{
parent::__construct($name);
$this->setField($field);
}
/**
* Set the field for this aggregation
* @param string $field the name of the document field on which to perform this aggregation
* @return IpRange
*/
public function setField($field)
{
return $this->setParam('field', $field);
}
/**
* Add an ip range to this aggregation
* @param string $fromValue a valid ipv4 address. Low end of this range, exclusive (greater than)
* @param string $toValue a valid ipv4 address. High end of this range, exclusive (less than)
* @return IpRange
* @throws \Elastica\Exception\InvalidException
*/
public function addRange($fromValue = null, $toValue = null)
{
if (is_null($fromValue) && is_null($toValue)) {
throw new InvalidException("Either fromValue or toValue must be set. Both cannot be null.");
}
$range = array();
if (!is_null($fromValue)) {
$range['from'] = $fromValue;
}
if (!is_null($toValue)) {
$range['to'] = $toValue;
}
return $this->addParam('ranges', $range);
}
/**
* Add an ip range in the form of a CIDR mask
* @param string $mask a valid CIDR mask
* @return IpRange
*/
public function addMaskRange($mask)
{
return $this->addParam("ranges", array("mask" => $mask));
}
}
|
