api.zedseries.com
[ class tree: Debug ] [ index: Debug ] [ all elements ]

Class: ZedSeriesDebug

Source Location: /ZedSeriesDebug.php

Class ZedSeriesDebug

Class Overview

Class ZedSeriesDebug

A static class with debugging related facilities

Located in /ZedSeriesDebug.php [line 26]



		
				Author(s):
		
		
		
Information Tags:
Copyright:  Angelo Galleja 2008,2009,2010

Properties

Methods

[ Top ]
Property Summary
static mixed   $_data  

[ Top ]
Method Summary
static void   add()   add a string to debug log registry without printing it (so no "headers already sent" error appears)
static array   btrace()   an improved debug_backtrace function with level and order selection
static void   debugLog()   helper function for debug module
static void   displayErrors()   a quick way to enable the display of errors
static string   dump()   returns the content of log registry if a tag name is specified the output will be "wrapped" into the specified tag
static void   dumpKeys()  
static void   error()   wrapper function for debug module channel error
static void;   fwrite()   write the content of log registry to system/logs/zedseriesdebug.log
static void   info()   wrapper function for debug module channel info
static void   log()   wrapper function for debug module channel log
static void   pbtrace()   print the result of btrace
static void   pdump()   print the content of log registry
static void   warn()   wrapper function for debug module channel warn

[ Top ]
Properties
static mixed   $_data = array() [line 28]
API Tags:
Access:  protected


[ Top ]
Methods
static method add  [line 91]

  static void add( string $str  )

add a string to debug log registry without printing it (so no "headers already sent" error appears)

You can then retrieve the content of registry using dump or print it using pdump

Parameters:
string   $str: 

API Tags:
Access:  public


[ Top ]
static method btrace  [line 211]

  static array btrace( [int $level = 0], [bool $reverseOrder = false], [string $filterFnc = null]  )

an improved debug_backtrace function with level and order selection

Parameters:
int   $level: 
bool   $reverseOrder:  whether to show lines in reverse order
string   $filterFnc:  filterFnc a function name: if a filter function is set btrace will return an array of array from params of each call

API Tags:
Access:  public


[ Top ]
static method debugLog  [line 36]

  static void debugLog( $label, $message, [ $channel = 'log']  )

helper function for debug module

take a look at http://websvn.cyberspectrum.de/wsvn/tl_debug/ for web svn interface to the extension

Parameters:
   $label: 
   $message: 
   $channel: 

API Tags:
Access:  public


[ Top ]
static method displayErrors  [line 269]

  static void displayErrors( )

a quick way to enable the display of errors

use this function only in a testing environment


API Tags:
Access:  public


[ Top ]
static method dump  [line 147]

  static string dump( [string $tag = '']  )

returns the content of log registry if a tag name is specified the output will be "wrapped" into the specified tag

e.g. you can call ZedSeriesDebug::dump('textarea') to obtain the log registry inside a textarea

Parameters:
string   $tag:  the tag into which the output will be wrapped

API Tags:
Access:  public


[ Top ]
static method dumpKeys  [line 101]

  static void dumpKeys( array $arrData, string $strPattern, [ $mode = 'startswith']  )

Parameters:
string   $strPattern: 
array   $arrData:  array values to dump
   $mode: 

API Tags:
Access:  public


[ Top ]
static method error  [line 49]

  static void error( $label, $message  )

wrapper function for debug module channel error

Parameters:
   $label: 
   $message: 

API Tags:
See:  ZedSeriesDebug::debugLog()
Access:  public


[ Top ]
static method fwrite  [line 129]

  static void; fwrite( )

write the content of log registry to system/logs/zedseriesdebug.log


API Tags:
Access:  public


[ Top ]
static method info  [line 70]

  static void info( $label, $message  )

wrapper function for debug module channel info

Parameters:
   $label: 
   $message: 

API Tags:
See:  ZedSeriesDebug::debugLog()
Access:  public


[ Top ]
static method log  [line 60]

  static void log( $label, $message  )

wrapper function for debug module channel log

Parameters:
   $label: 
   $message: 

API Tags:
See:  ZedSeriesDebug::debugLog()
Access:  public


[ Top ]
static method pbtrace  [line 196]

  static void pbtrace( [ $level = 0], [ $reverseOrder = false], [ $filterFnc = null]  )

print the result of btrace

see the btrace signature for an explanation of the parameters list

Parameters:
   $level: 
   $reverseOrder: 
   $filterFnc: 

API Tags:
Access:  public


[ Top ]
static method pdump  [line 164]

  static void pdump( [bool $useHeaderTextPlain = false], [bool $exitAfter = false]  )

print the content of log registry

you can output it in text/plain or html format

Parameters:
bool   $useHeaderTextPlain:  whether to print it in text/plain format (otherwise html format will be used)
bool   $exitAfter:  whether to exit after printing

API Tags:
Access:  public


[ Top ]
static method warn  [line 79]

  static void warn( $label, $message  )

wrapper function for debug module channel warn

Parameters:
   $label: 
   $message: 

API Tags:
See:  ZedSeriesDebug::debugLog()
Access:  public


[ Top ]

Documentation generated on Fri, 22 Oct 2010 17:37:16 +0200 by phpDocumentor 1.4.1