classes/plbacktrace.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2007 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 /** Ligth debugging tool to generate execution backtrace
  23  */
  24 class PlBacktrace
  25 {
  26     static public $bt = array();
  27
  28     public $traces    = array();
  29     public $totaltime = 0.0;
  30     public $error     = false;
  31
  32     function __construct($name, array $init = array(), $sizef = 'rows', $timef = 'exectime', $errorf = 'error')
  33     {
  34         PlBacktrace::$bt[$name] = $this;
  35         foreach ($init as &$entry) {
  36             $this->add($entry, $sizef, $timef, $errorf);
  37         }
  38     }
  39
  40     private function add(array &$entry, $sizef = 'rows', $timef = 'exectime', $errorf = 'error')
  41     {
  42         $trace = array();
  43         $trace['action'] = $entry['action'];
  44         unset($entry['action']);
  45         $trace['exectime'] = @$entry[$timef];
  46         $this->totaltime += $trace['exectime'];
  47         unset($entry[$timef]);
  48         $trace['rows'] = @$entry[$sizef];
  49         unset($entry[$sizef]);
  50         $trace['error'] = @$entry[$errorf];
  51         unset($entry[$errorf]);
  52         if ($trace['error']) {
  53             $this->error = true;
  54         }
  55         $trace['data'] = array($entry);
  56         $this->traces[] =& $trace;
  57     }
  58
  59     public function newEvent($action, $rows = 0, $error = null, array $userdata = array())
  60     {
  61         $trace = array('action' => $action, 'time' => 0);
  62         $this->traces[] =& $trace;
  63         $this->update($rows, $error, $userdata);
  64     }
  65
  66     public function start($action)
  67     {
  68         $this->traces[] =  array('action' => $action, 'starttime' => microtime(true));;
  69     }
  70
  71     public function stop($rows = 0, $error = null, array $userdata = array())
  72     {
  73         $time = microtime(true);
  74         if (!$this->traces) {
  75             return;
  76         }
  77         $trace =& $this->traces[count($this->traces) - 1];
  78         $trace['exectime'] = $time - $trace['starttime'];
  79         unset($trace['starttime']);
  80         $this->totaltime += $trace['exectime'];
  81         $this->update($rows, $error, $userdata);
  82     }
  83
  84     public function update($rows = 0, $error = null, array $userdata = array())
  85     {
  86         $trace =& $this->traces[count($this->traces) - 1];
  87         $trace['rows']  = $rows;
  88         $trace['error'] = $error;
  89         $trace['data']  = $userdata;
  90         if ($trace['error']) {
  91             $this->error = true;
  92         }
  93     }
  94
  95     public static function clean()
  96     {
  97         foreach (PlBacktrace::$bt as $name=>&$entry) {
  98             if (!$entry->traces) {
  99                 unset(PlBacktrace::$bt[$name]);
 100             }
 101         }
 102     }
 103 }
 104
 105 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 106 ?>