coldbox.system.mvc

Class Controller

WEB-INF.cftags.component
        extended by coldbox.system.mvc.Controller
Class Attributes:
  • accessors : true
    •  
  • serializable : false
    •  

    ******************************************************************************* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Author : Luis Majano Description : This is the ColdBox Front Controller that dispatches events and manages your ColdBox application. Only one instance of a specific ColdBox application exists.

    Property Summary
    type property default serializable required
    string appHash


    		true false
    string appKey


    		true false
    string appRootPath


    		true false
    any cacheBox


    		true false
    boolean coldboxInitiated
          *********************************** APPLICATION PROPERTIES ********************************************.

    		true false
    struct coldboxSettings


    • setter = false
    		 true false
    string configLocation


    		true false
    boolean configLocationOverride


    		true false
    struct configSettings


    		true false
    any dataMarshaller


    		true false
    any logBox


    		true false
    any util


    		true false
    any wireBox


    		true false
    Constructor Summary
    init(any appRootPath, any appKey)
          *********************************** CONSTRUCTOR ********************************************.
    Method Summary
    string GETAPPHASH()
    string GETAPPKEY()
    string GETAPPROOTPATH()
    any GETCACHEBOX()
    boolean GETCOLDBOXINITIATED()
         get: *********************************** APPLICATION PROPERTIES ********************************************.
    struct GETCOLDBOXSETTINGS()
    string GETCONFIGLOCATION()
    boolean GETCONFIGLOCATIONOVERRIDE()
    struct GETCONFIGSETTINGS()
    any GETDATAMARSHALLER()
    any GETLOGBOX()
    any GETUTIL()
    any GETWIREBOX()
    Controller SETAPPHASH(string appHash)
    Controller SETAPPKEY(string appKey)
    Controller SETAPPROOTPATH(string appRootPath)
    Controller SETCACHEBOX(any cacheBox)
    Controller SETCOLDBOXINITIATED(boolean coldboxInitiated)
         set: *********************************** APPLICATION PROPERTIES ********************************************.
    Controller SETCONFIGLOCATION(string configLocation)
    Controller SETCONFIGLOCATIONOVERRIDE(boolean configLocationOverride)
    Controller SETCONFIGSETTINGS(struct configSettings)
    Controller SETDATAMARSHALLER(any dataMarshaller)
    Controller SETLOGBOX(any logBox)
    Controller SETUTIL(any util)
    Controller SETWIREBOX(any wireBox)
    private RequestContext createContext()
    any defaultEventCheck(any event)
    RequestContext getContext()
    any getHandler(any ehBean, any requestContext)
    private any getHandlerListing(any directory)
    any getInterceptorService()
    any getRegisteredHandler(any event)
    any getRenderer()
    any getSetting(any name, [boolean FWSetting='false'], [any defaultValue])
    struct getSettingStructure([boolean FWSetting='false'], [boolean deepCopyFlag='false'])
         *********************************** APP SETTING METHODS ********************************************.
    private any invalidEvent(any event, any ehBean)
    private any isViewDispatch(any event, any ehBean)
    any loadApplication([any overrideConfigFile=''], [any overrideAppMapping=''])
    any newHandler(any invocationPath)
    any processShutdown()
         *********************************** DESTRUCTOR ********************************************.
    any registerHandlers()
         *********************************** HANDLER METHODS ********************************************.
    any removeContext()
    RequestContext requestCapture()
         *********************************** REQUEST METHODS ********************************************.
    any runEvent([any event=''], [boolean prePostExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArguments='[runtime expression]'])
         *********************************** EXECUTIONS ********************************************.
    private any sendRelocation(any url, [boolean addToken='false'], [numeric statusCode='0'])
    any setNextEvent([any event='[runtime expression]'], [any queryString=''], [boolean addToken='false'], [boolean ssl], [any baseURL=''], [boolean postProcessExempt='false'], [any URL], [any URI], [numeric statusCode='0'])
         *********************************** RELOCATIONS ********************************************.
    any setSetting(any name, any value)
    any settingExists(any name, [boolean FWSetting='false'])
    private any updateSSL(any inURL, any ssl)
    private any validateAction(any action, [any inclusion=''], [any exclusion=''])
         *********************************** PRIVATE UTIL ********************************************.
     
    Methods inherited from class WEB-INF.cftags.component
    None
    Constructor Detail

    init

    public init(any appRootPath, any appKey)

    *********************************** CONSTRUCTOR ********************************************

    Parameters:
    appRootPath
    appKey
    Property Detail

    appHash

    property string appHash

    Attributes:
    serializable - true
    required - false

    appKey

    property string appKey

    Attributes:
    serializable - true
    required - false

    appRootPath

    property string appRootPath

    Attributes:
    serializable - true
    required - false

    cacheBox

    property any cacheBox

    Attributes:
    serializable - true
    required - false

    coldboxInitiated

    property boolean coldboxInitiated

    *********************************** APPLICATION PROPERTIES ********************************************

    Attributes:
    serializable - true
    required - false

    coldboxSettings

    property struct coldboxSettings

    Attributes:
    required - false
    serializable - true
    setter - false

    configLocation

    property string configLocation

    Attributes:
    serializable - true
    required - false

    configLocationOverride

    property boolean configLocationOverride

    Attributes:
    serializable - true
    required - false

    configSettings

    property struct configSettings

    Attributes:
    serializable - true
    required - false

    dataMarshaller

    property any dataMarshaller

    Attributes:
    serializable - true
    required - false

    logBox

    property any logBox

    Attributes:
    serializable - true
    required - false

    util

    property any util

    Attributes:
    serializable - true
    required - false

    wireBox

    property any wireBox

    Attributes:
    serializable - true
    required - false
    Method Detail

    GETAPPHASH

    public string GETAPPHASH()

    GETAPPKEY

    public string GETAPPKEY()

    GETAPPROOTPATH

    public string GETAPPROOTPATH()

    GETCACHEBOX

    public any GETCACHEBOX()

    GETCOLDBOXINITIATED

    public boolean GETCOLDBOXINITIATED()

    get: *********************************** APPLICATION PROPERTIES ********************************************

    GETCOLDBOXSETTINGS

    public struct GETCOLDBOXSETTINGS()

    GETCONFIGLOCATION

    public string GETCONFIGLOCATION()

    GETCONFIGLOCATIONOVERRIDE

    public boolean GETCONFIGLOCATIONOVERRIDE()

    GETCONFIGSETTINGS

    public struct GETCONFIGSETTINGS()

    GETDATAMARSHALLER

    public any GETDATAMARSHALLER()

    GETLOGBOX

    public any GETLOGBOX()

    GETUTIL

    public any GETUTIL()

    GETWIREBOX

    public any GETWIREBOX()

    SETAPPHASH

    public Controller SETAPPHASH(string appHash)

    Parameters:
    appHash

    SETAPPKEY

    public Controller SETAPPKEY(string appKey)

    Parameters:
    appKey

    SETAPPROOTPATH

    public Controller SETAPPROOTPATH(string appRootPath)

    Parameters:
    appRootPath

    SETCACHEBOX

    public Controller SETCACHEBOX(any cacheBox)

    Parameters:
    cacheBox

    SETCOLDBOXINITIATED

    public Controller SETCOLDBOXINITIATED(boolean coldboxInitiated)

    set: *********************************** APPLICATION PROPERTIES ********************************************

    Parameters:
    coldboxInitiated

    SETCONFIGLOCATION

    public Controller SETCONFIGLOCATION(string configLocation)

    Parameters:
    configLocation

    SETCONFIGLOCATIONOVERRIDE

    public Controller SETCONFIGLOCATIONOVERRIDE(boolean configLocationOverride)

    Parameters:
    configLocationOverride

    SETCONFIGSETTINGS

    public Controller SETCONFIGSETTINGS(struct configSettings)

    Parameters:
    configSettings

    SETDATAMARSHALLER

    public Controller SETDATAMARSHALLER(any dataMarshaller)

    Parameters:
    dataMarshaller

    SETLOGBOX

    public Controller SETLOGBOX(any logBox)

    Parameters:
    logBox

    SETUTIL

    public Controller SETUTIL(any util)

    Parameters:
    util

    SETWIREBOX

    public Controller SETWIREBOX(any wireBox)

    Parameters:
    wireBox

    createContext

    private RequestContext createContext()

    defaultEventCheck

    public any defaultEventCheck(any event)

    Parameters:
    event

    getContext

    public RequestContext getContext()

    getHandler

    public any getHandler(any ehBean, any requestContext)

    Parameters:
    ehBean
    requestContext

    getHandlerListing

    private any getHandlerListing(any directory)

    Parameters:
    directory

    getInterceptorService

    public any getInterceptorService()

    getRegisteredHandler

    public any getRegisteredHandler(any event)

    Parameters:
    event

    getRenderer

    public any getRenderer()

    getSetting

    public any getSetting(any name, [boolean FWSetting='false'], [any defaultValue])

    Parameters:
    name
    FWSetting
    defaultValue

    getSettingStructure

    public struct getSettingStructure([boolean FWSetting='false'], [boolean deepCopyFlag='false'])

    *********************************** APP SETTING METHODS ********************************************

    Parameters:
    FWSetting
    deepCopyFlag

    invalidEvent

    private any invalidEvent(any event, any ehBean)

    Parameters:
    event
    ehBean

    isViewDispatch

    private any isViewDispatch(any event, any ehBean)

    Parameters:
    event
    ehBean

    loadApplication

    public any loadApplication([any overrideConfigFile=''], [any overrideAppMapping=''])

    Parameters:
    overrideConfigFile
    overrideAppMapping

    newHandler

    public any newHandler(any invocationPath)

    Parameters:
    invocationPath

    processShutdown

    public any processShutdown()

    *********************************** DESTRUCTOR ********************************************

    registerHandlers

    public any registerHandlers()

    *********************************** HANDLER METHODS ********************************************

    removeContext

    public any removeContext()

    requestCapture

    public RequestContext requestCapture()

    *********************************** REQUEST METHODS ********************************************

    runEvent

    public any runEvent([any event=''], [boolean prePostExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArguments='[runtime expression]'])

    *********************************** EXECUTIONS ********************************************

    Parameters:
    event
    prePostExempt
    private
    defaultEvent
    eventArguments

    sendRelocation

    private any sendRelocation(any url, [boolean addToken='false'], [numeric statusCode='0'])

    Parameters:
    url
    addToken
    statusCode

    setNextEvent

    public any setNextEvent([any event='[runtime expression]'], [any queryString=''], [boolean addToken='false'], [boolean ssl], [any baseURL=''], [boolean postProcessExempt='false'], [any URL], [any URI], [numeric statusCode='0'])

    *********************************** RELOCATIONS ********************************************

    Parameters:
    event
    queryString
    addToken
    ssl
    baseURL
    postProcessExempt
    URL
    URI
    statusCode

    setSetting

    public any setSetting(any name, any value)

    Parameters:
    name
    value

    settingExists

    public any settingExists(any name, [boolean FWSetting='false'])

    Parameters:
    name
    FWSetting

    updateSSL

    private any updateSSL(any inURL, any ssl)

    Parameters:
    inURL
    ssl

    validateAction

    private any validateAction(any action, [any inclusion=''], [any exclusion=''])

    *********************************** PRIVATE UTIL ********************************************

    Parameters:
    action
    inclusion
    exclusion