tests/PHPUnit/Util/Timer.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, 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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.0.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Filter.php';
  48
  49 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  50
  51 /**
  52  * Utility class for timing.
  53  *
  54  * @category   Testing
  55  * @package    PHPUnit
  56  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  57  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  58  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  59  * @version    Release: 3.3.17
  60  * @link       http://www.phpunit.de/
  61  * @since      Class available since Release 3.0.0
  62  */
  63 class PHPUnit_Util_Timer
  64 {
  65     protected static $startTimes = array();
  66
  67     /**
  68      * Starts the timer.
  69      *
  70      */
  71     public static function start()
  72     {
  73         array_push(self::$startTimes, microtime(TRUE));
  74     }
  75
  76     /**
  77      * Returns the currently elapsed time.
  78      *
  79      * @return float
  80      */
  81     public static function current()
  82     {
  83         return microtime(TRUE) - self::$startTimes[count(self::$startTimes)-1];
  84     }
  85
  86     /**
  87      * Stops the timer and returns the elapsed time.
  88      *
  89      */
  90     public static function stop()
  91     {
  92         return microtime(TRUE) - array_pop(self::$startTimes);
  93     }
  94
  95     /**
  96      * Formats elapsed time (in seconds) to a string.
  97      *
  98      * @param  float $time
  99      * @return float
 100      */
 101     public static function secondsToTimeString($time)
 102     {
 103         $buffer = '';
 104
 105         $hours   = sprintf('%02d', ($time >= 3600) ? floor($time / 3600) : 0);
 106         $minutes = sprintf('%02d', ($time >= 60)   ? floor($time /   60) - 60 * $hours : 0);
 107         $seconds = sprintf('%02d', $time - 60 * 60 * $hours - 60 * $minutes);
 108
 109         if ($hours == 0 && $minutes == 0) {
 110             $seconds = sprintf('%1d', $seconds);
 111
 112             $buffer .= $seconds . ' second';
 113
 114             if ($seconds != '1') {
 115                 $buffer .= 's';
 116             }
 117         } else {
 118             if ($hours > 0) {
 119                 $buffer = $hours . ':';
 120             }
 121
 122             $buffer .= $minutes . ':' . $seconds;
 123         }
 124
 125         return $buffer;
 126     }
 127 }
 128 ?>