Automattic /
jetpack
Complex classes like WordAds 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 WordAds, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class WordAds { |
||
| 15 | |||
| 16 | public $params = null; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * The different supported ad types. |
||
| 20 | * v0.1 - mrec only for now |
||
| 21 | * @var array |
||
| 22 | */ |
||
| 23 | public static $ad_tag_ids = array( |
||
| 24 | 'mrec' => array( |
||
| 25 | 'tag' => '300x250_mediumrectangle', |
||
| 26 | 'height' => '250', |
||
| 27 | 'width' => '300', |
||
| 28 | ), |
||
| 29 | 'lrec' => array( |
||
| 30 | 'tag' => '336x280_largerectangle', |
||
| 31 | 'height' => '280', |
||
| 32 | 'width' => '336', |
||
| 33 | ), |
||
| 34 | 'leaderboard' => array( |
||
| 35 | 'tag' => '728x90_leaderboard', |
||
| 36 | 'height' => '90', |
||
| 37 | 'width' => '728', |
||
| 38 | ), |
||
| 39 | 'wideskyscraper' => array( |
||
| 40 | 'tag' => '160x600_wideskyscraper', |
||
| 41 | 'height' => '600', |
||
| 42 | 'width' => '160', |
||
| 43 | ), |
||
| 44 | ); |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Convenience function for grabbing options from params->options |
||
| 48 | * @param string $option the option to grab |
||
| 49 | * @param mixed $default (optional) |
||
| 50 | * @return option or $default if not set |
||
| 51 | * |
||
| 52 | * @since 4.5.0 |
||
| 53 | */ |
||
| 54 | function option( $option, $default = false ) { |
||
| 55 | if ( ! isset( $this->params->options[ $option ] ) ) { |
||
| 56 | return $default; |
||
| 57 | } |
||
| 58 | |||
| 59 | return $this->params->options[ $option ]; |
||
| 60 | } |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Instantiate the plugin |
||
| 64 | * |
||
| 65 | * @since 4.5.0 |
||
| 66 | */ |
||
| 67 | function __construct() { |
||
| 68 | add_action( 'init', array( $this, 'init' ) ); |
||
| 69 | } |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Code to run on WordPress 'init' hook |
||
| 73 | * |
||
| 74 | * @since 4.5.0 |
||
| 75 | */ |
||
| 76 | function init() { |
||
| 77 | // bail on infinite scroll |
||
| 78 | if ( self::is_infinite_scroll() ) { |
||
| 79 | return; |
||
| 80 | } |
||
| 81 | |||
| 82 | require_once( WORDADS_ROOT . '/php/params.php' ); |
||
| 83 | $this->params = new WordAds_Params(); |
||
| 84 | |||
| 85 | if ( is_admin() ) { |
||
| 86 | require_once( WORDADS_ROOT . '/php/admin.php' ); |
||
| 87 | return; |
||
| 88 | } |
||
| 89 | |||
| 90 | if ( $this->should_bail() ) { |
||
| 91 | return; |
||
| 92 | } |
||
| 93 | |||
| 94 | $this->insert_adcode(); |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Check for Jetpack's The_Neverending_Home_Page and use got_infinity |
||
| 99 | * @return boolean true if load came from infinite scroll |
||
| 100 | * |
||
| 101 | * @since 4.5.0 |
||
| 102 | */ |
||
| 103 | public static function is_infinite_scroll() { |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Add the actions/filters to insert the ads. Checks for mobile or desktop. |
||
| 109 | * |
||
| 110 | * @since 4.5.0 |
||
| 111 | */ |
||
| 112 | private function insert_adcode() { |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Register desktop scripts and styles |
||
| 135 | * |
||
| 136 | * @since 4.5.0 |
||
| 137 | */ |
||
| 138 | function enqueue_scripts() { |
||
| 146 | |||
| 147 | /** |
||
| 148 | * IPONWEB metadata used by the various scripts |
||
| 149 | * @return [type] [description] |
||
|
|
|||
| 150 | */ |
||
| 151 | function insert_head_meta() { |
||
| 167 | |||
| 168 | /** |
||
| 169 | * IPONWEB scripts in <head> |
||
| 170 | * |
||
| 171 | * @since 4.5.0 |
||
| 172 | */ |
||
| 173 | function insert_head_iponweb() { |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Insert the ad onto the page |
||
| 200 | * |
||
| 201 | * @since 4.5.0 |
||
| 202 | */ |
||
| 203 | function insert_ad( $content ) { |
||
| 225 | |||
| 226 | /** |
||
| 227 | * Inserts ad into header |
||
| 228 | * |
||
| 229 | * @since 4.5.0 |
||
| 230 | */ |
||
| 231 | function insert_header_ad() { |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Special cases for inserting header unit via jQuery |
||
| 251 | * |
||
| 252 | * @since 4.5.0 |
||
| 253 | */ |
||
| 254 | function insert_header_ad_special() { |
||
| 289 | |||
| 290 | /** |
||
| 291 | * Get the ad for the spot and type. |
||
| 292 | * @param string $spot top, side, or belowpost |
||
| 293 | * @param string $type iponweb or adsense |
||
| 294 | */ |
||
| 295 | function get_ad( $spot, $type = 'iponweb' ) { |
||
| 370 | |||
| 371 | /** |
||
| 372 | * Get Criteo Acceptable Ad unit |
||
| 373 | * @param string $unit mrec, mrec2, widesky, top, top_mrec |
||
| 374 | * |
||
| 375 | * @since 5.3 |
||
| 376 | */ |
||
| 377 | public function get_adblocker_ad( $unit = 'mrec' ) { |
||
| 412 | |||
| 413 | /** |
||
| 414 | * Check the reasons to bail before we attempt to insert ads. |
||
| 415 | * @return true if we should bail (don't insert ads) |
||
| 416 | * |
||
| 417 | * @since 4.5.0 |
||
| 418 | */ |
||
| 419 | public function should_bail() { |
||
| 422 | |||
| 423 | /** |
||
| 424 | * Returns markup for HTML5 house ad base on unit |
||
| 425 | * @param string $unit mrec, widesky, or leaderboard |
||
| 426 | * @return string markup for HTML5 house ad |
||
| 427 | * |
||
| 428 | * @since 4.7.0 |
||
| 429 | */ |
||
| 430 | public function get_house_ad( $unit = 'mrec' ) { |
||
| 457 | |||
| 458 | /** |
||
| 459 | * Activation hook actions |
||
| 460 | * |
||
| 461 | * @since 4.5.0 |
||
| 462 | */ |
||
| 463 | public static function activate() { |
||
| 466 | } |
||
| 467 | |||
| 474 |
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.