LoadTimer/LoadTimer.php at master · imkingdavid/LoadTimer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?php
/**
 * LoadTimer Class
 * A simple PHP load time measuring class.
 *
 * Version 1.0.0
 *
 * Copyright (c) 2012 - David King <imkingdavid@gmail.com>
 */

namespace imkingdavid\LoadTimer;

class LoadTimer
{
	/**
	 * The start time for the page load
	 * @var int
	 */
	protected $start = null;

	/**
	 * The end time for the page load
	 * @var int
	 */
	protected $end = null;

	/**
	 * The laps marked by the timer
	 * @var array
	 */
	protected $laps = [];

	/**
	 * The difference between the end and start time, aka the load time
	 * @var int
	 */
	protected $load_time = null;

	/**
	 * Start the page load timer
	 *
	 * @param bool $autoStart Whether to start the timer when the class is initialized
	 */
	public function __construct($autoStart = false)
	{
		if($autoStart) {
			$this->start();
		}
	}

	/**
	 * Start the timer
	 *
	 * @return null
	 */
	public function start()
	{
		$this->start = $this->currentTime();
	}

	/**
	 * Get the current time
	 *
	 * @return int Current time
	 */
	protected function currentTime()
	{
		return microtime(true);
	}

	/**
	* Add a lap
	*
	* @param string $message Label for the lap
	*/
	public function lap($message = '')
	{
		if (empty($message)) {
			$message = 'Lap ' . ($this->lapCount() + 1);
		}

		$this->laps[] = [
			$message,
			$this->currentTime(),
		];
	}

	/**
	* Get array of laps
	*
	* @return array
	*/
	public function laps()
	{
		return $this->laps;
	}

	/**
	* Return total number of laps
	*
	* @return int
	*/
	public function lapCount()
	{
		return count($this->laps());
	}

	/**
	 * Finish up the load time script
	 *
	 * @param bool $echo Whether to echo the string or not
	 * @param string $message String formatted for sprintf()
	 * @return float Returns the load time
	 */
	public function end($echo = false, $message = 'Page load took %f seconds')
	{
		if ($this->load_time === null && $this->end === null) {
			$this->end = $this->currentTime();
			$this->load_time = $this->getLoadTime();
		}

		if ($echo) {
			echo sprintf($message, $this->load_time);
		}

		return $this->load_time;
	}

	/**
	 * Return the load time
	 *
	 * @return float Returns the total load time
	 */
	public function getLoadTime()
	{
		return $this->load_time ?: $this->end - $this->start;
	}
}