diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Aggregation/IpRange.php')
-rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/Aggregation/IpRange.php | 38 |
1 files changed, 22 insertions, 16 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Aggregation/IpRange.php b/vendor/ruflin/elastica/lib/Elastica/Aggregation/IpRange.php index 18e60bfb..7a4ef7c8 100644 --- a/vendor/ruflin/elastica/lib/Elastica/Aggregation/IpRange.php +++ b/vendor/ruflin/elastica/lib/Elastica/Aggregation/IpRange.php @@ -1,19 +1,17 @@ <?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. + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html */ class IpRange extends AbstractAggregation { /** - * @param string $name the name of this aggregation + * @param string $name the name of this aggregation * @param string $field the field on which to perform this aggregation */ public function __construct($name, $field) @@ -23,9 +21,11 @@ class IpRange extends AbstractAggregation } /** - * Set the field for this aggregation + * Set the field for this aggregation. + * * @param string $field the name of the document field on which to perform this aggregation - * @return IpRange + * + * @return $this */ public function setField($field) { @@ -33,16 +33,19 @@ class IpRange extends AbstractAggregation } /** - * Add an ip range to this aggregation + * 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 + * @param string $toValue a valid ipv4 address. High end of this range, exclusive (less than) + * * @throws \Elastica\Exception\InvalidException + * + * @return $this */ 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."); + throw new InvalidException('Either fromValue or toValue must be set. Both cannot be null.'); } $range = array(); if (!is_null($fromValue)) { @@ -51,16 +54,19 @@ class IpRange extends AbstractAggregation if (!is_null($toValue)) { $range['to'] = $toValue; } + return $this->addParam('ranges', $range); } /** - * Add an ip range in the form of a CIDR mask + * Add an ip range in the form of a CIDR mask. + * * @param string $mask a valid CIDR mask - * @return IpRange + * + * @return $this */ public function addMaskRange($mask) { - return $this->addParam("ranges", array("mask" => $mask)); + return $this->addParam('ranges', array('mask' => $mask)); } -}
\ No newline at end of file +} |