Complex classes like Sender often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Sender, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
15 | class Sender { |
||
16 | /** |
||
17 | * Name of the option that stores the time of the next sync. |
||
18 | * |
||
19 | * @access public |
||
20 | * |
||
21 | * @var string |
||
22 | */ |
||
23 | const NEXT_SYNC_TIME_OPTION_NAME = 'jetpack_next_sync_time'; |
||
24 | |||
25 | /** |
||
26 | * Sync timeout after a WPCOM error. |
||
27 | * |
||
28 | * @access public |
||
29 | * |
||
30 | * @var int |
||
31 | */ |
||
32 | const WPCOM_ERROR_SYNC_DELAY = 60; |
||
33 | |||
34 | /** |
||
35 | * Sync timeout after a queue has been locked. |
||
36 | * |
||
37 | * @access public |
||
38 | * |
||
39 | * @var int |
||
40 | */ |
||
41 | const QUEUE_LOCKED_SYNC_DELAY = 10; |
||
42 | |||
43 | /** |
||
44 | * Maximum bytes to checkout without exceeding the memory limit. |
||
45 | * |
||
46 | * @access private |
||
47 | * |
||
48 | * @var int |
||
49 | */ |
||
50 | private $dequeue_max_bytes; |
||
51 | |||
52 | /** |
||
53 | * Maximum bytes in a single encoded item. |
||
54 | * |
||
55 | * @access private |
||
56 | * |
||
57 | * @var int |
||
58 | */ |
||
59 | private $upload_max_bytes; |
||
60 | |||
61 | /** |
||
62 | * Maximum number of sync items in a single action. |
||
63 | * |
||
64 | * @access private |
||
65 | * |
||
66 | * @var int |
||
67 | */ |
||
68 | private $upload_max_rows; |
||
69 | |||
70 | /** |
||
71 | * Maximum time for perfirming a checkout of items from the queue (in seconds). |
||
72 | * |
||
73 | * @access private |
||
74 | * |
||
75 | * @var int |
||
76 | */ |
||
77 | private $max_dequeue_time; |
||
78 | |||
79 | /** |
||
80 | * How many seconds to wait after sending sync items after exceeding the sync wait threshold (in seconds). |
||
81 | * |
||
82 | * @access private |
||
83 | * |
||
84 | * @var int |
||
85 | */ |
||
86 | private $sync_wait_time; |
||
87 | |||
88 | /** |
||
89 | * How much maximum time to wait for the checkout to finish (in seconds). |
||
90 | * |
||
91 | * @access private |
||
92 | * |
||
93 | * @var int |
||
94 | */ |
||
95 | private $sync_wait_threshold; |
||
96 | |||
97 | /** |
||
98 | * How much maximum time to wait for the sync items to be queued for sending (in seconds). |
||
99 | * |
||
100 | * @access private |
||
101 | * |
||
102 | * @var int |
||
103 | */ |
||
104 | private $enqueue_wait_time; |
||
105 | |||
106 | /** |
||
107 | * Incremental sync queue object. |
||
108 | * |
||
109 | * @access private |
||
110 | * |
||
111 | * @var Automattic\Jetpack\Sync\Queue |
||
112 | */ |
||
113 | private $sync_queue; |
||
114 | |||
115 | /** |
||
116 | * Full sync queue object. |
||
117 | * |
||
118 | * @access private |
||
119 | * |
||
120 | * @var Automattic\Jetpack\Sync\Queue |
||
121 | */ |
||
122 | private $full_sync_queue; |
||
123 | |||
124 | /** |
||
125 | * Codec object for encoding and decoding sync items. |
||
126 | * |
||
127 | * @access private |
||
128 | * |
||
129 | * @var Automattic\Jetpack\Sync\Codec_Interface |
||
130 | */ |
||
131 | private $codec; |
||
132 | |||
133 | /** |
||
134 | * The current user before we change or clear it. |
||
135 | * |
||
136 | * @access private |
||
137 | * |
||
138 | * @var \WP_User |
||
139 | */ |
||
140 | private $old_user; |
||
141 | |||
142 | /** |
||
143 | * Container for the singleton instance of this class. |
||
144 | * |
||
145 | * @access private |
||
146 | * @static |
||
147 | * |
||
148 | * @var Automattic\Jetpack\Sync\Sender |
||
149 | */ |
||
150 | private static $instance; |
||
151 | |||
152 | /** |
||
153 | * Retrieve the singleton instance of this class. |
||
154 | * |
||
155 | * @access public |
||
156 | * @static |
||
157 | * |
||
158 | * @return Automattic\Jetpack\Sync\Sender |
||
159 | */ |
||
160 | public static function get_instance() { |
||
167 | |||
168 | /** |
||
169 | * Constructor. |
||
170 | * This is necessary because you can't use "new" when you declare instance properties >:( |
||
171 | * |
||
172 | * @access protected |
||
173 | * @static |
||
174 | */ |
||
175 | protected function __construct() { |
||
179 | |||
180 | /** |
||
181 | * Initialize the sender. |
||
182 | * Prepares the current user and initializes all sync modules. |
||
183 | * |
||
184 | * @access private |
||
185 | */ |
||
186 | private function init() { |
||
194 | |||
195 | /** |
||
196 | * Detect if this is a XMLRPC request with a valid signature. |
||
197 | * If so, changes the user to the new one. |
||
198 | * |
||
199 | * @access public |
||
200 | */ |
||
201 | public function maybe_set_user_from_token() { |
||
212 | |||
213 | /** |
||
214 | * If we used to have a previous current user, revert back to it. |
||
215 | * |
||
216 | * @access public |
||
217 | */ |
||
218 | public function maybe_clear_user_from_token() { |
||
223 | |||
224 | /** |
||
225 | * Retrieve the next sync time. |
||
226 | * |
||
227 | * @access public |
||
228 | * |
||
229 | * @param string $queue_name Name of the queue. |
||
230 | * @return float Timestamp of the next sync. |
||
231 | */ |
||
232 | public function get_next_sync_time( $queue_name ) { |
||
235 | |||
236 | /** |
||
237 | * Set the next sync time. |
||
238 | * |
||
239 | * @access public |
||
240 | * |
||
241 | * @param int $time Timestamp of the next sync. |
||
242 | * @param string $queue_name Name of the queue. |
||
243 | * @return boolean True if update was successful, false otherwise. |
||
244 | */ |
||
245 | public function set_next_sync_time( $time, $queue_name ) { |
||
248 | |||
249 | /** |
||
250 | * Trigger a full sync. |
||
251 | * |
||
252 | * @access public |
||
253 | * |
||
254 | * @return boolean|\WP_Error True if this sync sending was successful, error object otherwise. |
||
255 | */ |
||
256 | public function do_full_sync() { |
||
263 | |||
264 | /** |
||
265 | * Enqueue the next sync items for sending. |
||
266 | * Will not be done if the current request is a WP import one. |
||
267 | * Will be delayed until the next sync time comes. |
||
268 | * |
||
269 | * @access private |
||
270 | */ |
||
271 | private function continue_full_sync_enqueue() { |
||
284 | |||
285 | /** |
||
286 | * Trigger incremental sync. |
||
287 | * |
||
288 | * @access public |
||
289 | * |
||
290 | * @return boolean|\WP_Error True if this sync sending was successful, error object otherwise. |
||
291 | */ |
||
292 | public function do_sync() { |
||
295 | |||
296 | /** |
||
297 | * Trigger sync for a certain sync queue. |
||
298 | * Responsible for setting next sync time. |
||
299 | * Will not be delayed if the current request is a WP import one. |
||
300 | * Will be delayed until the next sync time comes. |
||
301 | * |
||
302 | * @access public |
||
303 | * |
||
304 | * @param Automattic\Jetpack\Sync\Queue $queue Queue object. |
||
305 | * @return boolean|\WP_Error True if this sync sending was successful, error object otherwise. |
||
306 | */ |
||
307 | public function do_sync_and_set_delays( $queue ) { |
||
346 | |||
347 | /** |
||
348 | * Retrieve the next sync items to send. |
||
349 | * |
||
350 | * @access public |
||
351 | * |
||
352 | * @param Automattic\Jetpack\Sync\Queue_Buffer $buffer Queue buffer object. |
||
353 | * @param boolean $encode Whether to encode the items. |
||
354 | * @return array Sync items to send. |
||
355 | */ |
||
356 | public function get_items_to_send( $buffer, $encode = true ) { |
||
403 | |||
404 | /** |
||
405 | * If supported, flush all response data to the client and finish the request. |
||
406 | * This allows for time consuming tasks to be performed without leaving the connection open. |
||
407 | * |
||
408 | * @access private |
||
409 | */ |
||
410 | private function fastcgi_finish_request() { |
||
415 | |||
416 | /** |
||
417 | * Perform sync for a certain sync queue. |
||
418 | * |
||
419 | * @access public |
||
420 | * |
||
421 | * @param Automattic\Jetpack\Sync\Queue $queue Queue object. |
||
422 | * @return boolean|\WP_Error True if this sync sending was successful, error object otherwise. |
||
423 | */ |
||
424 | public function do_sync_for_queue( $queue ) { |
||
519 | |||
520 | /** |
||
521 | * Returns any object that is able to be synced. |
||
522 | * |
||
523 | * @access public |
||
524 | * |
||
525 | * @param array $args the synchronized object parameters. |
||
526 | * @return string Encoded sync object. |
||
527 | */ |
||
528 | public function sync_object( $args ) { |
||
537 | |||
538 | /** |
||
539 | * Register additional sync XML-RPC methods available to Jetpack for authenticated users. |
||
540 | * |
||
541 | * @access public |
||
542 | * @since 7.8 |
||
543 | * |
||
544 | * @param array $jetpack_methods XML-RPC methods available to the Jetpack Server. |
||
545 | * @return array Filtered XML-RPC methods. |
||
546 | */ |
||
547 | public function register_jetpack_xmlrpc_methods( $jetpack_methods ) { |
||
551 | |||
552 | /** |
||
553 | * Get the incremental sync queue object. |
||
554 | * |
||
555 | * @access public |
||
556 | * |
||
557 | * @return Automattic\Jetpack\Sync\Queue Queue object. |
||
558 | */ |
||
559 | public function get_sync_queue() { |
||
562 | |||
563 | /** |
||
564 | * Get the full sync queue object. |
||
565 | * |
||
566 | * @access public |
||
567 | * |
||
568 | * @return Automattic\Jetpack\Sync\Queue Queue object. |
||
569 | */ |
||
570 | public function get_full_sync_queue() { |
||
573 | |||
574 | /** |
||
575 | * Get the codec object. |
||
576 | * |
||
577 | * @access public |
||
578 | * |
||
579 | * @return Automattic\Jetpack\Sync\Codec_Interface Codec object. |
||
580 | */ |
||
581 | public function get_codec() { |
||
584 | |||
585 | /** |
||
586 | * Determine the codec object. |
||
587 | * Use gzip deflate if supported. |
||
588 | * |
||
589 | * @access public |
||
590 | */ |
||
591 | public function set_codec() { |
||
598 | |||
599 | /** |
||
600 | * Compute and send all the checksums. |
||
601 | * |
||
602 | * @access public |
||
603 | */ |
||
604 | public function send_checksum() { |
||
608 | |||
609 | /** |
||
610 | * Reset the incremental sync queue. |
||
611 | * |
||
612 | * @access public |
||
613 | */ |
||
614 | public function reset_sync_queue() { |
||
617 | |||
618 | /** |
||
619 | * Reset the full sync queue. |
||
620 | * |
||
621 | * @access public |
||
622 | */ |
||
623 | public function reset_full_sync_queue() { |
||
626 | |||
627 | /** |
||
628 | * Set the maximum bytes to checkout without exceeding the memory limit. |
||
629 | * |
||
630 | * @access public |
||
631 | * |
||
632 | * @param int $size Maximum bytes to checkout. |
||
633 | */ |
||
634 | public function set_dequeue_max_bytes( $size ) { |
||
637 | |||
638 | /** |
||
639 | * Set the maximum bytes in a single encoded item. |
||
640 | * |
||
641 | * @access public |
||
642 | * |
||
643 | * @param int $max_bytes Maximum bytes in a single encoded item. |
||
644 | */ |
||
645 | public function set_upload_max_bytes( $max_bytes ) { |
||
648 | |||
649 | /** |
||
650 | * Set the maximum number of sync items in a single action. |
||
651 | * |
||
652 | * @access public |
||
653 | * |
||
654 | * @param int $max_rows Maximum number of sync items. |
||
655 | */ |
||
656 | public function set_upload_max_rows( $max_rows ) { |
||
659 | |||
660 | /** |
||
661 | * Set the sync wait time (in seconds). |
||
662 | * |
||
663 | * @access public |
||
664 | * |
||
665 | * @param int $seconds Sync wait time. |
||
666 | */ |
||
667 | public function set_sync_wait_time( $seconds ) { |
||
670 | |||
671 | /** |
||
672 | * Get current sync wait time (in seconds). |
||
673 | * |
||
674 | * @access public |
||
675 | * |
||
676 | * @return int Sync wait time. |
||
677 | */ |
||
678 | public function get_sync_wait_time() { |
||
681 | |||
682 | /** |
||
683 | * Set the enqueue wait time (in seconds). |
||
684 | * |
||
685 | * @access public |
||
686 | * |
||
687 | * @param int $seconds Enqueue wait time. |
||
688 | */ |
||
689 | public function set_enqueue_wait_time( $seconds ) { |
||
692 | |||
693 | /** |
||
694 | * Get current enqueue wait time (in seconds). |
||
695 | * |
||
696 | * @access public |
||
697 | * |
||
698 | * @return int Enqueue wait time. |
||
699 | */ |
||
700 | public function get_enqueue_wait_time() { |
||
703 | |||
704 | /** |
||
705 | * Set the sync wait threshold (in seconds). |
||
706 | * |
||
707 | * @access public |
||
708 | * |
||
709 | * @param int $seconds Sync wait threshold. |
||
710 | */ |
||
711 | public function set_sync_wait_threshold( $seconds ) { |
||
714 | |||
715 | /** |
||
716 | * Get current sync wait threshold (in seconds). |
||
717 | * |
||
718 | * @access public |
||
719 | * |
||
720 | * @return int Sync wait threshold. |
||
721 | */ |
||
722 | public function get_sync_wait_threshold() { |
||
725 | |||
726 | /** |
||
727 | * Set the maximum time for perfirming a checkout of items from the queue (in seconds). |
||
728 | * |
||
729 | * @access public |
||
730 | * |
||
731 | * @param int $seconds Maximum dequeue time. |
||
732 | */ |
||
733 | public function set_max_dequeue_time( $seconds ) { |
||
736 | |||
737 | /** |
||
738 | * Initialize the sync queues, codec and set the default settings. |
||
739 | * |
||
740 | * @access public |
||
741 | */ |
||
742 | public function set_defaults() { |
||
758 | |||
759 | /** |
||
760 | * Reset sync queues, modules and settings. |
||
761 | * |
||
762 | * @access public |
||
763 | */ |
||
764 | public function reset_data() { |
||
778 | |||
779 | /** |
||
780 | * Perform cleanup at the event of plugin uninstallation. |
||
781 | * |
||
782 | * @access public |
||
783 | */ |
||
784 | public function uninstall() { |
||
795 | } |
||
796 |
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..