@@ -11,6 +11,9 @@ |
||
11 | 11 | private $declarations; |
12 | 12 | private $current_relative_path; |
13 | 13 | |
14 | + /** |
|
15 | + * @param $declarations |
|
16 | + */ |
|
14 | 17 | public function __construct( $current_relative_path, $declarations ) { |
15 | 18 | $this->current_relative_path = $current_relative_path; |
16 | 19 | $this->declarations = $declarations; |
@@ -14,6 +14,9 @@ discard block |
||
14 | 14 | private $product_name; |
15 | 15 | private $connection; |
16 | 16 | |
17 | + /** |
|
18 | + * @param Connection\Manager $connection |
|
19 | + */ |
|
17 | 20 | function __construct( $product_name = 'jetpack', $connection = null ) { |
18 | 21 | $this->product_name = $product_name; |
19 | 22 | $this->connection = $connection; |
@@ -60,7 +63,6 @@ discard block |
||
60 | 63 | /** |
61 | 64 | * Record an event in Tracks - this is the preferred way to record events from PHP. |
62 | 65 | * |
63 | - * @param mixed $identity username, user_id, or WP_user object |
|
64 | 66 | * @param string $event_name The name of the event |
65 | 67 | * @param array $properties Custom properties to send with the event |
66 | 68 | * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred |
@@ -176,7 +176,6 @@ discard block |
||
176 | 176 | /** |
177 | 177 | * Mock a set of filters. |
178 | 178 | * |
179 | - * @param array $args Array of filters with their arguments. |
|
180 | 179 | * @return phpmock\Mock The mock object. |
181 | 180 | */ |
182 | 181 | protected function mock_filters( $filters = array() ) { |
@@ -186,8 +185,7 @@ discard block |
||
186 | 185 | /** |
187 | 186 | * Mock a set of constants. |
188 | 187 | * |
189 | - * @param array $args Array of sets with constants and their respective values. |
|
190 | - * @return phpmock\Mock The mock object. |
|
188 | + * @return phpmock\Mock[] The mock object. |
|
191 | 189 | */ |
192 | 190 | protected function mock_constants( $constants = array() ) { |
193 | 191 | $prepare_constant = function( $constant ) { |
@@ -204,7 +202,7 @@ discard block |
||
204 | 202 | * Mock a global function and make it return a certain value. |
205 | 203 | * |
206 | 204 | * @param string $function_name Name of the function. |
207 | - * @param mixed $return_value Return value of the function. |
|
205 | + * @param string|boolean $return_value Return value of the function. |
|
208 | 206 | * @return phpmock\Mock The mock object. |
209 | 207 | */ |
210 | 208 | protected function mock_function( $function_name, $return_value = null ) { |
@@ -220,7 +218,7 @@ discard block |
||
220 | 218 | /** |
221 | 219 | * Mock $wpdb->get_var() and make it return a certain value. |
222 | 220 | * |
223 | - * @param mixed $return_value Return value of the function. |
|
221 | + * @param integer $return_value Return value of the function. |
|
224 | 222 | * @return PHPUnit\Framework\MockObject\MockObject The mock object. |
225 | 223 | */ |
226 | 224 | protected function mock_wpdb_get_var( $return_value = null ) { |
@@ -502,7 +502,7 @@ discard block |
||
502 | 502 | * @access public |
503 | 503 | * |
504 | 504 | * @param array $config Full sync configuration for this sync module. |
505 | - * @return array Number of items yet to be enqueued. |
|
505 | + * @return integer Number of items yet to be enqueued. |
|
506 | 506 | */ |
507 | 507 | public function estimate_full_sync_actions( $config ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
508 | 508 | return 1; |
@@ -522,7 +522,7 @@ discard block |
||
522 | 522 | * |
523 | 523 | * @access public |
524 | 524 | * |
525 | - * @return array Full sync actions of this module. |
|
525 | + * @return string[] Full sync actions of this module. |
|
526 | 526 | */ |
527 | 527 | public function get_full_sync_actions() { |
528 | 528 | return array( 'jetpack_full_sync_theme_data' ); |
@@ -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,11 @@ discard block |
||
58 | 61 | return false; |
59 | 62 | } |
60 | 63 | |
64 | + /** |
|
65 | + * @param string $action_name |
|
66 | + * @param string $id_field |
|
67 | + * @param string|null $where_sql |
|
68 | + */ |
|
61 | 69 | protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) { |
62 | 70 | global $wpdb; |
63 | 71 | |
@@ -111,6 +119,9 @@ discard block |
||
111 | 119 | return $chunks_with_ends; |
112 | 120 | } |
113 | 121 | |
122 | + /** |
|
123 | + * @param string $meta_type |
|
124 | + */ |
|
114 | 125 | protected function get_metadata( $ids, $meta_type, $meta_key_whitelist ) { |
115 | 126 | global $wpdb; |
116 | 127 | $table = _get_meta_table( $meta_type ); |
@@ -131,12 +142,18 @@ discard block |
||
131 | 142 | ); |
132 | 143 | } |
133 | 144 | |
145 | + /** |
|
146 | + * @param string $meta_type |
|
147 | + */ |
|
134 | 148 | public function init_listeners_for_meta_type( $meta_type, $callable ) { |
135 | 149 | add_action( "added_{$meta_type}_meta", $callable, 10, 4 ); |
136 | 150 | add_action( "updated_{$meta_type}_meta", $callable, 10, 4 ); |
137 | 151 | add_action( "deleted_{$meta_type}_meta", $callable, 10, 4 ); |
138 | 152 | } |
139 | 153 | |
154 | + /** |
|
155 | + * @param string $meta_type |
|
156 | + */ |
|
140 | 157 | public function init_meta_whitelist_handler( $meta_type, $whitelist_handler ) { |
141 | 158 | add_filter( "jetpack_sync_before_enqueue_added_{$meta_type}_meta", $whitelist_handler ); |
142 | 159 | add_filter( "jetpack_sync_before_enqueue_updated_{$meta_type}_meta", $whitelist_handler ); |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | * |
184 | 184 | * @access public |
185 | 185 | * |
186 | - * @param \WP_User $user User object. |
|
186 | + * @param \WP_User|null $user User object. |
|
187 | 187 | * @return \WP_User Expanded user object. |
188 | 188 | */ |
189 | 189 | public function expand_user( $user ) { |
@@ -614,7 +614,7 @@ discard block |
||
614 | 614 | * @todo Refactor to prepare the SQL query before executing it. |
615 | 615 | * |
616 | 616 | * @param array $config Full sync configuration for this sync module. |
617 | - * @return array Number of items yet to be enqueued. |
|
617 | + * @return integer Number of items yet to be enqueued. |
|
618 | 618 | */ |
619 | 619 | public function estimate_full_sync_actions( $config ) { |
620 | 620 | global $wpdb; |
@@ -658,7 +658,7 @@ discard block |
||
658 | 658 | * |
659 | 659 | * @access public |
660 | 660 | * |
661 | - * @return array Full sync actions of this module. |
|
661 | + * @return string[] Full sync actions of this module. |
|
662 | 662 | */ |
663 | 663 | public function get_full_sync_actions() { |
664 | 664 | return array( 'jetpack_full_sync_users' ); |
@@ -150,7 +150,7 @@ discard block |
||
150 | 150 | * |
151 | 151 | * @access public |
152 | 152 | * |
153 | - * @return array Full sync actions of this module. |
|
153 | + * @return string[] Full sync actions of this module. |
|
154 | 154 | */ |
155 | 155 | public function get_full_sync_actions() { |
156 | 156 | return array( 'jetpack_full_sync_woocommerce_order_items' ); |
@@ -246,7 +246,7 @@ discard block |
||
246 | 246 | * @todo Refactor the SQL query to use $wpdb->prepare(). |
247 | 247 | * |
248 | 248 | * @param array $config Full sync configuration for this sync module. |
249 | - * @return array Number of items yet to be enqueued. |
|
249 | + * @return integer Number of items yet to be enqueued. |
|
250 | 250 | */ |
251 | 251 | public function estimate_full_sync_actions( $config ) { |
252 | 252 | global $wpdb; |