tests/PHPUnit/PHP/Timer.php

   1 <?php
   2 /**
   3  * PHP_Timer
   4  *
   5  * Copyright (c) 2010, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHP
  38  * @subpackage Timer
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://github.com/sebastianbergmann/php-timer
  43  * @since      File available since Release 1.0.0
  44  */
  45
  46 /**
  47  * Utility class for timing.
  48  *
  49  * @package    PHP
  50  * @subpackage Timer
  51  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  52  * @copyright  2002-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 1.0.0
  55  * @link       http://github.com/sebastianbergmann/php-timer
  56  * @since      Class available since Release 1.0.0
  57  */
  58 class PHP_Timer
  59 {
  60     protected static $startTimes = array();
  61
  62     /**
  63      * Starts the timer.
  64      */
  65     public static function start()
  66     {
  67         array_push(self::$startTimes, microtime(TRUE));
  68     }
  69
  70     /**
  71      * Stops the timer and returns the elapsed time.
  72      *
  73      * @return float
  74      */
  75     public static function stop()
  76     {
  77         return microtime(TRUE) - array_pop(self::$startTimes);
  78     }
  79
  80     /**
  81      * Formats the elapsed time as a string.
  82      *
  83      * @param  float $time
  84      * @return string
  85      */
  86     public static function secondsToTimeString($time)
  87     {
  88         $buffer = '';
  89
  90         $hours   = sprintf('%02d', ($time >= 3600) ? floor($time / 3600) : 0);
  91         $minutes = sprintf(
  92                      '%02d',
  93                      ($time >= 60)   ? floor($time /   60) - 60 * $hours : 0
  94                    );
  95         $seconds = sprintf('%02d', $time - 60 * 60 * $hours - 60 * $minutes);
  96
  97         if ($hours == 0 && $minutes == 0) {
  98             $seconds = sprintf('%1d', $seconds);
  99
 100             $buffer .= $seconds . ' second';
 101
 102             if ($seconds != '1') {
 103                 $buffer .= 's';
 104             }
 105         } else {
 106             if ($hours > 0) {
 107                 $buffer = $hours . ':';
 108             }
 109
 110             $buffer .= $minutes . ':' . $seconds;
 111         }
 112
 113         return $buffer;
 114     }
 115
 116     /**
 117      * Formats the elapsed time since the start of the request as a string.
 118      *
 119      * @return string
 120      */
 121     public static function timeSinceStartOfRequest()
 122     {
 123         return self::secondsToTimeString(time() - $_SERVER['REQUEST_TIME']);
 124     }
 125
 126     /**
 127      * Returns the resources (time, memory) of the request as a string.
 128      *
 129      * @return string
 130      */
 131     public static function resourceUsage()
 132     {
 133         return sprintf(
 134           'Time: %s, Memory: %4.2fMb',
 135           self::timeSinceStartOfRequest(),
 136           memory_get_peak_usage(TRUE) / 1048576
 137         );
 138     }
 139 }