Class XFDebug

Description

XFDebug handles all debugging purposes and requires XF::DEBUG to be 'true'

Located in /class.debug.php (line 26)


	
			
Variable Summary
static string $color
static array $trace
Method Summary
static string hexdump (string $data, [boolean $htmloutput = true], [boolean $uppercase = false], [boolean $return = false])
static integer prof ()
static true settracecolor (string $a)
static true todo ()
static mixed trace (string $a, string $b)
Variables
static string $color = 'fff' (line 34)
  • var: background color for next entry
  • access: protected
static array $trace = array() (line 30)
  • var: stores any debugging messages in debug mode (XF::DEBUG)
  • access: protected
Methods
static method hexdump (line 148)

do a hex dump of input

static string hexdump (string $data, [boolean $htmloutput = true], [boolean $uppercase = false], [boolean $return = false])
  • string $data: input stream
  • boolean $htmloutput: format output in HTML
  • boolean $uppercase: uppercase hex
  • boolean $return: return or echo the results?
static method prof (line 114)

set a mesure point for profiling. use multiple to have differences between them.

static integer prof ()
static method settracecolor (line 72)

sets background color for trace view

  • since: 1.0.0
  • access: public
static true settracecolor (string $a)
  • string $a: color in hexadecimal without #
static method todo (line 84)

builds todo list from source files and adds it to debug trace

format is '// TODO: [priority] message' or '* @todo [priority] message'

  • since: 1.0.0
  • access: public
static true todo ()
static method trace (line 46)

put an entry into debug trace (logging)

  • since: 1.0.0
  • access: public
static mixed trace (string $a, string $b)
  • string $a: description (usually ___METHOD__), null outputs trace
  • string $b: message

Documentation generated on Tue, 21 Oct 2008 20:58:00 +0200 by phpDocumentor 1.4.1