1 <?php
  2 
  3 /**
  4 * Class for debugging and logging Control
  5 * 
  6 */
  7 
  8 /**
  9  * Debugs what is sent, according with debug configurations
 10  * @param   object      $this       object to debug
 11  */
 12 function Debug($this){
 13     MagratheaDebugger::Instance()->Add($this);
 14 }
 15 
 16 /**
 17  * Adds to info debug, according with configurations
 18  * @param   object      $this       object to debug
 19  */
 20 function Info($this){
 21     MagratheaDebugger::Instance()->Info($this);
 22 }
 23 
 24 /**
 25  * Magrathea Debugger can manage anything for debugging and error-searching through Magrathea Codes.
 26  * It can trace errors, save log files, print queries and do a bunch of functions that would help the developer on error searching
 27  */
 28 class MagratheaDebugger {
 29 
 30     const NONE = 0;
 31     const LOG = 2;
 32     const DEBUG = 3;
 33     const DEV = 4;
 34 
 35     private $logFile = null;
 36     private $debugItems = array();
 37     private $debugType = self::LOG;
 38     private $queries = false;
 39     private $oldDebugType = self::NONE;
 40     protected static $inst = null;
 41 
 42     // this is a singleton!
 43     private function __construct(){ }
 44 
 45     /**
 46     * Static singleton way to get the debugger instance
 47     */
 48     public static function Instance(){
 49         if (self::$inst === null) {
 50             self::$inst = new MagratheaDebugger();
 51         }
 52         return self::$inst;
 53     }
 54     public function MagratheaDebugger(){ }
 55 
 56     /**
 57     * Sets the debugger method
 58     * It can be: *DEV*, *DEBUG*, *LOG*, *NONE* =>
 59     * **MagratheaDebugger::DEV** = Will print the debugs as it appears in the code
 60     * **MagratheaDebugger::DEBUG** = Will store all the debugs and print it later
 61     * **MagratheaDebugger::LOG** = Will log queries and other debugs in the code
 62     * **MagratheaDebugger::NONE** = Well... nothing to do, heh?
 63     * Default: **LOG**
 64     *
 65     * @param    $dType  string  type to be set
 66     * @return   itself
 67     */
 68     public function SetType($dType){
 69         $this->debugType = strtolower($dType);
 70         return $this;
 71     }
 72 
 73     /**
 74      * Should debugger log queries?
 75      * @param   boolean     $q      true for logging queries, false for not
 76      * @return  itself
 77      */
 78     public function LogQueries($q){
 79         $this->queries =  $q;
 80         return $this;
 81     }
 82 
 83     /**
 84      * Set the name of log file that will be used
 85      *  (it will be created inside "*logs*" folder)
 86      * @param   string      $file       log file name
 87      * @return  itself
 88      */
 89     public function SetLogFile($file){
 90         $this->logFile = $file;
 91         return $this;
 92     }
 93 
 94     /**
 95      * Trace error location
 96      */
 97     public function Trace(){
 98         echo "<pre>"; debug_backtrace(); echo "</pre>";
 99     }
100 
101     /**
102     * Sets a debugger type temporarily
103     * (usefull when need to check a specific operation, for example)
104     *
105     * @param    string  $dType  type to be temporarily set
106     * @return   itself
107     */
108     public function SetTemp($dType){
109         $this->oldDebugType = $this->debugType;
110         $this->debugType = $dType;
111         return $this;
112     }
113 
114     /**
115     * After temporarily setting a debugging type, gets it back to what it was
116     *
117     * @return   itself
118     */
119     public function BackTemp(){
120         $this->debugType = $this->oldDebugType;
121         return $this;
122     }
123 
124     /**
125     * Returns the debug type
126     * @return string Debug type (*Dev*, *Debug*, *Log*, *None*)
127     */
128     public function GetType(){
129         return $this->debugType;
130     }
131 
132     /**
133     * Add an item to the debug array object
134     *   @param  string  $debug      debug item
135     */
136     public function Add($debug){
137         switch ($this->debugType) {
138             case self::NONE:
139                 return;
140                 break;
141             case self::LOG:
142                 MagratheaLogger::Log($debug, $this->logFile);
143                 return;
144                 break;
145             case self::DEV:
146                 echo "<pre>".$debug."</pre>";
147             case self::DEBUG:
148                 array_push($this->debugItems, $debug);
149                 break;
150         }
151     }
152 
153     /**
154      * Add an info item to the debug array object
155      *  @param      string      $debug      info item
156      */
157     public function Info($debug){
158         switch ($this->debugType) {
159             case self::NONE:
160             case self::LOG:
161                 MagratheaLogger::Log($debug, $this->logFile);
162                 return;
163                 break;
164             case self::DEV:
165                 echo "<pre>INFO: ".$debug."</pre>";
166             case self::DEBUG:
167                 array_push($this->debugItems, "<pre>".$debug."</pre>");
168                 break;
169         }
170     }
171 
172     /**
173      * Adds an error to the debugger
174      * @param Exception     $err    Exception
175      */
176     public function AddError($err){
177         $this->Add($err->getMessage());
178     }
179 
180     /** 
181     * Adds a query to the debug
182     *
183     *   @param  string  $sql    query to be debugged
184     *   @param  string  $values     values to be added to the query
185     */
186     public function AddQuery($sql, $values){
187         if($this->debugType == @NONE || !$this->queries) return;
188         $logThis = "query run: [".$sql."]";
189         if(!is_null($values)){
190             $logThis .= " - values: [".implode(',', $values)."]";
191         }
192         $this->Add($logThis);
193     }
194 
195     /**
196      * Adds an error to the debugger
197      * @param Exception     $err    Exception
198      */
199     public function Error($err){
200         $this->Add($err->getMessage());
201     }
202 
203     /**
204     * Prints the debug
205     */
206     public function Show(){
207         if(empty($this->debugItems)) return;
208         echo "<div style='width: 95%; border: 2px solid red; background-color: yellow; padding: 10px; margin: 10px;'>";
209         echo "MAGRATHEA DEBUG<br/><br/>";
210         foreach ($this->debugItems as $item) {
211             echo $this->printsDebug($item);
212         }
213         echo "</div>";
214     }
215 
216     /**
217      * prints every single line in p_r()
218      * @param   object      $debugToPrint       object to debug
219      */ 
220     private function printsDebug($deb){
221         $html = "";
222         if(is_a($deb, "MagratheaException")){
223             $html .= "<div style='padding: 10px; border: 1px dotted black; margin-bottom: 5px; line-height: 120%;'>";
224             $html .= "<span style='color: red; font-weight: bold;'>".get_class($deb)."</span><br/>";
225             $html .= "<span>".$deb->getMessage()."</span><br/>";
226             $html .= "<span style='padding-left: 20px;'><b>at: </b> ==> ";
227             $html .= "<b>File: </b>".$deb->getFile()." / <b>line: </b>[".$deb->getLine()."]</span><br/>";
228             $html .= "<div style='padding-left: 20px;'><b>trace: </b> ==> <br/>";
229             $html .= "<div style='padding-left: 10px;'>".$this->printTrace($deb->getTrace())."</div></div>";
230             $html .= "</div>";
231         } else if (is_array($deb)) {
232             $html .= "<div style='padding: 10px; border: 1px dotted black; margin-bottom: 5px; line-height: 120%;'>";
233             $html .= "<span>".nice_p_r($deb)."</span><br/>";
234             $html .= "</div>";
235         } else {
236             $html .= "<div style='padding: 10px; border: 1px dotted black; margin-bottom: 5px; line-height: 120%;'>";
237             $html .= "<span>".$deb."</span><br/>";
238             $html .= "</div>";
239         }
240         return $html;
241     }
242 
243     /**
244      * gets a trace array and returns a beautiful way of it printed
245      * @param   array       $trace      trace
246      * @return  string                  html of the trace printed
247      */
248     private function printTrace($trace){
249         $html = "";
250         foreach ($trace as $key => $val) {
251             $html .= "[".$key."]<br/>";
252             $html .= "&nbsp;&nbsp;&nbsp;&nbsp;<b>[file]</b> = ".@$val["file"]." <b>[line]</b> = ".@$val["line"]."<br/>";
253             $html .= "&nbsp;&nbsp;&nbsp;&nbsp;<b>[class]</b> = ".@$val["class"]." <b>[function]</b> = ".@$val["function"]."<br/>";
254         }
255         return $html;
256     }
257 
258 
259 }
260 
261 
262 
263 
264 ?>