ThemeAvenue /
BetterOptin
Complex classes like BetterOptin 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 BetterOptin, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 39 | final class BetterOptin { |
||
| 40 | |||
| 41 | /** |
||
| 42 | * @var BetterOptin Holds the unique instance of BetterOptin |
||
| 43 | * @since 2.0 |
||
| 44 | */ |
||
| 45 | private static $instance; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Possible error message. |
||
| 49 | * |
||
| 50 | * @since 2.0 |
||
| 51 | * @var null|WP_Error |
||
| 52 | */ |
||
| 53 | protected $error = null; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Instantiate and return the unique BetterOptin object |
||
| 57 | * |
||
| 58 | * @since 2.0 |
||
| 59 | * @return object BetterOptin Unique instance of BetterOptin |
||
| 60 | */ |
||
| 61 | public static function instance() { |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Instantiate the plugin |
||
| 78 | * |
||
| 79 | * @since 2.0 |
||
| 80 | * @return void |
||
| 81 | */ |
||
| 82 | private function init() { |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Throw error on object clone |
||
| 113 | * |
||
| 114 | * The whole idea of the singleton design pattern is that there is a single |
||
| 115 | * object therefore, we don't want the object to be cloned. |
||
| 116 | * |
||
| 117 | * @since 2.0 |
||
| 118 | * @return void |
||
| 119 | */ |
||
| 120 | public function __clone() { |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Disable unserializing of the class |
||
| 127 | * |
||
| 128 | * @since 2.0 |
||
| 129 | * @return void |
||
| 130 | */ |
||
| 131 | public function __wakeup() { |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Setup all plugin constants |
||
| 138 | * |
||
| 139 | * @since 2.0 |
||
| 140 | * @return void |
||
| 141 | */ |
||
| 142 | private function setup_constants() { |
||
| 150 | |||
| 151 | private function are_dependencies_loaded() { |
||
| 154 | |||
| 155 | /** |
||
| 156 | * Add error. |
||
| 157 | * |
||
| 158 | * Add a new error to the WP_Error object |
||
| 159 | * and create the object if it doesn't exist yet. |
||
| 160 | * |
||
| 161 | * @since 2.0 |
||
| 162 | * |
||
| 163 | * @param string $message Error message to add |
||
| 164 | * |
||
| 165 | * @return void |
||
| 166 | */ |
||
| 167 | private function add_error( $message ) { |
||
| 176 | |||
| 177 | /** |
||
| 178 | * Display error. |
||
| 179 | * |
||
| 180 | * Get all the error messages and display them |
||
| 181 | * in the admin notices. |
||
| 182 | * |
||
| 183 | * @since 2.0 |
||
| 184 | * @return void |
||
| 185 | */ |
||
| 186 | public function display_error() { |
||
| 209 | |||
| 210 | /** |
||
| 211 | * Setup the custom database table constants |
||
| 212 | * |
||
| 213 | * @since 2.0 |
||
| 214 | * @return void |
||
| 215 | */ |
||
| 216 | private function setup_database_constants() { |
||
| 226 | |||
| 227 | /** |
||
| 228 | * Include all files used sitewide |
||
| 229 | * |
||
| 230 | * @since 2.0 |
||
| 231 | * @return void |
||
| 232 | */ |
||
| 233 | private function includes() { |
||
| 253 | |||
| 254 | /** |
||
| 255 | * Include all files used in admin only |
||
| 256 | * |
||
| 257 | * @since 2.0 |
||
| 258 | * @return void |
||
| 259 | */ |
||
| 260 | private function includes_admin() { |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Load all the providers from the providers directory |
||
| 279 | * |
||
| 280 | * @since 2.0 |
||
| 281 | * @return void |
||
| 282 | */ |
||
| 283 | private function load_providers() { |
||
| 289 | |||
| 290 | /** |
||
| 291 | * Load the plugin text domain for translation. |
||
| 292 | * |
||
| 293 | * @since 1.0.0 |
||
| 294 | */ |
||
| 295 | public function load_plugin_textdomain() { |
||
| 302 | |||
| 303 | /** |
||
| 304 | * Display an admin notice if license key is missing |
||
| 305 | * |
||
| 306 | * @since 2.0 |
||
| 307 | * @return void |
||
| 308 | */ |
||
| 309 | public function license_notification() { |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Make sure a provider is selected for the lead collection |
||
| 332 | * |
||
| 333 | * @since 2.0 |
||
| 334 | * @return void |
||
| 335 | */ |
||
| 336 | public function check_provider_ready() { |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Disable WordPress auto-update if the user has the pro version |
||
| 354 | * |
||
| 355 | * For pro version, the updates will come directly from our server. |
||
| 356 | * With the custom EDD SL Updater updates should only come through https://betteropt.in |
||
| 357 | * but just to make sure nobody gets downgraded to the lite version |
||
| 358 | * we double check that no update comes from WP.org for BetterOptin. |
||
| 359 | * |
||
| 360 | * @since 2.0.3 |
||
| 361 | * |
||
| 362 | * @param object $value Auto-update object |
||
| 363 | * |
||
| 364 | * @return object |
||
| 365 | */ |
||
| 366 | public function maybe_disable_wordpress_updates( $value ) { |
||
| 408 | |||
| 409 | } |
||
| 410 | |||
| 427 | BO(); |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.