coldbox.system.plugins

Class Timer

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by coldbox.system.plugins.Timer
Class Attributes:
  • cache : true
    •  
  • output : false
    •  

    This is the Timer plugin. It is used to time executions. Facade for request variable

    Constructor Summary
    init(any controller)
          Constructor.
    Method Summary
    private void addRow(string label, string tickcount)
         Add a new timer row.
    query getTimerScope()
         Returns the entire timer query from the request scope.
    void logTime(string Label, string Tickcount)
         Use this method to add a new timer entry to the timers.
    void start(string Label)
         Start the Timer with label.
    void stop(string Label)
         Stop the timer with label.
     
    Methods inherited from class coldbox.system.Plugin
    getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    $abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
     
    Methods inherited from class WEB-INF.cftags.component
    None
    Constructor Detail

    init

    public init(any controller)

    Constructor

    Parameters:
    controller
    Method Detail

    addRow

    private void addRow(string label, string tickcount)

    Add a new timer row.

    Parameters:
    label - The lable of the timer.
    tickcount - The tickcounts of the time.

    getTimerScope

    public query getTimerScope()

    Returns the entire timer query from the request scope.

    logTime

    public void logTime(string Label, string Tickcount)

    Use this method to add a new timer entry to the timers.

    Parameters:
    Label - The lable of the timer.
    Tickcount - The tickcounts of the time.

    start

    public void start(string Label)

    Start the Timer with label.

    Parameters:
    Label

    stop

    public void stop(string Label)

    Stop the timer with label

    Parameters:
    Label