Complex classes like CMB2_Ajax 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 CMB2_Ajax, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
14 | class CMB2_Ajax { |
||
|
|||
15 | |||
16 | // Whether to hijack the oembed cache system |
||
17 | protected $hijack = false; |
||
18 | protected $object_id = 0; |
||
19 | protected $embed_args = array(); |
||
20 | protected $object_type = 'post'; |
||
21 | protected $ajax_update = false; |
||
22 | |||
23 | /** |
||
24 | * Instance of this class |
||
25 | * @since 2.2.2 |
||
26 | * @var object |
||
27 | */ |
||
28 | protected static $instance; |
||
29 | |||
30 | /** |
||
31 | * Get the singleton instance of this class |
||
32 | * @since 2.2.2 |
||
33 | * @return object |
||
34 | */ |
||
35 | 4 | public static function get_instance() { |
|
42 | |||
43 | /** |
||
44 | * Constructor |
||
45 | * @since 2.2.0 |
||
46 | */ |
||
47 | 1 | protected function __construct() { |
|
53 | |||
54 | /** |
||
55 | * Handles our oEmbed ajax request |
||
56 | * @since 0.9.5 |
||
57 | * @return object oEmbed embed code | fallback | error message |
||
58 | */ |
||
59 | 1 | public function oembed_handler() { |
|
60 | |||
61 | // Verify our nonce |
||
62 | if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) { |
||
63 | die(); |
||
64 | } |
||
65 | |||
66 | // Sanitize our search string |
||
67 | 1 | $oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] ); |
|
68 | |||
69 | // Send back error if empty |
||
70 | if ( empty( $oembed_string ) ) { |
||
71 | wp_send_json_error( '<p class="ui-state-error-text">' . __( 'Please Try Again', 'cmb2' ) . '</p>' ); |
||
72 | } |
||
73 | |||
74 | // Set width of embed |
||
75 | $embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640'; |
||
76 | |||
77 | // Set url |
||
78 | $oembed_url = esc_url( $oembed_string ); |
||
79 | |||
80 | // Set args |
||
81 | $embed_args = array( 'width' => $embed_width ); |
||
82 | |||
83 | $this->ajax_update = true; |
||
84 | |||
85 | // Get embed code (or fallback link) |
||
86 | $html = $this->get_oembed( array( |
||
87 | 'url' => $oembed_url, |
||
88 | 'object_id' => $_REQUEST['object_id'], |
||
89 | 'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post', |
||
90 | 'oembed_args' => $embed_args, |
||
91 | 'field_id' => $_REQUEST['field_id'], |
||
92 | ) ); |
||
93 | |||
94 | wp_send_json_success( $html ); |
||
95 | } |
||
96 | |||
97 | /** |
||
98 | * Retrieves oEmbed from url/object ID |
||
99 | * @since 0.9.5 |
||
100 | * @param array $args Arguments for method |
||
101 | * @return string html markup with embed or fallback |
||
102 | */ |
||
103 | 2 | public function get_oembed( $args ) { |
|
168 | |||
169 | /** |
||
170 | * Hijacks retrieving of cached oEmbed. |
||
171 | * Returns cached data from relevant object metadata (vs postmeta) |
||
172 | * |
||
173 | * @since 0.9.5 |
||
174 | * @param boolean $check Whether to retrieve postmeta or override |
||
175 | * @param int $object_id Object ID |
||
176 | * @param string $meta_key Object metakey |
||
177 | * @return mixed Object's oEmbed cached data |
||
178 | */ |
||
179 | 68 | public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) { |
|
190 | |||
191 | /** |
||
192 | * Hijacks saving of cached oEmbed. |
||
193 | * Saves cached data to relevant object metadata (vs postmeta) |
||
194 | * |
||
195 | * @since 0.9.5 |
||
196 | * @param boolean $check Whether to continue setting postmeta |
||
197 | * @param int $object_id Object ID to get postmeta from |
||
198 | * @param string $meta_key Postmeta's key |
||
199 | * @param mixed $meta_value Value of the postmeta to be saved |
||
200 | * @return boolean Whether to continue setting |
||
201 | */ |
||
202 | 52 | public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) { |
|
218 | |||
219 | /** |
||
220 | * Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta) |
||
221 | * |
||
222 | * @since 1.3.0 |
||
223 | * @param string $meta_key Postmeta's key |
||
224 | * @param mixed $meta_value (Optional) value of the postmeta to be saved |
||
225 | */ |
||
226 | 2 | protected function cache_action( $meta_key ) { |
|
252 | |||
253 | /** |
||
254 | * Hooks in when options-page data is saved to clean stale |
||
255 | * oembed cache data from the option value. |
||
256 | * @since 2.2.0 |
||
257 | * @param string $option_key The options-page option key |
||
258 | * @return void |
||
259 | */ |
||
260 | 1 | public static function clean_stale_options_page_oembeds( $option_key ) { |
|
292 | |||
293 | } |
||
294 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.