ColdBox Platform Version 2.6.4

coldbox.system.plugins
Class Logger

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by coldbox.system.plugins.Logger

public class Logger
extends Plugin

This is the frameworks Logger object. It is used for all logging facilities interfacing with LogBox and the ColdBox debugger.


Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 void debug(string Message, [string ExtraInfo=''])
          I log a debug message
private void emailBugReport(string bugReport)
          Email a bug report
 void error(string Message, [string ExtraInfo=''])
          I log an error message
 void fatal(string Message, [string ExtraInfo=''])
          I log a fatal message
 Logger getLogger()
          This coldbox apps's logger
 void info(string Message, [string ExtraInfo=''])
          I log an information message
 void logEntry(string Severity, string Message, [string ExtraInfo=''])
          Log a message to the LogBox
 void logError(string Message, [any ExceptionStruct='[runtime expression]'], [any ExtraInfo=''])
          Log an error into the framework using arguments
 void logErrorWithBean(any ExceptionBean)
          Log an error into the framework using a coldbox exceptionBean
 void tracer(string message, [any extraInfo=''])
          Log a trace message to the ColdBox debugger panel, not LOGBOX
 void warn(string Message, [string ExtraInfo=''])
          I log a warning message
 
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, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller
Method Detail

debug

public void debug(string Message, [string ExtraInfo=''])
I log a debug message.

Parameters:
Message - The message to log.
ExtraInfo - Extra information to append.

emailBugReport

private void emailBugReport(string bugReport)
Email a bug report

Parameters:
bugReport - The bug report

error

public void error(string Message, [string ExtraInfo=''])
I log an error message.

Parameters:
Message - The message to log.
ExtraInfo - Extra information to append.

fatal

public void fatal(string Message, [string ExtraInfo=''])
I log a fatal message.

Parameters:
Message - The message to log.
ExtraInfo - Extra information to append.

getLogger

public Logger getLogger()
This coldbox apps's logger.


info

public void info(string Message, [string ExtraInfo=''])
I log an information message.

Parameters:
Message - The message to log.
ExtraInfo - Extra information to append.

logEntry

public void logEntry(string Severity, string Message, [string ExtraInfo=''])
Log a message to the LogBox

Parameters:
Severity - Severity: fatal,error,warn,info,debug,trace
Message - The message to log.
ExtraInfo - Extra information to append.

logError

public void logError(string Message, [any ExceptionStruct='[runtime expression]'], [any ExtraInfo=''])
Log an error into the framework using arguments. Facade to logErrorWithBean.

Parameters:
Message
ExceptionStruct - The CF cfcatch structure.
ExtraInfo

logErrorWithBean

public void logErrorWithBean(any ExceptionBean)
Log an error into the framework using a coldbox exceptionBean

Parameters:
ExceptionBean - This is the exception bean

tracer

public void tracer(string message, [any extraInfo=''])
Log a trace message to the ColdBox debugger panel, not LOGBOX

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

warn

public void warn(string Message, [string ExtraInfo=''])
I log a warning message.

Parameters:
Message - The message to log.
ExtraInfo - Extra information to append.

ColdBox Platform Version 2.6.4