@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | * |
| 86 | 86 | * @param $function array A function structure to apply to the query |
| 87 | 87 | * |
| 88 | - * @return void |
|
| 88 | + * @return Jetpack_WPES_Query_Builder |
|
| 89 | 89 | */ |
| 90 | 90 | public function add_weighting_function( $function ) { |
| 91 | 91 | $this->weighting_functions[] = $function; |
@@ -100,10 +100,10 @@ discard block |
||
| 100 | 100 | * |
| 101 | 101 | * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html |
| 102 | 102 | * |
| 103 | - * @param $function string name of the function |
|
| 103 | + * @param string $function string name of the function |
|
| 104 | 104 | * @param $params array functions parameters |
| 105 | 105 | * |
| 106 | - * @return void |
|
| 106 | + * @return Jetpack_WPES_Query_Builder |
|
| 107 | 107 | */ |
| 108 | 108 | public function add_function( $function, $params ) { |
| 109 | 109 | $this->functions[ $function ][] = $params; |
@@ -119,10 +119,10 @@ discard block |
||
| 119 | 119 | * |
| 120 | 120 | * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/decay-functions.html |
| 121 | 121 | * |
| 122 | - * @param $function string name of the decay function - linear, exp, or gauss |
|
| 122 | + * @param string $function string name of the decay function - linear, exp, or gauss |
|
| 123 | 123 | * @param $params array The decay functions parameters, passed to ES directly |
| 124 | 124 | * |
| 125 | - * @return void |
|
| 125 | + * @return Jetpack_WPES_Query_Builder |
|
| 126 | 126 | */ |
| 127 | 127 | public function add_decay( $function, $params ) { |
| 128 | 128 | $this->decays[ $function ][] = $params; |
@@ -137,7 +137,7 @@ discard block |
||
| 137 | 137 | * |
| 138 | 138 | * @param $mode string name of how to score |
| 139 | 139 | * |
| 140 | - * @return void |
|
| 140 | + * @return Jetpack_WPES_Query_Builder |
|
| 141 | 141 | */ |
| 142 | 142 | public function add_score_mode_to_functions( $mode='multiply' ) { |
| 143 | 143 | $this->functions_score_mode = $mode; |
@@ -163,6 +163,9 @@ discard block |
||
| 163 | 163 | return $this; |
| 164 | 164 | } |
| 165 | 165 | |
| 166 | + /** |
|
| 167 | + * @param string $aggs_name |
|
| 168 | + */ |
|
| 166 | 169 | public function add_aggs( $aggs_name, $aggs ) { |
| 167 | 170 | $this->aggs_query = true; |
| 168 | 171 | $this->aggs[$aggs_name] = $aggs; |