ColdBox Platform Version 2.6.4

coldbox.system.services
Class DebuggerService

WEB-INF.cftags.component
        extended by coldbox.system.services.BaseService
            extended by coldbox.system.services.DebuggerService

public class DebuggerService
extends BaseService

This is the service that powers the ColdBox Debugger.


Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 string getCookieName()
          Get cookieName
 boolean getDebugMode()
          I Get the current user's debugmode
 DebuggerConfig getDebuggerConfig()
          Get DebuggerConfig
 array getProfilers()
          Get Profilers
 query getTimers()
          Get the timers query from the request
 array getTracers()
          Get Tracers
 boolean isDebugCookieValid()
          Checks if the debug cookie is a valid cookie
 void popProfiler()
          Pop a profiler record
 void pushProfiler(query profilerRecord)
          Push a profiler record
 void pushTracer(string message, [any extraInfo=''])
          Push a new tracer
 void recordProfiler()
          This method will try to push a profiler record
 Any renderCacheDumper()
          Renders the caching key value dumper
 Any renderCachePanel()
          Renders the caching panel
 Any renderDebugLog()
          Return the debug log
 Any renderProfiler()
          Renders the execution profilers
 void resetTracers()
          Reset all Tracers
 void setCookieName(string cookieName)
          Set cookieName
 void setDebugMode(boolean mode)
          I set the current user's debugmode
 void setDebuggerConfig(DebuggerConfig DebuggerConfig)
          Set DebuggerConfig
 void setProfilers(array Profilers)
          Set Profilers
 void setTracers(array Tracers)
          Set Tracers
 void timerEnd(string labelHash='')
          End an internal code timer
 string timerStart(string label)
          Start an internal code timer and get a hash of the timer storage
 boolean timersExist()
          Do we have any request timers
 
Methods inherited from class coldbox.system.services.BaseService
convertToColdBox, debug, getColdboxOCM, getLogger, getUtil, getcontroller, isFamilyType, onAspectsLoad, onConfigurationLoad, onShutdown, setcontroller
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller
Method Detail

getCookieName

public string getCookieName()
Get cookieName


getDebugMode

public boolean getDebugMode()
I Get the current user's debugmode


getDebuggerConfig

public DebuggerConfig getDebuggerConfig()
Get DebuggerConfig


getProfilers

public array getProfilers()
Get Profilers


getTimers

public query getTimers()
Get the timers query from the request. Empty query if it does not exist.


getTracers

public array getTracers()
Get Tracers


isDebugCookieValid

public boolean isDebugCookieValid()
Checks if the debug cookie is a valid cookie


popProfiler

public void popProfiler()
Pop a profiler record


pushProfiler

public void pushProfiler(query profilerRecord)
Push a profiler record

Parameters:
profilerRecord - The profiler query for this request

pushTracer

public void pushTracer(string message, [any extraInfo=''])
Push a new tracer

Parameters:
message - Message to Send
extraInfo - Extra Information to dump on the trace

recordProfiler

public void recordProfiler()
This method will try to push a profiler record


renderCacheDumper

public Any renderCacheDumper()
Renders the caching key value dumper.


renderCachePanel

public Any renderCachePanel()
Renders the caching panel.


renderDebugLog

public Any renderDebugLog()
Return the debug log.


renderProfiler

public Any renderProfiler()
Renders the execution profilers.


resetTracers

public void resetTracers()
Reset all Tracers


setCookieName

public void setCookieName(string cookieName)
Set cookieName

Parameters:
cookieName

setDebugMode

public void setDebugMode(boolean mode)
I set the current user's debugmode

Parameters:
mode

setDebuggerConfig

public void setDebuggerConfig(DebuggerConfig DebuggerConfig)
Set DebuggerConfig

Parameters:
DebuggerConfig

setProfilers

public void setProfilers(array Profilers)
Set Profilers

Parameters:
Profilers

setTracers

public void setTracers(array Tracers)
Set Tracers

Parameters:
Tracers

timerEnd

public void timerEnd(string labelHash='')
End an internal code timer

Parameters:
labelHash - The timer label hash to stop

timerStart

public string timerStart(string label)
Start an internal code timer and get a hash of the timer storage

Parameters:
label - The timer label to record

timersExist

public boolean timersExist()
Do we have any request timers


ColdBox Platform Version 2.6.4