@@ -186,7 +186,7 @@ |
||
| 186 | 186 | * Sign a string with a given key and algorithm. |
| 187 | 187 | * |
| 188 | 188 | * @param string $msg The message to sign. |
| 189 | - * @param string|resource $key The secret key. |
|
| 189 | + * @param string $key The secret key. |
|
| 190 | 190 | * @param string $alg The signing algorithm. |
| 191 | 191 | * Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'. |
| 192 | 192 | * |
@@ -149,7 +149,7 @@ |
||
| 149 | 149 | /** |
| 150 | 150 | * Get the token stored in the auth cookie. |
| 151 | 151 | * |
| 152 | - * @return ?string |
|
| 152 | + * @return string |
|
| 153 | 153 | */ |
| 154 | 154 | private function token_from_cookie() { |
| 155 | 155 | if ( isset( $_COOKIE[ self::JWT_AUTH_TOKEN_COOKIE_NAME ] ) ) { |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | * |
| 92 | 92 | * @param $function array A function structure to apply to the query |
| 93 | 93 | * |
| 94 | - * @return void |
|
| 94 | + * @return Jetpack_WPES_Query_Builder |
|
| 95 | 95 | */ |
| 96 | 96 | public function add_weighting_function( $function ) { |
| 97 | 97 | // check for danger. |
@@ -114,10 +114,10 @@ discard block |
||
| 114 | 114 | * |
| 115 | 115 | * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html |
| 116 | 116 | * |
| 117 | - * @param $function string name of the function |
|
| 117 | + * @param string $function string name of the function |
|
| 118 | 118 | * @param $params array functions parameters |
| 119 | 119 | * |
| 120 | - * @return void |
|
| 120 | + * @return Jetpack_WPES_Query_Builder |
|
| 121 | 121 | */ |
| 122 | 122 | public function add_function( $function, $params ) { |
| 123 | 123 | $this->functions[ $function ][] = $params; |
@@ -133,10 +133,10 @@ discard block |
||
| 133 | 133 | * |
| 134 | 134 | * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/decay-functions.html |
| 135 | 135 | * |
| 136 | - * @param $function string name of the decay function - linear, exp, or gauss |
|
| 136 | + * @param string $function string name of the decay function - linear, exp, or gauss |
|
| 137 | 137 | * @param $params array The decay functions parameters, passed to ES directly |
| 138 | 138 | * |
| 139 | - * @return void |
|
| 139 | + * @return Jetpack_WPES_Query_Builder |
|
| 140 | 140 | */ |
| 141 | 141 | public function add_decay( $function, $params ) { |
| 142 | 142 | $this->decays[ $function ][] = $params; |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | * |
| 152 | 152 | * @param $mode string name of how to score |
| 153 | 153 | * |
| 154 | - * @return void |
|
| 154 | + * @return Jetpack_WPES_Query_Builder |
|
| 155 | 155 | */ |
| 156 | 156 | public function add_score_mode_to_functions( $mode='multiply' ) { |
| 157 | 157 | $this->functions_score_mode = $mode; |
@@ -177,6 +177,9 @@ discard block |
||
| 177 | 177 | return $this; |
| 178 | 178 | } |
| 179 | 179 | |
| 180 | + /** |
|
| 181 | + * @param string $aggs_name |
|
| 182 | + */ |
|
| 180 | 183 | public function add_aggs( $aggs_name, $aggs ) { |
| 181 | 184 | $this->aggs_query = true; |
| 182 | 185 | $this->aggs[$aggs_name] = $aggs; |