system/core/Benchmark.php

   1 <?php defined('SYSPATH') OR die('No direct access allowed.');
   2 /**
   3  * Simple benchmarking.
   4  *
   5  * $Id: Benchmark.php 3917 2009-01-21 03:06:22Z zombor $
   6  *
   7  * @package    Core
   8  * @author     Kohana Team
   9  * @copyright  (c) 2007 Kohana Team
  10  * @license    http://kohanaphp.com/license.html
  11  */
  12 final class Benchmark {
  13
  14         // Benchmark timestamps
  15         private static $marks;
  16
  17         /**
  18          * Set a benchmark start point.
  19          *
  20          * @param   string  benchmark name
  21          * @return  void
  22          */
  23         public static function start($name)
  24         {
  25                 if ( ! isset(self::$marks[$name]))
  26                 {
  27                         self::$marks[$name] = array
  28                         (
  29                                 'start'        => microtime(TRUE),
  30                                 'stop'         => FALSE,
  31                                 'memory_start' => function_exists('memory_get_usage') ? memory_get_usage() : 0,
  32                                 'memory_stop'  => FALSE
  33                         );
  34                 }
  35         }
  36
  37         /**
  38          * Set a benchmark stop point.
  39          *
  40          * @param   string  benchmark name
  41          * @return  void
  42          */
  43         public static function stop($name)
  44         {
  45                 if (isset(self::$marks[$name]) AND self::$marks[$name]['stop'] === FALSE)
  46                 {
  47                         self::$marks[$name]['stop'] = microtime(TRUE);
  48                         self::$marks[$name]['memory_stop'] = function_exists('memory_get_usage') ? memory_get_usage() : 0;
  49                 }
  50         }
  51
  52         /**
  53          * Get the elapsed time between a start and stop.
  54          *
  55          * @param   string   benchmark name, TRUE for all
  56          * @param   integer  number of decimal places to count to
  57          * @return  array
  58          */
  59         public static function get($name, $decimals = 4)
  60         {
  61                 if ($name === TRUE)
  62                 {
  63                         $times = array();
  64                         $names = array_keys(self::$marks);
  65
  66                         foreach ($names as $name)
  67                         {
  68                                 // Get each mark recursively
  69                                 $times[$name] = self::get($name, $decimals);
  70                         }
  71
  72                         // Return the array
  73                         return $times;
  74                 }
  75
  76                 if ( ! isset(self::$marks[$name]))
  77                         return FALSE;
  78
  79                 if (self::$marks[$name]['stop'] === FALSE)
  80                 {
  81                         // Stop the benchmark to prevent mis-matched results
  82                         self::stop($name);
  83                 }
  84
  85                 // Return a string version of the time between the start and stop points
  86                 // Properly reading a float requires using number_format or sprintf
  87                 return array
  88                 (
  89                         'time'   => number_format(self::$marks[$name]['stop'] - self::$marks[$name]['start'], $decimals),
  90                         'memory' => (self::$marks[$name]['memory_stop'] - self::$marks[$name]['memory_start'])
  91                 );
  92         }
  93
  94 } // End Benchmark