coldbox.system

Class EventHandler

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp * www.ortussolutions.com * --- * Base class for all event handlers * @author Luis Majano

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
    Property Summary
    type property default serializable required
    any cachebox


    • access = public
    • returntype = any
    		 true false
    any controller


    • access = public
    • returntype = any
    		 true false
    any flash


    • access = public
    • returntype = any
    		 true false
    any log


    • access = public
    • returntype = any
    		 true false
    any logBox


    • access = public
    • returntype = any
    		 true false
    any wirebox


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any controller)
          Constructor.
    Method Summary
    boolean _actionExists(any action)
         Verifies if an action exists in the current event handler, public or private.
    struct _actionMetadata(any action)
         Return action metadata in the current event handler, public or private.
    any _privateInvoker(any method, any argCollection)
         _privateInvoker for private events.
    string getCachebox()
    string getFlash()
    string getLog()
    string getLogBox()
    string getWirebox()
    any setCachebox(any cachebox)
    any setFlash(any flash)
    any setLog(any log)
    any setLogBox(any logBox)
    any setWirebox(any wirebox)
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any controller)

    Constructor * @controller The ColdBox controller * * @return EventHandler

    Parameters:
    controller
    Property Detail

    cachebox

    property any cachebox

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    controller

    property any controller

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    flash

    property any flash

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    logBox

    property any logBox

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    wirebox

    property any wirebox

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    _actionExists

    public boolean _actionExists(any action)

    Verifies if an action exists in the current event handler, public or private * @action The action to verify that it exists and it is a function

    Parameters:
    action

    _actionMetadata

    public struct _actionMetadata(any action)

    Return action metadata in the current event handler, public or private * @action The action to get the metadata from

    Parameters:
    action

    _privateInvoker

    public any _privateInvoker(any method, any argCollection)

    _privateInvoker for private events * @method The method to execute * @argCollection The arguments to execute the method with.

    Parameters:
    method
    argCollection

    getCachebox

    public string getCachebox()

    getFlash

    public string getFlash()

    getLog

    public string getLog()

    getLogBox

    public string getLogBox()

    getWirebox

    public string getWirebox()

    setCachebox

    public any setCachebox(any cachebox)

    Parameters:
    cachebox

    setFlash

    public any setFlash(any flash)

    Parameters:
    flash

    setLog

    public any setLog(any log)

    Parameters:
    log

    setLogBox

    public any setLogBox(any logBox)

    Parameters:
    logBox

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox