ColdBox Platform Version 3.7.0

coldbox.system.web.services
Class DebuggerService

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

public class DebuggerService
extends BaseService

This is the service that powers the ColdBox Debugger.


Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 any getCookieName()
          Get cookieName
 any<Boolean> getDebugMode()
          I Get the current user's debugmode
 any getDebuggerConfig()
          Get DebuggerConfig: coldbox
 array getProfilers()
          Get Profilers
 any getTimers()
          Get the timers query from the request
 array getTracers()
          Get Tracers
 any isDebugCookieValid()
          Checks if the debug cookie is a valid cookie
 void onConfigurationLoad()
          Called by loader service when configuration file loads
 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 renderDebugLog()
          Return the debug log
 Any renderProfiler()
          Renders the execution profilers
 void resetProfilers()
          Reset all 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(any labelHash='')
          End an internal code timer
 any timerStart(any label)
          Start an internal code timer and get a hash of the timer storage
 any timersExist()
          Do we have any request timers
 
Methods inherited from class coldbox.system.web.services.BaseService
convertToColdBox, getColdboxOCM, getController, getUtil, isFamilyType, onShutdown, setController
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller
Method Detail

getCookieName

public any getCookieName()
Get cookieName


getDebugMode

public any<Boolean> getDebugMode()
I Get the current user's debugmode. Boolean


getDebuggerConfig

public any getDebuggerConfig()
Get DebuggerConfig: coldbox.system.web.config.DebuggerConfig


getProfilers

public array getProfilers()
Get Profilers


getTimers

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


getTracers

public array getTracers()
Get Tracers


isDebugCookieValid

public any isDebugCookieValid()
Checks if the debug cookie is a valid cookie. Boolean


onConfigurationLoad

public void onConfigurationLoad()
Called by loader service when configuration file loads

Overrides:
onConfigurationLoad in class BaseService

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


renderDebugLog

public Any renderDebugLog()
Return the debug log.


renderProfiler

public Any renderProfiler()
Renders the execution profilers.


resetProfilers

public void resetProfilers()
Reset all 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(any labelHash='')
End an internal code timer

Parameters:
labelHash - The timer label hash to stop

timerStart

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

Parameters:
label - The timer label to record

timersExist

public any timersExist()
Do we have any request timers. Boolean


ColdBox Platform Version 3.7.0