eventespresso /
event-espresso-core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like EEH_Debug_Tools 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 EEH_Debug_Tools, and based on these observations, apply Extract Interface, too.
| 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
||
| 11 | class EEH_Debug_Tools{ |
||
| 12 | |||
| 13 | /** |
||
| 14 | * instance of the EEH_Autoloader object |
||
| 15 | * @var $_instance |
||
| 16 | * @access private |
||
| 17 | */ |
||
| 18 | private static $_instance = NULL; |
||
| 19 | |||
| 20 | /** |
||
| 21 | * array containing the start time for the timers |
||
| 22 | */ |
||
| 23 | private $_start_times; |
||
| 24 | /** |
||
| 25 | * array containing all the timer'd times, which can be outputted via show_times() |
||
| 26 | */ |
||
| 27 | private $_times = array(); |
||
| 28 | |||
| 29 | /** |
||
| 30 | * |
||
| 31 | * @var array |
||
| 32 | */ |
||
| 33 | protected $_memory_usage_points = array(); |
||
| 34 | |||
| 35 | |||
| 36 | |||
| 37 | /** |
||
| 38 | * @singleton method used to instantiate class object |
||
| 39 | * @access public |
||
| 40 | * @return EEH_Debug_Tools |
||
| 41 | */ |
||
| 42 | public static function instance() { |
||
| 43 | // check if class object is instantiated, and instantiated properly |
||
| 44 | if ( ! self::$_instance instanceof EEH_Debug_Tools ) { |
||
| 45 | self::$_instance = new self(); |
||
| 46 | } |
||
| 47 | return self::$_instance; |
||
| 48 | } |
||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | /** |
||
| 53 | * class constructor |
||
| 54 | * |
||
| 55 | * @access private |
||
| 56 | * @return \EEH_Debug_Tools |
||
|
|
|||
| 57 | */ |
||
| 58 | private function __construct() { |
||
| 59 | // load Kint PHP debugging library |
||
| 60 | if ( ! class_exists( 'Kint' ) && file_exists( EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php' )){ |
||
| 61 | // despite EE4 having a check for an existing copy of the Kint debugging class, |
||
| 62 | // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check, |
||
| 63 | // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error |
||
| 64 | // so we've moved it to our test folder so that it is not included with production releases |
||
| 65 | // plz use https://wordpress.org/plugins/kint-debugger/ if testing production versions of EE |
||
| 66 | require_once( EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php' ); |
||
| 67 | } |
||
| 68 | if ( ! defined('DOING_AJAX') || ! isset( $_REQUEST['noheader'] ) || $_REQUEST['noheader'] != 'true' || ! isset( $_REQUEST['TB_iframe'] )) { |
||
| 69 | //add_action( 'shutdown', array($this,'espresso_session_footer_dump') ); |
||
| 70 | } |
||
| 71 | $plugin = basename( EE_PLUGIN_DIR_PATH ); |
||
| 72 | add_action( "activate_{$plugin}", array( 'EEH_Debug_Tools', 'ee_plugin_activation_errors' )); |
||
| 73 | add_action( 'activated_plugin', array( 'EEH_Debug_Tools', 'ee_plugin_activation_errors' )); |
||
| 74 | add_action( 'shutdown', array( 'EEH_Debug_Tools', 'show_db_name' )); |
||
| 75 | } |
||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | /** |
||
| 80 | * show_db_name |
||
| 81 | * |
||
| 82 | * @return void |
||
| 83 | */ |
||
| 84 | public static function show_db_name() { |
||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | /** |
||
| 93 | * dump EE_Session object at bottom of page after everything else has happened |
||
| 94 | * |
||
| 95 | * @return void |
||
| 96 | */ |
||
| 97 | public function espresso_session_footer_dump() { |
||
| 98 | if ( class_exists('Kint') && function_exists( 'wp_get_current_user' ) && current_user_can('update_core') && ( defined('WP_DEBUG') && WP_DEBUG ) && ! defined('DOING_AJAX') && class_exists( 'EE_Registry' )) { |
||
| 99 | Kint::dump( EE_Registry::instance()->SSN->id() ); |
||
| 100 | Kint::dump( EE_Registry::instance()->SSN ); |
||
| 101 | // Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() ); |
||
| 102 | $this->espresso_list_hooked_functions(); |
||
| 103 | $this->show_times(); |
||
| 104 | } |
||
| 105 | } |
||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | /** |
||
| 110 | * List All Hooked Functions |
||
| 111 | * to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL |
||
| 112 | * http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/ |
||
| 113 | * |
||
| 114 | * @param bool $tag |
||
| 115 | * @return void |
||
| 116 | */ |
||
| 117 | public function espresso_list_hooked_functions( $tag=FALSE ){ |
||
| 118 | global $wp_filter; |
||
| 119 | echo '<br/><br/><br/><h3>Hooked Functions</h3>'; |
||
| 120 | if ( $tag ) { |
||
| 121 | $hook[$tag]=$wp_filter[$tag]; |
||
| 122 | if ( ! is_array( $hook[$tag] )) { |
||
| 123 | trigger_error( "Nothing found for '$tag' hook", E_USER_WARNING ); |
||
| 124 | return; |
||
| 125 | } |
||
| 126 | echo '<h5>For Tag: '. $tag .'</h5>'; |
||
| 127 | } |
||
| 128 | else { |
||
| 129 | $hook=$wp_filter; |
||
| 130 | ksort( $hook ); |
||
| 131 | } |
||
| 132 | foreach( $hook as $tag => $priorities ) { |
||
| 133 | echo "<br />>>>>>\t<strong>$tag</strong><br />"; |
||
| 134 | ksort( $priorities ); |
||
| 135 | foreach( $priorities as $priority => $function ){ |
||
| 136 | echo $priority; |
||
| 137 | foreach( $function as $name => $properties ) { |
||
| 138 | echo "\t$name<br />"; |
||
| 139 | } |
||
| 140 | } |
||
| 141 | } |
||
| 142 | return; |
||
| 143 | } |
||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | /** |
||
| 148 | * registered_filter_callbacks |
||
| 149 | * |
||
| 150 | * @param string $hook_name |
||
| 151 | * @return array |
||
| 152 | */ |
||
| 153 | public static function registered_filter_callbacks( $hook_name = '' ) { |
||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | /** |
||
| 171 | * start_timer |
||
| 172 | * @param null $timer_name |
||
| 173 | */ |
||
| 174 | public function start_timer( $timer_name = NULL ){ |
||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | /** |
||
| 181 | * stop_timer |
||
| 182 | * @param string $timer_name |
||
| 183 | */ |
||
| 184 | public function stop_timer($timer_name = 'default'){ |
||
| 185 | if( isset( $this->_start_times[ $timer_name ] ) ){ |
||
| 186 | $start_time = $this->_start_times[ $timer_name ]; |
||
| 187 | unset( $this->_start_times[ $timer_name ] ); |
||
| 188 | }else{ |
||
| 189 | $start_time = array_pop( $this->_start_times ); |
||
| 190 | } |
||
| 191 | $total_time = microtime( TRUE ) - $start_time; |
||
| 192 | switch ( $total_time ) { |
||
| 193 | case $total_time < 0.00001 : |
||
| 194 | $color = '#8A549A'; |
||
| 195 | $bold = 'normal'; |
||
| 196 | break; |
||
| 197 | case $total_time < 0.0001 : |
||
| 198 | $color = '#00B1CA'; |
||
| 199 | $bold = 'normal'; |
||
| 200 | break; |
||
| 201 | case $total_time < 0.001 : |
||
| 202 | $color = '#70CC50'; |
||
| 203 | $bold = 'normal'; |
||
| 204 | break; |
||
| 205 | case $total_time < 0.01 : |
||
| 206 | $color = '#FCC600'; |
||
| 207 | $bold = 'bold'; |
||
| 208 | break; |
||
| 209 | case $total_time < 0.1 : |
||
| 210 | $color = '#E76700'; |
||
| 211 | $bold = 'bold'; |
||
| 212 | break; |
||
| 213 | default : |
||
| 214 | $color = '#E44064'; |
||
| 215 | $bold = 'bold'; |
||
| 216 | break; |
||
| 217 | } |
||
| 218 | $this->_times[] = '<hr /><div style="display: inline-block; min-width: 10px; margin:0 1em; color:'.$color.'; font-weight:'.$bold.'; font-size:1.2em;">' . number_format( $total_time, 8 ) . '</div> ' . $timer_name; |
||
| 219 | } |
||
| 220 | /** |
||
| 221 | * Measure the memory usage by PHP so far. |
||
| 222 | * @param string $label The label to show for this time eg "Start of calling Some_Class::some_function" |
||
| 223 | * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called |
||
| 224 | * @return void |
||
| 225 | */ |
||
| 226 | public function measure_memory( $label, $output_now = false ) { |
||
| 227 | $memory_used = $this->convert( memory_get_peak_usage( true ) ); |
||
| 228 | $this->_memory_usage_points[ $label ] = $memory_used; |
||
| 229 | if( $output_now ) { |
||
| 230 | echo "\r\n<br>$label : $memory_used"; |
||
| 231 | } |
||
| 232 | } |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc) |
||
| 236 | * @param int $size |
||
| 237 | * @return string |
||
| 238 | */ |
||
| 239 | public function convert( $size ) { |
||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | /** |
||
| 247 | * show_times |
||
| 248 | * @param bool $output_now |
||
| 249 | * @return string |
||
| 250 | */ |
||
| 251 | public function show_times($output_now=true){ |
||
| 259 | |||
| 260 | |||
| 261 | |||
| 262 | /** |
||
| 263 | * captures plugin activation errors for debugging |
||
| 264 | * |
||
| 265 | * @return void |
||
| 266 | */ |
||
| 267 | public static function ee_plugin_activation_errors() { |
||
| 289 | |||
| 290 | |||
| 291 | |||
| 292 | /** |
||
| 293 | * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc. Very useful for providing helpful messages to developers when the method of doing something has been deprecated, or we want to make sure they use something the right way. |
||
| 294 | * |
||
| 295 | * @access public |
||
| 296 | * @param string $function The function that was called |
||
| 297 | * @param string $message A message explaining what has been done incorrectly |
||
| 298 | * @param string $version The version of Event Espresso where the error was added |
||
| 299 | * @param int $error_type |
||
| 300 | * @uses trigger_error() |
||
| 301 | */ |
||
| 302 | public function doing_it_wrong( $function, $message, $version, $error_type = E_USER_NOTICE ) { |
||
| 320 | |||
| 321 | |||
| 322 | |||
| 323 | |||
| 324 | /** |
||
| 325 | * Logger helpers |
||
| 326 | */ |
||
| 327 | |||
| 328 | /** |
||
| 329 | * debug |
||
| 330 | * |
||
| 331 | * @param string $class |
||
| 332 | * @param string $func |
||
| 333 | * @param string $line |
||
| 334 | * @param array $info |
||
| 335 | * @param bool $display_request |
||
| 336 | * @param string $debug_index |
||
| 337 | * @param string $debug_key |
||
| 338 | */ |
||
| 339 | public static function log( $class='', $func = '', $line = '', $info = array(), $display_request = false, $debug_index = '', $debug_key = 'EE_DEBUG_SPCO' ) { |
||
| 357 | |||
| 358 | |||
| 359 | |||
| 360 | /** |
||
| 361 | * strip_objects |
||
| 362 | * |
||
| 363 | * @param array $info |
||
| 364 | * @return array |
||
| 365 | */ |
||
| 366 | public static function strip_objects( $info = array() ) { |
||
| 387 | |||
| 388 | |||
| 389 | |||
| 390 | /** |
||
| 391 | * @ print_r an array |
||
| 392 | * @ access public |
||
| 393 | * @ return void |
||
| 394 | * |
||
| 395 | * @param mixed $var |
||
| 396 | * @param bool $var_name |
||
| 397 | * @param string $file |
||
| 398 | * @param int $line |
||
| 399 | * @param string $height |
||
| 400 | * @param bool $die |
||
| 401 | */ |
||
| 402 | public static function printr( $var, $var_name = false, $file = __FILE__, $line = __LINE__, $height = 'auto', $die = false ) { |
||
| 442 | |||
| 443 | |||
| 444 | |||
| 445 | |||
| 446 | } |
||
| 447 | |||
| 483 |
Loading history...
Adding a
@returnannotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.