@@ -1032,6 +1032,9 @@ |
||
| 1032 | 1032 | return $return; |
| 1033 | 1033 | } |
| 1034 | 1034 | |
| 1035 | + /** |
|
| 1036 | + * @param string $slug |
|
| 1037 | + */ |
|
| 1035 | 1038 | private function ensure_synced_taxonomy( $store, $slug, $type = 'post' ) { |
| 1036 | 1039 | register_taxonomy( |
| 1037 | 1040 | $slug, |
@@ -13,6 +13,7 @@ |
||
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * Wrapper around `WP_REST_Request` constructor. Injects a `sites/$blog_id` into endpoint string for WPCOM environment |
| 16 | + * @param string $path |
|
| 16 | 17 | */ |
| 17 | 18 | function wp_rest_request( $method, $path ) { |
| 18 | 19 | if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | * |
| 104 | 104 | * @param object $attachment The attachment object. |
| 105 | 105 | * |
| 106 | - * @return false|int |
|
| 106 | + * @return boolean |
|
| 107 | 107 | */ |
| 108 | 108 | public function is_video( $attachment ) { |
| 109 | 109 | return isset( $attachment->post_mime_type ) && wp_startswith( $attachment->post_mime_type, 'video/' ); |
@@ -113,8 +113,8 @@ discard block |
||
| 113 | 113 | * Removes the jetpack_videopress field from the response if the |
| 114 | 114 | * given attachment is not a video. |
| 115 | 115 | * |
| 116 | - * @param WP_REST_Response $response Response from the attachment endpoint. |
|
| 117 | - * @param WP_Post $attachment The original attachment object. |
|
| 116 | + * @param stdClass $response Response from the attachment endpoint. |
|
| 117 | + * @param stdClass $attachment The original attachment object. |
|
| 118 | 118 | * |
| 119 | 119 | * @return mixed |
| 120 | 120 | */ |
@@ -146,7 +146,7 @@ discard block |
||
| 146 | 146 | * @param mixed $object Response from the attachment endpoint. |
| 147 | 147 | * @param WP_REST_Request $request Request to the attachment endpoint. |
| 148 | 148 | * |
| 149 | - * @return true |
|
| 149 | + * @return boolean |
|
| 150 | 150 | */ |
| 151 | 151 | public function get_permission_check( $object, $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 152 | 152 | return true; |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | * @param WP_Post $object The attachment object. |
| 161 | 161 | * @param WP_REST_Request $request Request to the attachment endpoint. |
| 162 | 162 | * |
| 163 | - * @return true |
|
| 163 | + * @return boolean |
|
| 164 | 164 | */ |
| 165 | 165 | public function update_permission_check( $value, $object, $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 166 | 166 | return true; |
@@ -100,7 +100,7 @@ |
||
| 100 | 100 | * |
| 101 | 101 | * @param string $class_name The name of the class to autoload. |
| 102 | 102 | * |
| 103 | - * @return bool Indicates whether or not a class file was loaded. |
|
| 103 | + * @return null|boolean Indicates whether or not a class file was loaded. |
|
| 104 | 104 | */ |
| 105 | 105 | public static function load_class( $class_name ) { |
| 106 | 106 | global $jetpack_autoloader_loader; |
@@ -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; |
@@ -22,6 +22,7 @@ discard block |
||
| 22 | 22 | |
| 23 | 23 | /** |
| 24 | 24 | * Scan every PHP in the root |
| 25 | + * @param string $root |
|
| 25 | 26 | */ |
| 26 | 27 | public function scan( $root, $exclude = array() ) { |
| 27 | 28 | if ( is_dir( $root ) ) { |
@@ -33,6 +34,9 @@ discard block |
||
| 33 | 34 | } |
| 34 | 35 | } |
| 35 | 36 | |
| 37 | + /** |
|
| 38 | + * @param string $root |
|
| 39 | + */ |
|
| 36 | 40 | public function scan_dir( $root, $exclude = array() ) { |
| 37 | 41 | |
| 38 | 42 | if ( is_null( $exclude ) || ! is_array( $exclude ) ) { |
@@ -124,7 +124,7 @@ |
||
| 124 | 124 | * @param int $cutoff_timestamp All nonces added before this timestamp will be removed. |
| 125 | 125 | * @param int $time_limit How long the cleanup can run (in seconds). |
| 126 | 126 | * |
| 127 | - * @return true |
|
| 127 | + * @return boolean |
|
| 128 | 128 | */ |
| 129 | 129 | public function clean_all( $cutoff_timestamp = PHP_INT_MAX, $time_limit = 20 ) { |
| 130 | 130 | // phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed |