tests/Debugger.php

   1 <?php
   2
   3 /**
   4  * Debugging tools.
   5  *
   6  * This file gives a developer a set of tools useful for performing code
   7  * consistency checks. This includes scoping code blocks to ensure that
   8  * only the interesting iteration of a loop gets outputted, a paint()
   9  * function that acts like var_dump() with pre tags, and conditional
  10  * printing.
  11  */
  12
  13 /*
  14 TODO
  15  * Integrate into SimpleTest so it tells us whether or not there were any
  16    not cleaned up debug calls.
  17  * Custom var_dump() that ignores blacklisted properties
  18  * DEPRECATE AND REMOVE ALL CALLS!
  19 */
  20
  21 /**#@+
  22  * Convenience global functions. Corresponds to method on Debugger.
  23  */
  24 function paint($mixed)
  25 {
  26     $Debugger =& Debugger::instance();
  27     return $Debugger->paint($mixed);
  28 }
  29 function paintIf($mixed, $conditional)
  30 {
  31     $Debugger =& Debugger::instance();
  32     return $Debugger->paintIf($mixed, $conditional);
  33 }
  34 function paintWhen($mixed, $scopes = array())
  35 {
  36     $Debugger =& Debugger::instance();
  37     return $Debugger->paintWhen($mixed, $scopes);
  38 }
  39 function paintIfWhen($mixed, $conditional, $scopes = array())
  40 {
  41     $Debugger =& Debugger::instance();
  42     return $Debugger->paintIfWhen($mixed, $conditional, $scopes);
  43 }
  44 function addScope($id = false)
  45 {
  46     $Debugger =& Debugger::instance();
  47     return $Debugger->addScope($id);
  48 }
  49 function removeScope($id)
  50 {
  51     $Debugger =& Debugger::instance();
  52     return $Debugger->removeScope($id);
  53 }
  54 function resetScopes()
  55 {
  56     $Debugger =& Debugger::instance();
  57     return $Debugger->resetScopes();
  58 }
  59 function isInScopes($array = array())
  60 {
  61     $Debugger =& Debugger::instance();
  62     return $Debugger->isInScopes($array);
  63 }
  64 /**#@-*/
  65
  66
  67 /**
  68  * The debugging singleton. Most interesting stuff happens here.
  69  */
  70 class Debugger
  71 {
  72
  73     public $shouldPaint = false;
  74     public $paints  = 0;
  75     public $current_scopes = array();
  76     public $scope_nextID = 1;
  77     public $add_pre = true;
  78
  79     public function __construct()
  80     {
  81         $this->add_pre = !extension_loaded('xdebug');
  82     }
  83
  84     public static function &instance() {
  85         static $soleInstance = false;
  86         if (!$soleInstance) $soleInstance = new Debugger();
  87         return $soleInstance;
  88     }
  89
  90     public function paintIf($mixed, $conditional)
  91     {
  92         if (!$conditional) return;
  93         $this->paint($mixed);
  94     }
  95
  96     public function paintWhen($mixed, $scopes = array())
  97     {
  98         if (!$this->isInScopes($scopes)) return;
  99         $this->paint($mixed);
 100     }
 101
 102     public function paintIfWhen($mixed, $conditional, $scopes = array())
 103     {
 104         if (!$conditional) return;
 105         if (!$this->isInScopes($scopes)) return;
 106         $this->paint($mixed);
 107     }
 108
 109     public function paint($mixed)
 110     {
 111         $this->paints++;
 112         if($this->add_pre) echo '<pre>';
 113         var_dump($mixed);
 114         if($this->add_pre) echo '</pre>';
 115     }
 116
 117     public function addScope($id = false)
 118     {
 119         if ($id == false) {
 120             $id = $this->scope_nextID++;
 121         }
 122         $this->current_scopes[$id] = true;
 123     }
 124
 125     public function removeScope($id)
 126     {
 127         if (isset($this->current_scopes[$id])) unset($this->current_scopes[$id]);
 128     }
 129
 130     public function resetScopes()
 131     {
 132         $this->current_scopes = array();
 133         $this->scope_nextID = 1;
 134     }
 135
 136     public function isInScopes($scopes = array())
 137     {
 138         if (empty($this->current_scopes)) {
 139             return false;
 140         }
 141         if (!is_array($scopes)) {
 142             $scopes = array($scopes);
 143         }
 144         foreach ($scopes as $scope_id) {
 145             if (empty($this->current_scopes[$scope_id])) {
 146                 return false;
 147             }
 148         }
 149         if (empty($scopes)) {
 150             if ($this->scope_nextID == 1) {
 151                 return false;
 152             }
 153             for($i = 1; $i < $this->scope_nextID; $i++) {
 154                 if (empty($this->current_scopes[$i])) {
 155                     return false;
 156                 }
 157             }
 158         }
 159         return true;
 160     }
 161
 162 }
 163
 164 // vim: et sw=4 sts=4