Class PHPDS_debug

Description

Adds FirePHP support to PHPDevShell.

  • author: Greg
  • version: 1.0.2 (greg)

Located in /PHPDS_debug.class.php (line 27)

PHPDS_dependant
   |
   --PHPDS_debug
Class Constant Summary
 DEBUG = 4
 ERROR = 1
 INFO = 3
 LOG = 0
 WARN = 2
Variable Summary
mixed $conduits
mixed $domain
mixed $enabled
mixed $level
Method Summary
void construct ([$domain $domain = null])
void debug (mixed $data)
string, domain ([$domain $domain = null])
void dump ($data $data, [$label $label = 'data'])
boolean enable ([$doit $doit = null])
void error ( $datal, mixed $data)
void info (mixed $data)
boolean isEnabled ()
void log ($data $data, [$label $label = null])
void process (mixed $data)
void warn (mixed $data)
void warning (mixed $data)
void __invoke ( $data, [ $label = null])
Variables
mixed $conduits = null (line 38)
  • access: protected
mixed $domain (line 37)
  • access: protected
mixed $enabled = false (line 35)
  • access: protected
mixed $level = PHPDS_debug::LOG (line 36)
  • access: protected

Inherited Variables

Inherited from PHPDS_dependant

PHPDS_dependant::$dependance
PHPDS_dependant::$parent
Methods
construct (line 46)
  • version: 1.1.1
  • date: 20110202 (v1.1) (greg) moved to construct() instead of __cosntruct()
  • date: 20110216 (v1.1.1) (greg) fixed a bug with enable
  • access: public
void construct ([$domain $domain = null])
  • $domain $domain: the semantic domain of the debug object (to match (or not) the filters are set in configuration)

Redefinition of:
PHPDS_dependant::construct()
Empty function called by the actual constructor; meant to be overriden
debug (line 165)

Push Firebug Debug Info

  • access: public
void debug (mixed $data)
  • mixed $data
domain (line 74)

Accessor for the domain field: get (and possibily set) the domain

The domain is the semantic field of the data sent to this instance ; it's used to filter which data will be actually sent Note: the object will enable/disabled itself based on the domain debug configuration: the domain MUST be in the array to be active.

  • return: the domain (maybe null)
  • author: greg
  • version: 1.1
  • date: 20110216 (v1.1) (greg) domain filters can now be regex
  • access: public
string, domain ([$domain $domain = null])
  • $domain $domain: string (optional) the semantic domain
dump (line 136)

Dump the content of a variable to the backends

  • access: public
void dump ($data $data, [$label $label = 'data'])
  • $data $data
  • $label $label
enable (line 106)

Enable or disable the debugger output ; get the current state

Note: at this time, the debugger has to be enabled at startup

  • return: weither it's currently enabled
boolean enable ([$doit $doit = null])
  • $doit $doit: (optional) enable (true or disable (false)
error (line 210)

Push Firebug Error

  • access: public
void error ( $datal, mixed $data)
  • mixed $data
  • $datal
info (line 177)

Push Firebug Info

  • access: public
void info (mixed $data)
  • mixed $data

Redefinition of:
PHPDS_dependant::info()
DEPRECATED: alias for _log()
isEnabled (line 117)

Is this instance sending data?

  • access: public
boolean isEnabled ()
log (line 150)

Log the data to the backends with the LOG level (the smallest, most often seen)

  • access: public
void log ($data $data, [$label $label = null])
  • $data $data
  • $label $label

Redefinition of:
PHPDS_dependant::log()
Send info data to the debug subsystem (console, firebug, ...)
process (line 222)

FirePHP Process

  • access: public
void process (mixed $data)
  • mixed $data
warn (line 189)

Push Firebug Warning

  • access: public
void warn (mixed $data)
  • mixed $data
warning (line 200)

Push Firebug Warning

  • access: public
void warning (mixed $data)
  • mixed $data
__invoke (line 125)

Magic method: shortcut to log($ata)

  • access: public
void __invoke ( $data, [ $label = null])
  • $data
  • $label

Inherited Methods

Inherited From PHPDS_dependant

PHPDS_dependant::__construct()
PHPDS_dependant::construct()
PHPDS_dependant::debugInstance()
PHPDS_dependant::factory()
PHPDS_dependant::factoryWith()
PHPDS_dependant::info()
PHPDS_dependant::log()
PHPDS_dependant::PHPDS_dependance()
PHPDS_dependant::_log()
PHPDS_dependant::__call()
PHPDS_dependant::__get()
PHPDS_dependant::__set()
Class Constants
DEBUG = 4 (line 30)
ERROR = 1 (line 33)
INFO = 3 (line 31)
LOG = 0 (line 34)
WARN = 2 (line 32)

Documentation generated on Tue, 09 Aug 2011 09:05:11 +0200 by phpDocumentor 1.4.3