eventespresso / event-espresso-core

core/helpers/EEH_Debug_Tools.helper.php

Spacing +121 added lines, -121 removed lines

@@ -8,7 +8,7 @@ 
  * @since 				4.0
  *
  */
-class EEH_Debug_Tools{
+class EEH_Debug_Tools {
 
 	/**
 	 * 	instance of the EEH_Autoloader object
@@ -41,7 +41,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated, and instantiated properly
-		if ( ! self::$_instance instanceof EEH_Debug_Tools ) {
+		if ( ! self::$_instance instanceof EEH_Debug_Tools) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -57,21 +57,21 @@ 
 	 */
 	private function __construct() {
 		// load Kint PHP debugging library
-		if ( ! class_exists( 'Kint' ) &&  file_exists( EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php' )){
+		if ( ! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php')) {
 			// despite EE4 having a check for an existing copy of the Kint debugging class,
 			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
 			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
 			// so we've moved it to our test folder so that it is not included with production releases
 			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-			require_once( EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php' );
+			require_once(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php');
 		}
-		if ( ! defined('DOING_AJAX') || ! isset( $_REQUEST['noheader'] ) || $_REQUEST['noheader'] != 'true' || ! isset( $_REQUEST['TB_iframe'] )) {
+		if ( ! defined('DOING_AJAX') || ! isset($_REQUEST['noheader']) || $_REQUEST['noheader'] != 'true' || ! isset($_REQUEST['TB_iframe'])) {
 			//add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
 		}
-		$plugin = basename( EE_PLUGIN_DIR_PATH );
-		add_action( "activate_{$plugin}", array( 'EEH_Debug_Tools', 'ee_plugin_activation_errors' ));
-		add_action( 'activated_plugin', array( 'EEH_Debug_Tools', 'ee_plugin_activation_errors' ));
-		add_action( 'shutdown', array( 'EEH_Debug_Tools', 'show_db_name' ));
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
 	}
 
 
@@ -82,8 +82,8 @@ 
 	 * 	@return void
 	 */
 	public static function show_db_name() {
-		if ( ! defined( 'DOING_AJAX' ) && ( defined( 'EE_ERROR_EMAILS' ) && EE_ERROR_EMAILS )) {
-			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '. DB_NAME .'</p>';
+		if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '.DB_NAME.'</p>';
 		}
 	}
 
@@ -95,9 +95,9 @@ 
 	 * 	@return void
 	 */
 	public function espresso_session_footer_dump() {
-		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' )) {
-			Kint::dump(  EE_Registry::instance()->SSN->id() );
-			Kint::dump( EE_Registry::instance()->SSN );
+		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')) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
 			//			Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
 			$this->espresso_list_hooked_functions();
 			$this->show_times();
@@ -114,27 +114,27 @@ 
 	 * @param bool $tag
 	 * @return void
 	 */
-	public function espresso_list_hooked_functions( $tag=FALSE ){
+	public function espresso_list_hooked_functions($tag = FALSE) {
 		global $wp_filter;
 		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-		if ( $tag ) {
-			$hook[$tag]=$wp_filter[$tag];
-			if ( ! is_array( $hook[$tag] )) {
-				trigger_error( "Nothing found for '$tag' hook", E_USER_WARNING );
+		if ($tag) {
+			$hook[$tag] = $wp_filter[$tag];
+			if ( ! is_array($hook[$tag])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
 				return;
 			}
-			echo '<h5>For Tag: '. $tag .'</h5>';
+			echo '<h5>For Tag: '.$tag.'</h5>';
 		}
 		else {
-			$hook=$wp_filter;
-			ksort( $hook );
+			$hook = $wp_filter;
+			ksort($hook);
 		}
-		foreach( $hook as $tag => $priorities ) {
+		foreach ($hook as $tag => $priorities) {
 			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag</strong><br />";
-			ksort( $priorities );
-			foreach( $priorities as $priority => $function ){
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
 				echo $priority;
-				foreach( $function as $name => $properties ) {
+				foreach ($function as $name => $properties) {
 					echo "\t$name<br />";
 				}
 			}
@@ -150,15 +150,15 @@ 
 	 * @param string $hook_name
 	 * @return array
 	 */
-	public static function registered_filter_callbacks( $hook_name = '' ) {
+	public static function registered_filter_callbacks($hook_name = '') {
 		$filters = array();
 		global $wp_filter;
-		if ( isset( $wp_filter[ $hook_name ] ) ) {
-			$filters[ $hook_name ] = array();
-			foreach ( $wp_filter[ $hook_name ] as $priority => $callbacks ) {
-				$filters[ $hook_name ][ $priority ] = array();
-				foreach ( $callbacks as $callback ) {
-					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+		if (isset($wp_filter[$hook_name])) {
+			$filters[$hook_name] = array();
+			foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+				$filters[$hook_name][$priority] = array();
+				foreach ($callbacks as $callback) {
+					$filters[$hook_name][$priority][] = $callback['function'];
 				}
 			}
 		}
@@ -171,8 +171,8 @@ 
 	 * 	start_timer
 	 * @param null $timer_name
 	 */
-	public function start_timer( $timer_name = NULL ){
-		$this->_start_times[$timer_name] = microtime( TRUE );
+	public function start_timer($timer_name = NULL) {
+		$this->_start_times[$timer_name] = microtime(TRUE);
 	}
 
 
@@ -181,15 +181,15 @@ 
 	 * stop_timer
 	 * @param string $timer_name
 	 */
-	public function stop_timer($timer_name = 'default'){
-		if( isset( $this->_start_times[ $timer_name ] ) ){
-			$start_time = $this->_start_times[ $timer_name ];
-			unset( $this->_start_times[ $timer_name ] );
-		}else{
-			$start_time = array_pop( $this->_start_times );
+	public function stop_timer($timer_name = 'default') {
+		if (isset($this->_start_times[$timer_name])) {
+			$start_time = $this->_start_times[$timer_name];
+			unset($this->_start_times[$timer_name]);
+		} else {
+			$start_time = array_pop($this->_start_times);
 		}
-		$total_time = microtime( TRUE ) - $start_time;
-		switch ( $total_time ) {
+		$total_time = microtime(TRUE) - $start_time;
+		switch ($total_time) {
 			case $total_time < 0.00001 :
 				$color = '#8A549A';
 				$bold = 'normal';
@@ -215,7 +215,7 @@ 
 				$bold = 'bold';
 				break;
 		}
-		$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;
+		$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;
 	}
 	/**
 	 * Measure the memory usage by PHP so far.
@@ -223,10 +223,10 @@ 
 	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
 	 * @return void
 	 */
-	public function measure_memory( $label, $output_now = false ) {
-		$memory_used = $this->convert( memory_get_peak_usage( true ) );
-		$this->_memory_usage_points[ $label ] = $memory_used;
-		if( $output_now ) {
+	public function measure_memory($label, $output_now = false) {
+		$memory_used = $this->convert(memory_get_peak_usage(true));
+		$this->_memory_usage_points[$label] = $memory_used;
+		if ($output_now) {
 			echo "\r\n<br>$label : $memory_used";
 		}
 	}
@@ -236,9 +236,9 @@ 
 	 * @param int $size
 	 * @return string
 	 */
-	public function convert( $size ) {
-		$unit=array('b','kb','mb','gb','tb','pb');
-		return @round($size/pow(1024,($i=floor(log($size,1024)))),2).' '.$unit[ absint( $i ) ];
+	public function convert($size) {
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
+		return @round($size / pow(1024, ($i = floor(log($size, 1024)))), 2).' '.$unit[absint($i)];
 	}
 
 
@@ -248,9 +248,9 @@ 
 	 * @param bool $output_now
 	 * @return string
 	 */
-	public function show_times($output_now=true){
-		$output = '<h2>Times:</h2>' . implode("<br>",$this->_times) . '<h2>Memory</h2>' . implode('<br>', $this->_memory_usage_points );
-		if($output_now){
+	public function show_times($output_now = true) {
+		$output = '<h2>Times:</h2>'.implode("<br>", $this->_times).'<h2>Memory</h2>'.implode('<br>', $this->_memory_usage_points);
+		if ($output_now) {
 			echo $output;
 			return '';
 		}
@@ -265,25 +265,25 @@ 
 	 * 	@return void
 	 */
 	public static function ee_plugin_activation_errors() {
-		if ( WP_DEBUG ) {
+		if (WP_DEBUG) {
 			$activation_errors = ob_get_contents();
-			if ( ! empty( $activation_errors ) ) {
-				$activation_errors = date( 'Y-m-d H:i:s' ) . "\n" . $activation_errors;
+			if ( ! empty($activation_errors)) {
+				$activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
 			}
-			espresso_load_required( 'EEH_File', EE_HELPERS . 'EEH_File.helper.php' );
-			if ( class_exists( 'EEH_File' )) {
+			espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
 				try {
-					EEH_File::ensure_file_exists_and_is_writable( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html' );
-					EEH_File::write_to_file( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', $activation_errors );
-				} catch( EE_Error $e ){
-					EE_Error::add_error( sprintf( __(  'The Event Espresso activation errors file could not be setup because: %s', 'event_espresso' ), $e->getMessage() ), __FILE__, __FUNCTION__, __LINE__ );
+					EEH_File::ensure_file_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html');
+					EEH_File::write_to_file(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html', $activation_errors);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(sprintf(__('The Event Espresso activation errors file could not be setup because: %s', 'event_espresso'), $e->getMessage()), __FILE__, __FUNCTION__, __LINE__);
 				}
 			} else {
 				// old school attempt
-				file_put_contents( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', $activation_errors );
+				file_put_contents(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html', $activation_errors);
 			}
-			$activation_errors = get_option( 'ee_plugin_activation_errors', '' ) . $activation_errors;
-			update_option( 'ee_plugin_activation_errors', $activation_errors );
+			$activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
 		}
 	}
 
@@ -299,22 +299,22 @@ 
 	 * @param int     $error_type
 	 * @uses trigger_error()
 	 */
-	public function doing_it_wrong( $function, $message, $version, $error_type = E_USER_NOTICE ) {
-		do_action( 'AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-		$version = is_null( $version ) ? '' : sprintf( __('(This message was added in version %s of Event Espresso.', 'event_espresso' ), $version );
-		$error_message = sprintf( esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s','event_espresso' ), $function, '<strong>', '</strong>', $message, $version );
+	public function doing_it_wrong($function, $message, $version, $error_type = E_USER_NOTICE) {
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = is_null($version) ? '' : sprintf(__('(This message was added in version %s of Event Espresso.', 'event_espresso'), $version);
+		$error_message = sprintf(esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'), $function, '<strong>', '</strong>', $message, $version);
 
 		//don't trigger error if doing ajax, instead we'll add a transient EE_Error notice that in theory should show on the next request.
-		if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
-			$error_message .= esc_html__( 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ', 'event_espresso' );
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= esc_html__('This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ', 'event_espresso');
 			$error_message .= '<ul><li>';
-			$error_message .= implode( '</li><li>', EE_Registry::instance()->REQ->params() );
+			$error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
 			$error_message .= '</ul>';
-			EE_Error::add_error( $error_message, 'debug::doing_it_wrong', $function, '42' );
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
 			//now we set this on the transient so it shows up on the next request.
-			EE_Error::get_notices( is_admin(), true );
+			EE_Error::get_notices(is_admin(), true);
 		} else {
-			trigger_error( $error_message, $error_type );
+			trigger_error($error_message, $error_type);
 		}
 	}
 
@@ -336,22 +336,22 @@ 
 	 * @param string $debug_index
 	 * @param string $debug_key
 	 */
-	public static function log( $class='', $func = '', $line = '', $info = array(), $display_request = false,  $debug_index = '', $debug_key = 'EE_DEBUG_SPCO' ) {
-		if ( WP_DEBUG && false ) {
-			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
-			$debug_data = get_option( $debug_key, array() );
+	public static function log($class = '', $func = '', $line = '', $info = array(), $display_request = false, $debug_index = '', $debug_key = 'EE_DEBUG_SPCO') {
+		if (WP_DEBUG && false) {
+			$debug_key = $debug_key.'_'.EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
 			$default_data = array(
-				$class => $func . '() : ' . $line,
+				$class => $func.'() : '.$line,
 				'REQ'  => $display_request ? $_REQUEST : '',
 			);
 			// don't serialize objects
-			$info = self::strip_objects( $info );
-			$index = ! empty( $debug_index ) ? $debug_index : 0;
-			if ( ! isset( $debug_data[$index] ) ) {
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if ( ! isset($debug_data[$index])) {
 				$debug_data[$index] = array();
 			}
-			$debug_data[$index][microtime()] = array_merge( $default_data, $info );
-			update_option( $debug_key, $debug_data );
+			$debug_data[$index][microtime()] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
 		}
 	}
 
@@ -363,26 +363,26 @@ 
 	 * @param array $info
 	 * @return array
 	 */
-	public static function strip_objects( $info = array() ) {
-		foreach ( $info as $key => $value ) {
-			if ( is_array( $value ) ) {
-				$info[ $key ] = self::strip_objects( $value );
-			} else if ( is_object( $value ) ) {
-				$object_class = get_class( $value );
-				$info[ $object_class ] = array();
-				$info[ $object_class ][ 'ID' ] = method_exists( $value, 'ID' ) ? $value->ID() : spl_object_hash( $value );
-				if ( method_exists( $value, 'ID' ) ) {
-					$info[ $object_class ][ 'ID' ] = $value->ID();
+	public static function strip_objects($info = array()) {
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[$key] = self::strip_objects($value);
+			} else if (is_object($value)) {
+				$object_class = get_class($value);
+				$info[$object_class] = array();
+				$info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[$object_class]['ID'] = $value->ID();
 				}
-				if ( method_exists( $value, 'status' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status();
-				} else if ( method_exists( $value, 'status_ID' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status_ID();
+				if (method_exists($value, 'status')) {
+					$info[$object_class]['status'] = $value->status();
+				} else if (method_exists($value, 'status_ID')) {
+					$info[$object_class]['status'] = $value->status_ID();
 				}
-				unset( $info[ $key ] );
+				unset($info[$key]);
 			}
 		}
-		return (array)$info;
+		return (array) $info;
 	}
 
 
@@ -399,31 +399,31 @@ 
 	 * @param string $height
 	 * @param bool $die
 	 */
-	public static function printr( $var, $var_name = false, $file = __FILE__, $line = __LINE__, $height = 'auto', $die = false ) {
+	public static function printr($var, $var_name = false, $file = __FILE__, $line = __LINE__, $height = 'auto', $die = false) {
 		//$print_r = false;
-		if ( is_object( $var ) ) {
+		if (is_object($var)) {
 			$var_name = ! $var_name ? 'object' : $var_name;
 			//$print_r = true;
-		} else if ( is_array( $var ) ) {
+		} else if (is_array($var)) {
 			$var_name = ! $var_name ? 'array' : $var_name;
 			//$print_r = true;
-		} else if ( is_numeric( $var ) ) {
+		} else if (is_numeric($var)) {
 			$var_name = ! $var_name ? 'numeric' : $var_name;
-		} else if ( is_string( $var ) ) {
+		} else if (is_string($var)) {
 			$var_name = ! $var_name ? 'string' : $var_name;
-		} else if ( is_null( $var ) ) {
+		} else if (is_null($var)) {
 			$var_name = ! $var_name ? 'null' : $var_name;
 		}
-		$var_name = ucwords( str_replace( array( '$', '_' ), array( '', ' ' ), $var_name ) );
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
 		ob_start();
-		echo '<pre style="display:block; width:100%; height:' . $height . '; border:2px solid light-blue;">';
-		echo '<h5 style="color:#2EA2CC;"><b>' . $var_name . '</b></h5><span style="color:#E76700">';
+		echo '<pre style="display:block; width:100%; height:'.$height.'; border:2px solid light-blue;">';
+		echo '<h5 style="color:#2EA2CC;"><b>'.$var_name.'</b></h5><span style="color:#E76700">';
 		//$print_r ? print_r( $var ) : var_dump( $var );
-		var_dump( $var );
-		echo '</span><br /><span style="font-size:10px;font-weight:normal;">' . $file . '<br />line no: ' . $line . '</span></pre>';
+		var_dump($var);
+		echo '</span><br /><span style="font-size:10px;font-weight:normal;">'.$file.'<br />line no: '.$line.'</span></pre>';
 		$result = ob_get_clean();
-		if ( $die ) {
-			die( $result );
+		if ($die) {
+			die($result);
 		} else {
 			echo $result;
 		}
@@ -440,8 +440,8 @@ 
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
-if ( class_exists('Kint') && ! function_exists( 'dump_wp_query' ) ) {
-	function dump_wp_query(){
+if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
+	function dump_wp_query() {
 		global $wp_query;
 		d($wp_query);
 	}
@@ -451,8 +451,8 @@ 
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
-if ( class_exists('Kint') && ! function_exists( 'dump_wp' ) ) {
-	function dump_wp(){
+if (class_exists('Kint') && ! function_exists('dump_wp')) {
+	function dump_wp() {
 		global $wp;
 		d($wp);
 	}
@@ -462,8 +462,8 @@ 
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
-if ( class_exists('Kint') && ! function_exists( 'dump_post' ) ) {
-	function dump_post(){
+if (class_exists('Kint') && ! function_exists('dump_post')) {
+	function dump_post() {
 		global $post;
 		d($post);
 	}