Benchmark.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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 - 2019, 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 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
  33. * @license https://opensource.org/licenses/MIT MIT License
  34. * @link https://codeigniter.com
  35. * @since Version 1.0.0
  36. * @filesource
  37. */
  38. defined('BASEPATH') OR exit('No direct script access allowed');
  39. /**
  40. * Benchmark Class
  41. *
  42. * This class enables you to mark points and calculate the time difference
  43. * between them. Memory consumption can also be displayed.
  44. *
  45. * @package CodeIgniter
  46. * @subpackage Libraries
  47. * @category Libraries
  48. * @author EllisLab Dev Team
  49. * @link https://codeigniter.com/user_guide/libraries/benchmark.html
  50. */
  51. class CI_Benchmark {
  52. /**
  53. * List of all benchmark markers
  54. *
  55. * @var array
  56. */
  57. public $marker = array();
  58. /**
  59. * Set a benchmark marker
  60. *
  61. * Multiple calls to this function can be made so that several
  62. * execution points can be timed.
  63. *
  64. * @param string $name Marker name
  65. * @return void
  66. */
  67. public function mark($name)
  68. {
  69. $this->marker[$name] = microtime(TRUE);
  70. }
  71. // --------------------------------------------------------------------
  72. /**
  73. * Elapsed time
  74. *
  75. * Calculates the time difference between two marked points.
  76. *
  77. * If the first parameter is empty this function instead returns the
  78. * {elapsed_time} pseudo-variable. This permits the full system
  79. * execution time to be shown in a template. The output class will
  80. * swap the real value for this variable.
  81. *
  82. * @param string $point1 A particular marked point
  83. * @param string $point2 A particular marked point
  84. * @param int $decimals Number of decimal places
  85. *
  86. * @return string Calculated elapsed time on success,
  87. * an '{elapsed_string}' if $point1 is empty
  88. * or an empty string if $point1 is not found.
  89. */
  90. public function elapsed_time($point1 = '', $point2 = '', $decimals = 4)
  91. {
  92. if ($point1 === '')
  93. {
  94. return '{elapsed_time}';
  95. }
  96. if ( ! isset($this->marker[$point1]))
  97. {
  98. return '';
  99. }
  100. if ( ! isset($this->marker[$point2]))
  101. {
  102. $this->marker[$point2] = microtime(TRUE);
  103. }
  104. return number_format($this->marker[$point2] - $this->marker[$point1], $decimals);
  105. }
  106. // --------------------------------------------------------------------
  107. /**
  108. * Memory Usage
  109. *
  110. * Simply returns the {memory_usage} marker.
  111. *
  112. * This permits it to be put it anywhere in a template
  113. * without the memory being calculated until the end.
  114. * The output class will swap the real value for this variable.
  115. *
  116. * @return string '{memory_usage}'
  117. */
  118. public function memory_usage()
  119. {
  120. return '{memory_usage}';
  121. }
  122. }