diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Aggregation/Histogram.php')
-rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/Aggregation/Histogram.php | 42 |
1 files changed, 23 insertions, 19 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Aggregation/Histogram.php b/vendor/ruflin/elastica/lib/Elastica/Aggregation/Histogram.php index 26fa7c44..79a8e517 100644 --- a/vendor/ruflin/elastica/lib/Elastica/Aggregation/Histogram.php +++ b/vendor/ruflin/elastica/lib/Elastica/Aggregation/Histogram.php @@ -1,18 +1,17 @@ <?php - namespace Elastica\Aggregation; /** - * Class Histogram - * @package Elastica\Aggregation - * @link http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-aggregations-bucket-histogram-aggregation.html + * Class Histogram. + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html */ class Histogram extends AbstractSimpleAggregation { /** - * @param string $name the name of this aggregation - * @param string $field the name of the field on which to perform the aggregation - * @param int $interval the interval by which documents will be bucketed + * @param string $name the name of this aggregation + * @param string $field the name of the field on which to perform the aggregation + * @param int $interval the interval by which documents will be bucketed */ public function __construct($name, $field, $interval) { @@ -21,35 +20,40 @@ class Histogram extends AbstractSimpleAggregation $this->setInterval($interval); } - /** - * Set the interval by which documents will be bucketed + * Set the interval by which documents will be bucketed. + * * @param int $interval - * @return Histogram + * + * @return $this */ public function setInterval($interval) { - return $this->setParam("interval", $interval); + return $this->setParam('interval', $interval); } /** - * Set the bucket sort order - * @param string $order "_count", "_term", or the name of a sub-aggregation or sub-aggregation response field + * 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 Histogram + * + * @return $this */ public function setOrder($order, $direction) { - return $this->setParam("order", array($order => $direction)); + return $this->setParam('order', array($order => $direction)); } /** - * Set the minimum number of documents which must fall into a bucket in order for the bucket to be returned + * Set the minimum number of documents which must fall into a bucket in order for the bucket to be returned. + * * @param int $count set to 0 to include empty buckets - * @return Histogram + * + * @return $this */ public function setMinimumDocumentCount($count) { - return $this->setParam("min_doc_count", $count); + return $this->setParam('min_doc_count', $count); } -}
\ No newline at end of file +} |