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 CMB2_Ajax |
||
| 34 | */ |
||
| 35 | 5 | public static function get_instance() { |
|
| 36 | 5 | if ( ! ( self::$instance instanceof self ) ) { |
|
| 37 | 1 | self::$instance = new self(); |
|
| 38 | 1 | } |
|
| 39 | |||
| 40 | 5 | return self::$instance; |
|
| 41 | } |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Constructor |
||
| 45 | * @since 2.2.0 |
||
| 46 | */ |
||
| 47 | 1 | protected function __construct() { |
|
| 48 | 1 | add_action( 'wp_ajax_cmb2_oembed_handler', array( $this, 'oembed_handler' ) ); |
|
| 49 | 1 | add_action( 'wp_ajax_nopriv_cmb2_oembed_handler', array( $this, 'oembed_handler' ) ); |
|
| 50 | // Need to occasionally clean stale oembed cache data from the option value. |
||
| 51 | 1 | add_action( 'cmb2_save_options-page_fields', array( __CLASS__, 'clean_stale_options_page_oembeds' ) ); |
|
| 52 | 1 | } |
|
| 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() { |
|
| 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 | 3 | public function get_oembed_no_edit( $args ) { |
|
| 104 | 3 | global $wp_embed; |
|
| 105 | |||
| 106 | 3 | $oembed_url = esc_url( $args['url'] ); |
|
| 107 | |||
| 108 | // Sanitize object_id |
||
| 109 | 3 | $this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] ); |
|
| 110 | |||
| 111 | 3 | $args = wp_parse_args( $args, array( |
|
| 112 | 3 | 'object_type' => 'post', |
|
| 113 | 3 | 'oembed_args' => $this->embed_args, |
|
| 114 | 3 | 'field_id' => false, |
|
| 115 | 3 | 'wp_error' => false, |
|
| 116 | 3 | ) ); |
|
| 117 | |||
| 118 | 3 | $this->embed_args =& $args; |
|
| 119 | |||
| 120 | /** |
||
| 121 | * Set the post_ID so oEmbed won't fail |
||
| 122 | * wp-includes/class-wp-embed.php, WP_Embed::shortcode() |
||
| 123 | */ |
||
| 124 | 3 | $wp_embed->post_ID = $this->object_id; |
|
| 125 | |||
| 126 | // Special scenario if NOT a post object |
||
| 127 | 3 | if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) { |
|
| 128 | |||
| 129 | 1 | if ( 'options-page' == $args['object_type'] ) { |
|
| 130 | |||
| 131 | // Bogus id to pass some numeric checks. Issue with a VERY large WP install? |
||
| 132 | 1 | $wp_embed->post_ID = 1987645321; |
|
| 133 | 1 | } |
|
| 134 | |||
| 135 | // Ok, we need to hijack the oembed cache system |
||
| 136 | 1 | $this->hijack = true; |
|
| 137 | 1 | $this->object_type = $args['object_type']; |
|
| 138 | |||
| 139 | // Gets ombed cache from our object's meta (vs postmeta) |
||
| 140 | 1 | add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 ); |
|
| 141 | |||
| 142 | // Sets ombed cache in our object's meta (vs postmeta) |
||
| 143 | 1 | add_filter( 'update_post_metadata', array( $this, 'hijack_oembed_cache_set' ), 10, 4 ); |
|
| 144 | |||
| 145 | 1 | } |
|
| 146 | |||
| 147 | 3 | $embed_args = ''; |
|
| 148 | |||
| 149 | 3 | foreach ( $args['oembed_args'] as $key => $val ) { |
|
| 150 | 3 | $embed_args .= " $key=\"$val\""; |
|
| 151 | 3 | } |
|
| 152 | |||
| 153 | // Ping WordPress for an embed |
||
| 154 | 3 | $embed = $wp_embed->run_shortcode( '[embed' . $embed_args . ']' . $oembed_url . '[/embed]' ); |
|
| 155 | |||
| 156 | // Fallback that WordPress creates when no oEmbed was found |
||
| 157 | 3 | $fallback = $wp_embed->maybe_make_link( $oembed_url ); |
|
| 158 | |||
| 159 | 3 | return compact( 'embed', 'fallback', 'args' ); |
|
| 160 | } |
||
| 161 | |||
| 162 | /** |
||
| 163 | * Retrieves oEmbed from url/object ID |
||
| 164 | * @since 0.9.5 |
||
| 165 | * @param array $args Arguments for method |
||
| 166 | * @return string html markup with embed or fallback |
||
| 167 | */ |
||
| 168 | 2 | public function get_oembed( $args ) { |
|
| 169 | 2 | $oembed = $this->get_oembed_no_edit( $args ); |
|
| 170 | |||
| 171 | // Send back our embed |
||
| 172 | 2 | if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) { |
|
| 173 | 2 | return '<div class="cmb2-oembed embed-status">' . $oembed['embed'] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed['args']['field_id'] . '">' . esc_html__( 'Remove Embed', 'cmb2' ) . '</a></p></div>'; |
|
| 174 | } |
||
| 175 | |||
| 176 | // Otherwise, send back error info that no oEmbeds were found |
||
| 177 | 1 | return sprintf( |
|
| 178 | 1 | '<p class="ui-state-error-text">%s</p>', |
|
| 179 | 1 | sprintf( |
|
| 180 | /* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */ |
||
| 181 | 1 | esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ), |
|
| 182 | 1 | $oembed['fallback'], |
|
| 183 | '<a href="https://codex.wordpress.org/Embeds" target="_blank">codex.wordpress.org/Embeds</a>' |
||
| 184 | 1 | ) |
|
| 185 | 1 | ); |
|
| 186 | } |
||
| 187 | |||
| 188 | /** |
||
| 189 | * Hijacks retrieving of cached oEmbed. |
||
| 190 | * Returns cached data from relevant object metadata (vs postmeta) |
||
| 191 | * |
||
| 192 | * @since 0.9.5 |
||
| 193 | * @param boolean $check Whether to retrieve postmeta or override |
||
| 194 | * @param int $object_id Object ID |
||
| 195 | * @param string $meta_key Object metakey |
||
| 196 | * @return mixed Object's oEmbed cached data |
||
| 197 | */ |
||
| 198 | 111 | public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) { |
|
| 209 | |||
| 210 | /** |
||
| 211 | * Hijacks saving of cached oEmbed. |
||
| 212 | * Saves cached data to relevant object metadata (vs postmeta) |
||
| 213 | * |
||
| 214 | * @since 0.9.5 |
||
| 215 | * @param boolean $check Whether to continue setting postmeta |
||
| 216 | * @param int $object_id Object ID to get postmeta from |
||
| 217 | * @param string $meta_key Postmeta's key |
||
| 218 | * @param mixed $meta_value Value of the postmeta to be saved |
||
| 219 | * @return boolean Whether to continue setting |
||
| 220 | */ |
||
| 221 | 93 | public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) { |
|
| 237 | |||
| 238 | /** |
||
| 239 | * Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta) |
||
| 240 | * |
||
| 241 | * @since 1.3.0 |
||
| 242 | * @param string $meta_key Postmeta's key |
||
| 243 | */ |
||
| 244 | 3 | protected function cache_action( $meta_key ) { |
|
| 270 | |||
| 271 | /** |
||
| 272 | * Hooks in when options-page data is saved to clean stale |
||
| 273 | * oembed cache data from the option value. |
||
| 274 | * @since 2.2.0 |
||
| 275 | * @param string $option_key The options-page option key |
||
| 276 | * @return void |
||
| 277 | */ |
||
| 278 | 1 | public static function clean_stale_options_page_oembeds( $option_key ) { |
|
| 311 | |||
| 312 | } |
||
| 313 |
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.