cvs: pear /Benchmark Timer.php package.xml /Benchmark/doc timer_example.php

cox Sat Jan 26 16:47:38 2002 EDT Added files: /pear/Benchmark/doc timer_example.php Modified files: /pear/Benchmark Timer.php package.xml Log: - Added getOutput() to print the results in human readable format and display() to show it. This functions will automatically detect the environment to select HTML or text output - Added a new param $auto to constructor. When true is passed the results will be output automatically at the end of the script execution. (contribution by Ludovico Magnocavallo) - Go with version 1.1 (if Sebastian don't mind) - Added a example test script

Index: pear/Benchmark/Timer.php diff -u pear/Benchmark/Timer.php:1.1 pear/Benchmark/Timer.php:1.2 --- pear/Benchmark/Timer.php:1.1 Sun Jan 20 10:44:31 2002 +++ pear/Benchmark/Timer.php Sat Jan 26 16:47:38 2002 @@ -16,41 +16,157 @@ // | Authors: Sebastian Bergmann <sb@sebastian-bergmann.de> | // +----------------------------------------------------------------------+ // -// $Id: Timer.php,v 1.1 2002/01/20 15:44:31 sebastian Exp $ +// $Id: Timer.php,v 1.2 2002/01/26 21:47:38 cox Exp $ // /** * Benchmark::Timer - * + * * Purpose: - * + * * Timing Script Execution, Generating Profiling Information - * - * Example: - * - * $timer = new Benchmark_Timer; - * + * + * Example with automatic profiling start, stop, and output: + * + * $timer =& new Benchmark_Timer(true); + * $timer->setMarker('Marker 1'); + * + * Example without automatic profiling: + * + * $timer =& new Benchmark_Timer(); + * * $timer->start(); * $timer->setMarker('Marker 1'); * $timer->stop(); - * + * * $profiling = $timer->getProfiling(); - * + * echo $profiling->getOutput(); // or $timer->display() + * + * Contributors: + * - Ludovico Magnocavallo <ludo@sumatrasolutions.com> + * auto profiling and get_output() method + * * @author Sebastian Bergmann <sb@sebastian-bergmann.de> - * @version $Revision: 1.1 $ + * @version $Revision: 1.2 $ * @access public */ -class Benchmark_Timer { +require_once 'PEAR.php'; + +class Benchmark_Timer extends PEAR +{ /** * Contains the markers * * @var array - * @access public + * @access private */ var $markers = array(); /** + * Auto-start and stop timer + * + * @var boolean + * @access private + */ + var $auto = false; + + /** + * Max marker name length for non-html output + * + * @var integer + * @access private + */ + var $strlen_max = 0; + + /** + * Constructor, starts profiling recording + * + * @access public + */ + function Benchmark_Timer($auto = false) { + $this->PEAR(); + if ($auto) { + $this->auto = $auto; + $this->start(); + } + } + + /** + * Destructor, stops profiling recording + * + * @access private + */ + function _Benchmark_Timer() { + if ($this->auto) { + $this->stop(); + $this->display(); + } + } + + /** + * Return formatted profiling information. + * + * @see getProfiling() + * @access public + */ + function getOutput() + { + if (function_exists('version_compare') && + version_compare(phpversion(), '4.1', 'ge')) + { + $http = isset($_SERVER['SERVER_PROTOCOL']); + } else { + global $HTTP_SERVER_VARS; + $http = isset($HTTP_SERVER_VARS['SERVER_PROTOCOL']); + } + $total = $this->TimeElapsed(); + $result = $this->getProfiling(); + if ($http) { + $out = "<table border=1>\n"; + $out .= "<tr><td>&nbsp;</td><td><b>time index</b></td><td><b>ex time</b></td><td><b>%</b></td></tr>\n"; + } else { + $dashes = $out = str_pad("\n", ($this->strlen_max + 52), '-', STR_PAD_LEFT); + $out .= str_pad('marker', $this->strlen_max); + $out .= str_pad("time index", 22); + $out .= str_pad("ex time", 22); + $out .= "perct\n"; + $out .= $dashes; + } + foreach ($result as $k => $v) { + $perc = (($v['diff'] * 100) / $total); + if ($http) { + $out .= "<tr><td><b>" . $v['name'] . "</b></td><td>" . $v['time'] . "</td><td>" . $v['diff'] . "</td><td>" . number_format($perc, 2, '.', '') . "%</td></tr>\n"; + } else { + $out .= str_pad($v['name'], $this->strlen_max, ' '); + $out .= str_pad($v['time'], 22); + $out .= str_pad($v['diff'], 22); + $out .= str_pad(number_format($perc, 2, '.', '') . "%\n", 8, ' ', STR_PAD_LEFT); + } + $out .= $dashes; + } + if ($http) { + $out .= "<tr style='background: silver;'><td><b>total</b></td><td>-</td><td>${total}</td><td>100.00%</td></tr>\n"; + $out .= "</table>\n"; + } else { + $out .= str_pad('total', $this->strlen_max); + $out .= str_pad('-', 22); + $out .= str_pad($total, 22); + $out .= "100.00%\n"; + $out .= $dashes; + } + return $out; + } + + /** + * Prints the information returned by getOutput + */ + function display() + { + print $this->getOutput(); + } + + /** * Set "Start" marker. * * @see setMarker(), stop() @@ -110,33 +226,32 @@ * @access public */ function getProfiling() { - $i = 0; - $total = 0; + $i = $total = $temp = 0; $result = array(); - + foreach ($this->markers as $marker => $time) { - if ($marker == 'Start') { - $diff = '-'; + if (extension_loaded('bcmath')) { + $diff = bcsub($time, $temp, 6); + $total = bcadd($total, $diff, 6); } else { - if (extension_loaded('bcmath')) { - $diff = bcsub($time, $temp, 6); - $total = bcadd($total, $diff, 6); - } else { - $diff = $time - $temp; - $total = $total + $diff; - } + $diff = $time - $temp; + $total = $total + $diff; } - + $result[$i]['name'] = $marker; $result[$i]['time'] = $time; $result[$i]['diff'] = $diff; $result[$i]['total'] = $total; - + + $this->strlen_max = (strlen($marker) > $this->strlen_max ? strlen($marker) + 1 : $this->strlen_max); + $temp = $time; $i++; } - + $result[0]['diff'] = '-'; + $this->strlen_max = (strlen('total') > $this->strlen_max ? strlen('total') : $this->strlen_max); + $this->strlen_max += 4; return $result; } } -?> +?> \ No newline at end of file Index: pear/Benchmark/package.xml diff -u pear/Benchmark/package.xml:1.2 pear/Benchmark/package.xml:1.3 --- pear/Benchmark/package.xml:1.2 Sun Jan 20 11:09:17 2002 +++ pear/Benchmark/package.xml Sat Jan 26 16:47:38 2002 @@ -11,16 +11,24 @@ <email>sb@sebastian-bergmann.de</email> </maintainer> <release> - <version>1.0</version> - <date>2002-01-20</date> + <version>1.1</version> + <date>2002-01-26</date> + <state>stable</state> <notes> - This is the initial independent PEAR release. + - Added getOutput() to print the results in human readable format and display() to show it. + This functions will automatically detect the environment to select HTML or text output + - Added a new param $auto to constructor. When true is passed the results will be output + automatically at the end of the script execution. + (contribution by Ludovico Magnocavallo) </notes> + <filelist> + <dir name="/" baseinstalldir="Benchmark"> + <file role="php">Timer.php</file> + <file role="php">Iterate.php</file> + <dir name="doc" role="doc"> + <file>timer_example.php</file> + </dir> + </dir> + </filelist> </release> - <filelist> - <dir name="/" baseinstalldir="Benchmark"> - <file role="php">Timer.php</file> - <file role="php">Iterate.php</file> - </dir> - </filelist> </package> Index: pear/Benchmark/doc/timer_example.php +++ pear/Benchmark/doc/timer_example.php <?php require '../Timer.php'; function wait($amount) { for ($i=0; $i < $amount; $i++) { for ($i=0; $i < 100; $i++); } } // Pass the param "true" to constructor for auto display the results $timer = new Benchmark_Timer(); $timer->start(); wait(10); $timer->setMarker('Mark1'); echo "Enlapsed time between Start and Mar1: " . $timer->timeElapsed('Start', 'Mark1') . "\n"; wait(50); $timer->stop(); $timer->display(); ?>