eventespresso / event-espresso-core

core/services/Benchmark.php

Indentation +223 added lines, -223 removed lines

@@ -17,229 +17,229 @@
 class Benchmark
 {
 
-    /**
-     * array containing the start time for the timers
-     */
-    private static $start_times;
-
-    /**
-     * array containing all the timer'd times, which can be outputted via show_times()
-     */
-    private static $times = array();
-
-    /**
-     * @var array
-     */
-    protected static $memory_usage = array();
-
-
-
-    /**
-     * whether to benchmark code or not
-     */
-    public static function doNotRun()
-    {
-        return WP_DEBUG !== true || (defined('DOING_AJAX') && DOING_AJAX);
-    }
-
-
-
-    /**
-     * resetTimes
-     */
-    public static function resetTimes()
-    {
-        Benchmark::$times = array();
-    }
-
-
-
-    /**
-     * Add Benchmark::startTimer() before a block of code you want to measure the performance of
-     *
-     * @param null $timer_name
-     */
-    public static function startTimer($timer_name = null)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        Benchmark::$start_times[$timer_name] = microtime(true);
-    }
-
-
-
-    /**
-     * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
-     *
-     * @param string $timer_name
-     */
-    public static function stopTimer($timer_name = '')
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        if (isset(Benchmark::$start_times[$timer_name])) {
-            $start_time = Benchmark::$start_times[$timer_name];
-            unset(Benchmark::$start_times[$timer_name]);
-        } else {
-            $start_time = array_pop(Benchmark::$start_times);
-        }
-        Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
-    }
-
-
-
-    /**
-     * Measure the memory usage by PHP so far.
-     *
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public static function measureMemory($label, $output_now = false)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $memory_used = Benchmark::convert(memory_get_peak_usage(true));
-        Benchmark::$memory_usage[$label] = $memory_used;
-        if ($output_now) {
-            echo "\r\n<br>$label : $memory_used";
-        }
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @return void
-     */
-    public static function displayResultsAtShutdown()
-    {
-        add_action(
-            'shutdown',
-            function () {
-                Benchmark::displayResults();
-            }
-        );
-    }
-
-
-
-    /**
-     * displayResults
-     *
-     * @param bool $echo
-     * @return string
-     */
-    public static function displayResults($echo = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return '';
-        }
-        $output = '';
-        if (! empty(Benchmark::$times)) {
-            $total = 0;
-            $output .= '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />';
-            foreach (Benchmark::$times as $timer_name => $total_time) {
-                $output .= Benchmark::formatTime($timer_name, $total_time) . '<br />';
-                $total += $total_time;
-            }
-            $output .= '<br />';
-            $output .= '<h4>TOTAL TIME</h4>';
-            $output .= Benchmark::formatTime('', $total);
-            $output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
-            $output .= '<br />';
-            $output .= '<h5>Performance scale (from best to worse)</h5>';
-            $output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
-            $output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
-            $output .= '<span style="color:limegreen">Like...groovy!</span><br />';
-            $output .= '<span style="color:gold">Ruh Oh</span><br />';
-            $output .= '<span style="color:darkorange">Zoinks!</span><br />';
-            $output .= '<span style="color:red">Like...HEEELLLP</span><br />';
-        }
-        if (! empty(Benchmark::$memory_usage)) {
-            $output .= '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage);
-        }
-        if (empty($output)) {
-            return '';
-        }
-        $output = '<div style="border:1px solid #dddddd; background-color:#ffffff;'
-                  . (is_admin() ? ' margin:2em 2em 2em 180px;' : ' margin:2em;')
-                  . ' padding:2em;">'
-                  . '<h4>BENCHMARKING</h4>'
-                  . $output
-                  . '</div>';
-        if ($echo) {
-            echo $output;
-            return '';
-        }
-        return $output;
-    }
-
-
-
-    /**
-     * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
-     *
-     * @param int $size
-     * @return string
-     */
-    public static 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)];
-    }
-
-
-
-    /**
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public static function formatTime($timer_name, $total_time)
-    {
-        $total_time *= 1000;
-        switch ($total_time) {
-            case $total_time > 12500 :
-                $color = 'red';
-                $bold = 'bold';
-                break;
-            case $total_time > 2500 :
-                $color = 'darkorange';
-                $bold = 'bold';
-                break;
-            case $total_time > 500 :
-                $color = 'gold';
-                $bold = 'bold';
-                break;
-            case $total_time > 100 :
-                $color = 'limegreen';
-                $bold = 'normal';
-                break;
-            case $total_time > 20 :
-                $color = 'deepskyblue';
-                $bold = 'normal';
-                break;
-            default :
-                $color = 'mediumpurple';
-                $bold = 'normal';
-                break;
-        }
-        return '<span style="min-width: 10px; margin:0 1em; color:'
-               . $color
-               . '; font-weight:'
-               . $bold
-               . '; font-size:1.2em;">'
-               . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
-               . '</span> '
-               . $timer_name;
-    }
+	/**
+	 * array containing the start time for the timers
+	 */
+	private static $start_times;
+
+	/**
+	 * array containing all the timer'd times, which can be outputted via show_times()
+	 */
+	private static $times = array();
+
+	/**
+	 * @var array
+	 */
+	protected static $memory_usage = array();
+
+
+
+	/**
+	 * whether to benchmark code or not
+	 */
+	public static function doNotRun()
+	{
+		return WP_DEBUG !== true || (defined('DOING_AJAX') && DOING_AJAX);
+	}
+
+
+
+	/**
+	 * resetTimes
+	 */
+	public static function resetTimes()
+	{
+		Benchmark::$times = array();
+	}
+
+
+
+	/**
+	 * Add Benchmark::startTimer() before a block of code you want to measure the performance of
+	 *
+	 * @param null $timer_name
+	 */
+	public static function startTimer($timer_name = null)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		Benchmark::$start_times[$timer_name] = microtime(true);
+	}
+
+
+
+	/**
+	 * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
+	 *
+	 * @param string $timer_name
+	 */
+	public static function stopTimer($timer_name = '')
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		if (isset(Benchmark::$start_times[$timer_name])) {
+			$start_time = Benchmark::$start_times[$timer_name];
+			unset(Benchmark::$start_times[$timer_name]);
+		} else {
+			$start_time = array_pop(Benchmark::$start_times);
+		}
+		Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
+	}
+
+
+
+	/**
+	 * Measure the memory usage by PHP so far.
+	 *
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public static function measureMemory($label, $output_now = false)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$memory_used = Benchmark::convert(memory_get_peak_usage(true));
+		Benchmark::$memory_usage[$label] = $memory_used;
+		if ($output_now) {
+			echo "\r\n<br>$label : $memory_used";
+		}
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @return void
+	 */
+	public static function displayResultsAtShutdown()
+	{
+		add_action(
+			'shutdown',
+			function () {
+				Benchmark::displayResults();
+			}
+		);
+	}
+
+
+
+	/**
+	 * displayResults
+	 *
+	 * @param bool $echo
+	 * @return string
+	 */
+	public static function displayResults($echo = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return '';
+		}
+		$output = '';
+		if (! empty(Benchmark::$times)) {
+			$total = 0;
+			$output .= '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />';
+			foreach (Benchmark::$times as $timer_name => $total_time) {
+				$output .= Benchmark::formatTime($timer_name, $total_time) . '<br />';
+				$total += $total_time;
+			}
+			$output .= '<br />';
+			$output .= '<h4>TOTAL TIME</h4>';
+			$output .= Benchmark::formatTime('', $total);
+			$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
+			$output .= '<br />';
+			$output .= '<h5>Performance scale (from best to worse)</h5>';
+			$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
+			$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
+			$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
+			$output .= '<span style="color:gold">Ruh Oh</span><br />';
+			$output .= '<span style="color:darkorange">Zoinks!</span><br />';
+			$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
+		}
+		if (! empty(Benchmark::$memory_usage)) {
+			$output .= '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage);
+		}
+		if (empty($output)) {
+			return '';
+		}
+		$output = '<div style="border:1px solid #dddddd; background-color:#ffffff;'
+				  . (is_admin() ? ' margin:2em 2em 2em 180px;' : ' margin:2em;')
+				  . ' padding:2em;">'
+				  . '<h4>BENCHMARKING</h4>'
+				  . $output
+				  . '</div>';
+		if ($echo) {
+			echo $output;
+			return '';
+		}
+		return $output;
+	}
+
+
+
+	/**
+	 * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
+	 *
+	 * @param int $size
+	 * @return string
+	 */
+	public static 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)];
+	}
+
+
+
+	/**
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public static function formatTime($timer_name, $total_time)
+	{
+		$total_time *= 1000;
+		switch ($total_time) {
+			case $total_time > 12500 :
+				$color = 'red';
+				$bold = 'bold';
+				break;
+			case $total_time > 2500 :
+				$color = 'darkorange';
+				$bold = 'bold';
+				break;
+			case $total_time > 500 :
+				$color = 'gold';
+				$bold = 'bold';
+				break;
+			case $total_time > 100 :
+				$color = 'limegreen';
+				$bold = 'normal';
+				break;
+			case $total_time > 20 :
+				$color = 'deepskyblue';
+				$bold = 'normal';
+				break;
+			default :
+				$color = 'mediumpurple';
+				$bold = 'normal';
+				break;
+		}
+		return '<span style="min-width: 10px; margin:0 1em; color:'
+			   . $color
+			   . '; font-weight:'
+			   . $bold
+			   . '; font-size:1.2em;">'
+			   . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
+			   . '</span> '
+			   . $timer_name;
+	}
 
 
 

Spacing +6 added lines, -6 removed lines

@@ -122,7 +122,7 @@ 
     {
         add_action(
             'shutdown',
-            function () {
+            function() {
                 Benchmark::displayResults();
             }
         );
@@ -142,11 +142,11 @@ 
             return '';
         }
         $output = '';
-        if (! empty(Benchmark::$times)) {
+        if ( ! empty(Benchmark::$times)) {
             $total = 0;
             $output .= '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />';
             foreach (Benchmark::$times as $timer_name => $total_time) {
-                $output .= Benchmark::formatTime($timer_name, $total_time) . '<br />';
+                $output .= Benchmark::formatTime($timer_name, $total_time).'<br />';
                 $total += $total_time;
             }
             $output .= '<br />';
@@ -162,8 +162,8 @@ 
             $output .= '<span style="color:darkorange">Zoinks!</span><br />';
             $output .= '<span style="color:red">Like...HEEELLLP</span><br />';
         }
-        if (! empty(Benchmark::$memory_usage)) {
-            $output .= '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage);
+        if ( ! empty(Benchmark::$memory_usage)) {
+            $output .= '<h5>Memory</h5>'.implode('<br />', Benchmark::$memory_usage);
         }
         if (empty($output)) {
             return '';
@@ -192,7 +192,7 @@ 
     public static 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)];
+        return round($size / pow(1024, $i = floor(log($size, 1024))), 2).' '.$unit[absint($i)];
     }