@@ -148,6 +148,7 @@ discard block |
||
| 148 | 148 | * Helper function that is used when getting home or siteurl values. Decides |
| 149 | 149 | * whether to get the raw or filtered value. |
| 150 | 150 | * |
| 151 | + * @param string $url_type |
|
| 151 | 152 | * @return string |
| 152 | 153 | */ |
| 153 | 154 | public static function get_raw_or_filtered_url( $url_type ) { |
@@ -197,6 +198,9 @@ discard block |
||
| 197 | 198 | return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() ); |
| 198 | 199 | } |
| 199 | 200 | |
| 201 | + /** |
|
| 202 | + * @param string $callable |
|
| 203 | + */ |
|
| 200 | 204 | public static function get_protocol_normalized_url( $callable, $new_value ) { |
| 201 | 205 | $option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable; |
| 202 | 206 | |
@@ -236,6 +240,9 @@ discard block |
||
| 236 | 240 | return $value; |
| 237 | 241 | } |
| 238 | 242 | |
| 243 | + /** |
|
| 244 | + * @param string $url_function |
|
| 245 | + */ |
|
| 239 | 246 | public static function normalize_www_in_url( $option, $url_function ) { |
| 240 | 247 | $url = wp_parse_url( call_user_func( $url_function ) ); |
| 241 | 248 | $option_url = wp_parse_url( get_option( $option ) ); |
@@ -185,6 +185,9 @@ discard block |
||
| 185 | 185 | do_action( 'jetpack_full_sync_end', '', $range ); |
| 186 | 186 | } |
| 187 | 187 | |
| 188 | + /** |
|
| 189 | + * @param string $type |
|
| 190 | + */ |
|
| 188 | 191 | function get_range( $type ) { |
| 189 | 192 | global $wpdb; |
| 190 | 193 | if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) { |
@@ -323,6 +326,9 @@ discard block |
||
| 323 | 326 | $listener->get_full_sync_queue()->reset(); |
| 324 | 327 | } |
| 325 | 328 | |
| 329 | + /** |
|
| 330 | + * @param integer $default |
|
| 331 | + */ |
|
| 326 | 332 | private function get_status_option( $name, $default = null ) { |
| 327 | 333 | $value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default ); |
| 328 | 334 | |
@@ -42,6 +42,9 @@ discard block |
||
| 42 | 42 | return array(); |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | + /** |
|
| 46 | + * @param string[] $actions_to_count |
|
| 47 | + */ |
|
| 45 | 48 | protected function count_actions( $action_names, $actions_to_count ) { |
| 46 | 49 | return count( array_intersect( $action_names, $actions_to_count ) ); |
| 47 | 50 | } |
@@ -58,6 +61,10 @@ discard block |
||
| 58 | 61 | return false; |
| 59 | 62 | } |
| 60 | 63 | |
| 64 | + /** |
|
| 65 | + * @param string $action_name |
|
| 66 | + * @param string $id_field |
|
| 67 | + */ |
|
| 61 | 68 | protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) { |
| 62 | 69 | global $wpdb; |
| 63 | 70 | |
@@ -111,6 +118,9 @@ discard block |
||
| 111 | 118 | return $chunks_with_ends; |
| 112 | 119 | } |
| 113 | 120 | |
| 121 | + /** |
|
| 122 | + * @param string $meta_type |
|
| 123 | + */ |
|
| 114 | 124 | protected function get_metadata( $ids, $meta_type, $meta_key_whitelist ) { |
| 115 | 125 | global $wpdb; |
| 116 | 126 | $table = _get_meta_table( $meta_type ); |
@@ -131,12 +141,18 @@ discard block |
||
| 131 | 141 | ); |
| 132 | 142 | } |
| 133 | 143 | |
| 144 | + /** |
|
| 145 | + * @param string $meta_type |
|
| 146 | + */ |
|
| 134 | 147 | public function init_listeners_for_meta_type( $meta_type, $callable ) { |
| 135 | 148 | add_action( "added_{$meta_type}_meta", $callable, 10, 4 ); |
| 136 | 149 | add_action( "updated_{$meta_type}_meta", $callable, 10, 4 ); |
| 137 | 150 | add_action( "deleted_{$meta_type}_meta", $callable, 10, 4 ); |
| 138 | 151 | } |
| 139 | 152 | |
| 153 | + /** |
|
| 154 | + * @param string $meta_type |
|
| 155 | + */ |
|
| 140 | 156 | public function init_meta_whitelist_handler( $meta_type, $whitelist_handler ) { |
| 141 | 157 | add_filter( "jetpack_sync_before_enqueue_added_{$meta_type}_meta", $whitelist_handler ); |
| 142 | 158 | add_filter( "jetpack_sync_before_enqueue_updated_{$meta_type}_meta", $whitelist_handler ); |
@@ -246,6 +246,9 @@ discard block |
||
| 246 | 246 | return true; |
| 247 | 247 | } |
| 248 | 248 | |
| 249 | + /** |
|
| 250 | + * @param Jetpack_Sync_Queue_Buffer $buffer |
|
| 251 | + */ |
|
| 249 | 252 | function close( $buffer, $ids_to_remove = null ) { |
| 250 | 253 | $is_valid = $this->validate_checkout( $buffer ); |
| 251 | 254 | |
@@ -339,6 +342,9 @@ discard block |
||
| 339 | 342 | return false; |
| 340 | 343 | } |
| 341 | 344 | |
| 345 | + /** |
|
| 346 | + * @param string $checkout_id |
|
| 347 | + */ |
|
| 342 | 348 | private function set_checkout_id( $checkout_id ) { |
| 343 | 349 | global $wpdb; |
| 344 | 350 | |
@@ -447,6 +447,10 @@ discard block |
||
| 447 | 447 | } |
| 448 | 448 | |
| 449 | 449 | // functions |
| 450 | + |
|
| 451 | + /** |
|
| 452 | + * @param string $name |
|
| 453 | + */ |
|
| 450 | 454 | public function get_callable( $name ) { |
| 451 | 455 | $value = get_option( 'jetpack_' . $name ); |
| 452 | 456 | |
@@ -738,6 +742,9 @@ discard block |
||
| 738 | 742 | return $histogram; |
| 739 | 743 | } |
| 740 | 744 | |
| 745 | + /** |
|
| 746 | + * @param string|null $id_column |
|
| 747 | + */ |
|
| 741 | 748 | private function table_checksum( $table, $columns, $id_column, $where_sql = '1=1', $min_id = null, $max_id = null, $strip_non_ascii = true, $salt = '' ) { |
| 742 | 749 | global $wpdb; |
| 743 | 750 | |
@@ -791,6 +798,9 @@ discard block |
||
| 791 | 798 | return 'sum'; |
| 792 | 799 | } |
| 793 | 800 | |
| 801 | + /** |
|
| 802 | + * @param string $where_sql |
|
| 803 | + */ |
|
| 794 | 804 | private function meta_count( $table, $where_sql, $min_id, $max_id ) { |
| 795 | 805 | global $wpdb; |
| 796 | 806 | |
@@ -22,7 +22,7 @@ |
||
| 22 | 22 | /** |
| 23 | 23 | * Converts GlotPress URL into a GlotPress API URL |
| 24 | 24 | * |
| 25 | - * @param sring $url URL |
|
| 25 | + * @param string $url URL |
|
| 26 | 26 | * @return sstring API URL |
| 27 | 27 | */ |
| 28 | 28 | function apize_url( $url ) { |
@@ -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 ) { |