@@ -183,7 +183,6 @@ |
||
| 183 | 183 | /** |
| 184 | 184 | * Record an event in Tracks - this is the preferred way to record events from PHP. |
| 185 | 185 | * |
| 186 | - * @param mixed $identity username, user_id, or WP_user object |
|
| 187 | 186 | * @param string $event_name The name of the event |
| 188 | 187 | * @param array $properties Custom properties to send with the event |
| 189 | 188 | * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | 50 | * record_event |
| 51 | - * @param mixed $event Event object to send to Tracks. An array will be cast to object. Required. |
|
| 51 | + * @param Jetpack_Tracks_Event $event Event object to send to Tracks. An array will be cast to object. Required. |
|
| 52 | 52 | * Properties are included directly in the pixel query string after light validation. |
| 53 | 53 | * @return mixed True on success, WP_Error on failure |
| 54 | 54 | */ |
@@ -71,6 +71,7 @@ discard block |
||
| 71 | 71 | |
| 72 | 72 | /** |
| 73 | 73 | * Synchronously request the pixel |
| 74 | + * @param string $pixel |
|
| 74 | 75 | */ |
| 75 | 76 | static function record_pixel( $pixel ) { |
| 76 | 77 | // Add the Request Timestamp and URL terminator just before the HTTP request. |
@@ -143,7 +143,6 @@ discard block |
||
| 143 | 143 | /** |
| 144 | 144 | * Mock a set of filters. |
| 145 | 145 | * |
| 146 | - * @param array $args Array of filters with their arguments. |
|
| 147 | 146 | * @return phpmock\Mock The mock object. |
| 148 | 147 | */ |
| 149 | 148 | protected function mock_filters( $filters = array() ) { |
@@ -153,8 +152,7 @@ discard block |
||
| 153 | 152 | /** |
| 154 | 153 | * Mock a set of constants. |
| 155 | 154 | * |
| 156 | - * @param array $args Array of sets with constants and their respective values. |
|
| 157 | - * @return phpmock\Mock The mock object. |
|
| 155 | + * @return phpmock\Mock[] The mock object. |
|
| 158 | 156 | */ |
| 159 | 157 | protected function mock_constants( $constants = array() ) { |
| 160 | 158 | $prepare_constant = function( $constant ) { |
@@ -171,7 +169,7 @@ discard block |
||
| 171 | 169 | * Mock a global function and make it return a certain value. |
| 172 | 170 | * |
| 173 | 171 | * @param string $function_name Name of the function. |
| 174 | - * @param mixed $return_value Return value of the function. |
|
| 172 | + * @param string $return_value Return value of the function. |
|
| 175 | 173 | * @return phpmock\Mock The mock object. |
| 176 | 174 | */ |
| 177 | 175 | protected function mock_function( $function_name, $return_value = null ) { |
@@ -95,6 +95,9 @@ |
||
| 95 | 95 | return (array) $upgrader->skin->get_upgrade_messages(); |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | + /** |
|
| 99 | + * @param string $plugin_slug |
|
| 100 | + */ |
|
| 98 | 101 | protected static function generate_wordpress_org_plugin_download_link( $plugin_slug ) { |
| 99 | 102 | return "https://downloads.wordpress.org/plugin/$plugin_slug.latest-stable.zip"; |
| 100 | 103 | } |
@@ -115,7 +115,7 @@ |
||
| 115 | 115 | * Mock a global function and make it return a certain value. |
| 116 | 116 | * |
| 117 | 117 | * @param string $function_name Name of the function. |
| 118 | - * @param mixed $return_value Return value of the function. |
|
| 118 | + * @param integer $return_value Return value of the function. |
|
| 119 | 119 | * @return phpmock\Mock The mock object. |
| 120 | 120 | */ |
| 121 | 121 | protected function mock_function( $function_name, $return_value = null ) { |
@@ -171,6 +171,9 @@ |
||
| 171 | 171 | update_option( 'jetpack_plugin_api_action_links', $plugins_action_links ); |
| 172 | 172 | } |
| 173 | 173 | |
| 174 | + /** |
|
| 175 | + * @param integer $checksum |
|
| 176 | + */ |
|
| 174 | 177 | public function should_send_callable( $callable_checksums, $name, $checksum ) { |
| 175 | 178 | $idc_override_callables = array( |
| 176 | 179 | 'main_network_site', |
@@ -106,7 +106,7 @@ discard block |
||
| 106 | 106 | * Is the user the connection owner. |
| 107 | 107 | * |
| 108 | 108 | * @param Integer $user_id the user identifier. |
| 109 | - * @return Boolean is the user the connection owner? |
|
| 109 | + * @return integer is the user the connection owner? |
|
| 110 | 110 | */ |
| 111 | 111 | public function is_connection_owner( $user_id ) { |
| 112 | 112 | return $user_id; |
@@ -570,7 +570,7 @@ discard block |
||
| 570 | 570 | * |
| 571 | 571 | * @param int|false $user_id false: Return the Blog Token. int: Return that user's User Token. |
| 572 | 572 | * @param string|false $token_key If provided, check that the token matches the provided input. |
| 573 | - * @param bool|true $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found. |
|
| 573 | + * @param boolean $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found. |
|
| 574 | 574 | * |
| 575 | 575 | * @return object|false |
| 576 | 576 | */ |
@@ -164,6 +164,9 @@ discard block |
||
| 164 | 164 | self::set_is_sending( null ); |
| 165 | 165 | } |
| 166 | 166 | |
| 167 | + /** |
|
| 168 | + * @param boolean|null $is_importing |
|
| 169 | + */ |
|
| 167 | 170 | static function set_importing( $is_importing ) { |
| 168 | 171 | // set to NULL to revert to WP_IMPORTING, the standard behavior |
| 169 | 172 | self::$is_importing = $is_importing; |
@@ -198,6 +201,9 @@ discard block |
||
| 198 | 201 | return (bool) self::$is_syncing || ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST ); |
| 199 | 202 | } |
| 200 | 203 | |
| 204 | + /** |
|
| 205 | + * @param boolean|null $is_syncing |
|
| 206 | + */ |
|
| 201 | 207 | static function set_is_syncing( $is_syncing ) { |
| 202 | 208 | self::$is_syncing = $is_syncing; |
| 203 | 209 | } |
@@ -206,6 +212,9 @@ discard block |
||
| 206 | 212 | return (bool) self::$is_sending; |
| 207 | 213 | } |
| 208 | 214 | |
| 215 | + /** |
|
| 216 | + * @param null|boolean $is_sending |
|
| 217 | + */ |
|
| 209 | 218 | static function set_is_sending( $is_sending ) { |
| 210 | 219 | self::$is_sending = $is_sending; |
| 211 | 220 | } |
@@ -73,6 +73,9 @@ discard block |
||
| 73 | 73 | return (float) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 ); |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | + /** |
|
| 77 | + * @param integer $time |
|
| 78 | + */ |
|
| 76 | 79 | public function set_next_sync_time( $time, $queue_name ) { |
| 77 | 80 | return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true ); |
| 78 | 81 | } |
@@ -103,6 +106,9 @@ discard block |
||
| 103 | 106 | return $this->do_sync_and_set_delays( $this->sync_queue ); |
| 104 | 107 | } |
| 105 | 108 | |
| 109 | + /** |
|
| 110 | + * @param \Jetpack_Sync_Queue $queue |
|
| 111 | + */ |
|
| 106 | 112 | public function do_sync_and_set_delays( $queue ) { |
| 107 | 113 | // don't sync if importing |
| 108 | 114 | if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) { |
@@ -360,6 +366,10 @@ discard block |
||
| 360 | 366 | } |
| 361 | 367 | |
| 362 | 368 | // in seconds |
| 369 | + |
|
| 370 | + /** |
|
| 371 | + * @param double $seconds |
|
| 372 | + */ |
|
| 363 | 373 | function set_max_dequeue_time( $seconds ) { |
| 364 | 374 | $this->max_dequeue_time = $seconds; |
| 365 | 375 | } |