Rename Log class to DebugLog to avoid confusion
[gitphp.git] / include / DebugLog.class.php
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?php
/**
 * GitPHP DebugLog
 *
 * Debug Logging class
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 */
 
/**
 * Debug logging class
 *
 * @package GitPHP
 */
class GitPHP_DebugLog
{
        /**
         * instance
         *
         * Stores the singleton instance
         *
         * @access protected
         * @static
         */
        protected static $instance;
 
        /**
         * enabled
         *
         * Stores whether logging is enabled
         *
         * @access protected
         */
        protected $enabled = false;
 
        /**
         * benchmark
         *
         * Stores whether benchmarking is enabled
         *
         * @access protected
         */
        protected $benchmark = false;
 
        /**
         * startTime
         *
         * Stores the starting instant
         *
         * @access protected
         */
        protected $startTime;
 
        /**
         * startMem
         *
         * Stores the starting memory
         *
         * @access protected
         */
        protected $startMem;
 
        /**
         * entries
         *
         * Stores the log entries
         *
         * @access protected
         */
        protected $entries = array();
 
        /**
         * GetInstance
         *
         * Returns the singleton instance
         *
         * @access public
         * @static
         * @return mixed instance of logging clas
         */
        public static function GetInstance()
        {
                if (!self::$instance) {
                        $config = GitPHP_Config::GetInstance();
                        self::$instance = new GitPHP_DebugLog($config->GetValue('debug', false), $config->GetValue('benchmark', false));
                }
 
                return self::$instance;
        }
 
        /**
         * DestroyInstance
         *
         * Releases the singleton instance
         *
         * @access public
         * @static
         */
        public static function DestroyInstance()
        {
                self::$instance = null;
        }
 
        /**
         * __construct
         *
         * Constructor
         *
         * @access private
         * @return Log object
         */
        private function __construct($enabled = false, $benchmark = false)
        {
                $this->startTime = microtime(true);
                $this->startMem = memory_get_usage();
 
                $this->enabled = $enabled;
                $this->benchmark = $benchmark;
        }
 
        /**
         * SetStartTime
         *
         * Sets start time
         *
         * @access public
         * @param float $start starting microtime
         */
        public function SetStartTime($start)
        {
                $this->startTime = $start;
        }
 
        /**
         * SetStartMemory
         *
         * Sets start memory
         *
         * @access public
         * @param integer $start starting memory
         */
        public function SetStartMemory($start)
        {
                $this->startMem = $start;
        }
 
        /**
         * Log
         *
         * Log an entry
         *
         * @access public
         * @param string $message message to log
         */
        public function Log($message)
        {
                if (!$this->enabled)
                        return;
 
                $entry = array();
                
                if ($this->benchmark) {
                        $entry['time'] = microtime(true);
                        $entry['mem'] = memory_get_usage();
                }
 
                $entry['msg'] = $message;
                $this->entries[] = $entry;
        }
 
        /**
         * GetEnabled
         *
         * Gets whether logging is enabled
         *
         * @access public
         * @return boolean true if logging is enabled
         */
        public function GetEnabled()
        {
                return $this->enabled;
        }
 
        /**
         * SetEnabled
         *
         * Sets whether logging is enabled
         *
         * @access public
         * @param boolean $enable true if logging is enabled
         */
        public function SetEnabled($enable)
        {
                $this->enabled = $enable;
        }
 
        /**
         * GetBenchmark
         *
         * Gets whether benchmarking is enabled
         *
         * @access public
         * @return boolean true if benchmarking is enabled
         */
        public function GetBenchmark()
        {
                return $this->benchmark;
        }
 
        /**
         * SetBenchmark
         *
         * Sets whether benchmarking is enabled
         *
         * @access public
         * @param boolean $bench true if benchmarking is enabled
         */
        public function SetBenchmark($bench)
        {
                $this->benchmark = $bench;
        }
 
        /**
         * GetEntries
         *
         * Calculates times and gets log entries
         *
         * @access public
         * @return array log entries
         */
        public function GetEntries()
        {
                $data = array();
        
                if ($this->enabled) {
 
                        if ($this->benchmark) {
                                $endTime = microtime(true);
                                $endMem = memory_get_usage();
 
                                $lastTime = $this->startTime;
                                $lastMem = $this->startMem;
 
                                $data[] = 'DEBUG: [' . $this->startTime . '] [' . $this->startMem . ' bytes] Start';
 
                        }
 
                        foreach ($this->entries as $entry) {
                                if ($this->benchmark) {
                                        $data[] = 'DEBUG: [' . $entry['time'] . '] [' . ($entry['time'] - $this->startTime) . ' sec since start] [' . ($entry['time'] - $lastTime) . ' sec since last] [' . $entry['mem'] . ' bytes] [' . ($entry['mem'] - $this->startMem) . ' bytes since start] [' . ($entry['mem'] - $lastMem) . ' bytes since last] ' . $entry['msg'];
                                        $lastTime = $entry['time'];
                                        $lastMem = $entry['mem'];
                                } else {
                                        $data[] = 'DEBUG: ' . $entry['msg'];
                                }
                        }
 
                        if ($this->benchmark) {
                                $data[] = 'DEBUG: [' . $endTime . '] [' . ($endTime - $this->startTime) . ' sec since start] [' . ($endTime - $lastTime) . ' sec since last] [' . $endMem . ' bytes] [' . ($endMem - $this->startMem) . ' bytes since start] [' . ($endMem - $lastMem) . ' bytes since last] End';
                        }
                }
 
                return $data;
        }
 
}
 
comments