diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Facet/Statistical.php')
| -rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/Facet/Statistical.php | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Facet/Statistical.php b/vendor/ruflin/elastica/lib/Elastica/Facet/Statistical.php index 71507b8f..bb4eef8b 100644 --- a/vendor/ruflin/elastica/lib/Elastica/Facet/Statistical.php +++ b/vendor/ruflin/elastica/lib/Elastica/Facet/Statistical.php @@ -1,22 +1,22 @@ <?php - namespace Elastica\Facet; /** * Implements the statistical facet. * - * @category Xodoa - * @package Elastica * @author Robert Katzki <robert@katzki.de> - * @link http://www.elasticsearch.org/guide/reference/api/search/facets/statistical-facet.html + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-facets-statistical-facet.html + * @deprecated Facets are deprecated and will be removed in a future release. You are encouraged to migrate to aggregations instead. */ class Statistical extends AbstractFacet { /** * Sets the field for the statistical query. * - * @param string $field The field name for the statistical query. - * @return \Elastica\Facet\Statistical + * @param string $field The field name for the statistical query. + * + * @return $this */ public function setField($field) { @@ -26,8 +26,9 @@ class Statistical extends AbstractFacet /** * Sets multiple fields for the statistical query. * - * @param array $fields Numerical array with the fields for the statistical query. - * @return \Elastica\Facet\Statistical + * @param array $fields Numerical array with the fields for the statistical query. + * + * @return $this */ public function setFields(array $fields) { @@ -35,10 +36,11 @@ class Statistical extends AbstractFacet } /** - * Sets a script to calculate statistical information + * Sets a script to calculate statistical information. + * + * @param string $script The script to do calculations on the statistical values * - * @param string $script The script to do calculations on the statistical values - * @return \Elastica\Facet\Statistical + * @return $this */ public function setScript($script) { @@ -50,6 +52,7 @@ class Statistical extends AbstractFacet * facet definition of the parent. * * @see \Elastica\Facet\AbstractFacet::toArray() + * * @return array */ public function toArray() |