WebDevStudios /
CMB2
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 | 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 ) { |
|
| 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 ) { |
|
| 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 | 109 | 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 | 91 | 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 | * @param mixed $meta_value (Optional) value of the postmeta to be saved |
||
| 244 | */ |
||
| 245 | 3 | protected function cache_action( $meta_key ) { |
|
| 271 | |||
| 272 | /** |
||
| 273 | * Hooks in when options-page data is saved to clean stale |
||
| 274 | * oembed cache data from the option value. |
||
| 275 | * @since 2.2.0 |
||
| 276 | * @param string $option_key The options-page option key |
||
| 277 | * @return void |
||
| 278 | */ |
||
| 279 | 1 | public static function clean_stale_options_page_oembeds( $option_key ) { |
|
| 311 | |||
| 312 | } |
||
| 313 |
Loading history...
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.