ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW

Source for file Timer.php

Documentation is available at Timer.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Object
  23.  * @package    ForwardFW
  24.  * @subpackage Object
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009-2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.1
  31.  */
  32.  
  33. require_once 'ForwardFW/Object.php';
  34.  
  35. /**
  36.  * Model for mesuring time, can add hints with meantime
  37.  *
  38.  * @category   Object
  39.  * @package    ForwardFW
  40.  * @subpackage Object
  41.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  42.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  43.  * @link       http://forwardfw.sourceforge.net
  44.  */
  45. class ForwardFW_Object_Timer extends ForwardFW_Object
  46. {
  47.     /**
  48.      * Name of this Timer for output
  49.      *
  50.      * @var string 
  51.      */
  52.     private $strName = '';
  53.  
  54.     /**
  55.      * Start time of this timer, microsecond
  56.      *
  57.      * @var float 
  58.      */
  59.     private $nTimeStart = -1;
  60.  
  61.     /**
  62.      * Endtime of this timer, microsecond
  63.      *
  64.      * @var float 
  65.      */
  66.     private $nTimeStop = -1;
  67.  
  68.     /**
  69.      * List of informational entries
  70.      *
  71.      * @var array of string
  72.      */
  73.     private $arEntries = array();
  74.  
  75.     /**
  76.      * Starts the timer
  77.      *
  78.      * @param string $strName Name to identify Timer on output
  79.      *
  80.      * @return void 
  81.      */
  82.     public function __construct($strName = '')
  83.     {
  84.         parent::__construct();
  85.         $this->strName = $strName;
  86.         $this->nTimeStart = microtime(true);
  87.     }
  88.  
  89.     /**
  90.      * Set new start time and resets entries
  91.      *
  92.      * @return ForwardFW_Object_Timer The timer object
  93.      */
  94.     public function reStart()
  95.     {
  96.         $this->nTimeStart = microtime(true);
  97.         $this->nTimeStop = -1;
  98.         $this->arEntries = array();
  99.  
  100.         return $this;
  101.     }
  102.  
  103.     /**
  104.      * Adds an entry for information output with elapsed time.
  105.      *
  106.      * @param string $strEntry The string to add.
  107.      *
  108.      * @return ForwardFW_Object_Timer 
  109.      */
  110.     public function addEntry($strEntry)
  111.     {
  112.         $strElapsedTime = $this->getElapsedTime();
  113.         array_push($this->arEntries, $strElapsedTime . ': ' . $strEntry);
  114.  
  115.         return $this;
  116.     }
  117.  
  118.     /**
  119.      * Give elapsed time since start of timer
  120.      *
  121.      * @return float Time in ms.
  122.      */
  123.     public function getElapsedTime()
  124.     {
  125.         $nNow = microtime(true);
  126.         return $this->getTimeDifference($this->nTimeStart, $nNow);
  127.     }
  128.  
  129.     /**
  130.      * Give difference between microtimes in ms.
  131.      *
  132.      * @param float $nTimeStart Starttime for difference
  133.      * @param float $nTimeStop  Endtime for difference
  134.      *
  135.      * @return float Time in ms.
  136.      */
  137.     public static function getTimeDifference($nTimeStart, $nTimeStop)
  138.     {
  139.         return ($nTimeStop - $nTimeStart) * 1000;
  140.     }
  141.  
  142.     /**
  143.      * Stops the timer
  144.      *
  145.      * @return ForwardFW_Object_Timer 
  146.      */
  147.     public function stop()
  148.     {
  149.         $this->nTimeStop = microtime(true);
  150.         return $this;
  151.     }
  152.  
  153.  
  154.     /**
  155.      * Gives time between start and stop.
  156.      *
  157.      * @return float Time in ms.
  158.      */
  159.     protected function getStopTime()
  160.     {
  161.         return $this->getTimeDifference($this->nTimeStart, $this->nTimeStop);
  162.     }
  163.  
  164.     /**
  165.      * Return execution information
  166.      *
  167.      * @return string execution info
  168.      */
  169.     public function toString()
  170.     {
  171.         $strEntry = implode(', ', $this->arEntries);
  172.         return '<br />' . $this->getStopTime() . ' ms'
  173.             . ' - ' . $this->strName
  174.             . ($strEntry != '' ? ' (' . $strEntry . ')' : '');
  175.     }
  176.  
  177.     /**
  178.      * Gives the array with all entries till yet.
  179.      *
  180.      * @return array of String with entries.
  181.      */
  182.     function getEntries()
  183.     {
  184.         return $this->arEntries;
  185.     }
  186. }
  187.  
  188. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:48 +0100 by phpDocumentor 1.4.3