PageRenderTime 24ms CodeModel.GetById 13ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/system/core/Benchmark.php

https://bitbucket.org/Naked_Yoshi/sq_kanban
PHP | 133 lines | 29 code | 11 blank | 93 comment | 3 complexity | dcb273169900727d18cf5204d5768d42 MD5 | raw file
  1<?php
  2/**
  3 * CodeIgniter
  4 *
  5 * An open source application development framework for PHP
  6 *
  7 * This content is released under the MIT License (MIT)
  8 *
  9 * Copyright (c) 2014 - 2017, British Columbia Institute of Technology
 10 *
 11 * Permission is hereby granted, free of charge, to any person obtaining a copy
 12 * of this software and associated documentation files (the "Software"), to deal
 13 * in the Software without restriction, including without limitation the rights
 14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 15 * copies of the Software, and to permit persons to whom the Software is
 16 * furnished to do so, subject to the following conditions:
 17 *
 18 * The above copyright notice and this permission notice shall be included in
 19 * all copies or substantial portions of the Software.
 20 *
 21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 27 * THE SOFTWARE.
 28 *
 29 * @package	CodeIgniter
 30 * @author	EllisLab Dev Team
 31 * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
 32 * @copyright	Copyright (c) 2014 - 2017, British Columbia Institute of Technology (http://bcit.ca/)
 33 * @license	http://opensource.org/licenses/MIT	MIT License
 34 * @link	https://codeigniter.com
 35 * @since	Version 1.0.0
 36 * @filesource
 37 */
 38defined('BASEPATH') OR exit('No direct script access allowed');
 39
 40/**
 41 * Benchmark Class
 42 *
 43 * This class enables you to mark points and calculate the time difference
 44 * between them. Memory consumption can also be displayed.
 45 *
 46 * @package		CodeIgniter
 47 * @subpackage	Libraries
 48 * @category	Libraries
 49 * @author		EllisLab Dev Team
 50 * @link		https://codeigniter.com/user_guide/libraries/benchmark.html
 51 */
 52class CI_Benchmark {
 53
 54	/**
 55	 * List of all benchmark markers
 56	 *
 57	 * @var	array
 58	 */
 59	public $marker = array();
 60
 61	/**
 62	 * Set a benchmark marker
 63	 *
 64	 * Multiple calls to this function can be made so that several
 65	 * execution points can be timed.
 66	 *
 67	 * @param	string	$name	Marker name
 68	 * @return	void
 69	 */
 70	public function mark($name)
 71	{
 72		$this->marker[$name] = microtime(TRUE);
 73	}
 74
 75	// --------------------------------------------------------------------
 76
 77	/**
 78	 * Elapsed time
 79	 *
 80	 * Calculates the time difference between two marked points.
 81	 *
 82	 * If the first parameter is empty this function instead returns the
 83	 * {elapsed_time} pseudo-variable. This permits the full system
 84	 * execution time to be shown in a template. The output class will
 85	 * swap the real value for this variable.
 86	 *
 87	 * @param	string	$point1		A particular marked point
 88	 * @param	string	$point2		A particular marked point
 89	 * @param	int	$decimals	Number of decimal places
 90	 *
 91	 * @return	string	Calculated elapsed time on success,
 92	 *			an '{elapsed_string}' if $point1 is empty
 93	 *			or an empty string if $point1 is not found.
 94	 */
 95	public function elapsed_time($point1 = '', $point2 = '', $decimals = 4)
 96	{
 97		if ($point1 === '')
 98		{
 99			return '{elapsed_time}';
100		}
101
102		if ( ! isset($this->marker[$point1]))
103		{
104			return '';
105		}
106
107		if ( ! isset($this->marker[$point2]))
108		{
109			$this->marker[$point2] = microtime(TRUE);
110		}
111
112		return number_format($this->marker[$point2] - $this->marker[$point1], $decimals);
113	}
114
115	// --------------------------------------------------------------------
116
117	/**
118	 * Memory Usage
119	 *
120	 * Simply returns the {memory_usage} marker.
121	 *
122	 * This permits it to be put it anywhere in a template
123	 * without the memory being calculated until the end.
124	 * The output class will swap the real value for this variable.
125	 *
126	 * @return	string	'{memory_usage}'
127	 */
128	public function memory_usage()
129	{
130		return '{memory_usage}';
131	}
132
133}