|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.mvc.Controller
public class Controller
******************************************************************************* 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.
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()
|
void |
SETAPPHASH(string appHash)
|
void |
SETAPPKEY(string appKey)
|
void |
SETAPPROOTPATH(string appRootPath)
|
void |
SETCACHEBOX(any cacheBox)
|
void |
SETCOLDBOXINITIATED(boolean coldboxInitiated)
set: *********************************** APPLICATION PROPERTIES ******************************************** |
void |
SETCONFIGLOCATION(string configLocation)
|
void |
SETCONFIGLOCATIONOVERRIDE(boolean configLocationOverride)
|
void |
SETCONFIGSETTINGS(struct configSettings)
|
void |
SETDATAMARSHALLER(any dataMarshaller)
|
void |
SETLOGBOX(any logBox)
|
void |
SETUTIL(any util)
|
void |
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 |
---|
|
Constructor Detail |
---|
public init(any appRootPath, any appKey)
appRootPath
appKey
Method Detail |
---|
public string GETAPPHASH()
public string GETAPPKEY()
public string GETAPPROOTPATH()
public any GETCACHEBOX()
public boolean GETCOLDBOXINITIATED()
public struct GETCOLDBOXSETTINGS()
public string GETCONFIGLOCATION()
public boolean GETCONFIGLOCATIONOVERRIDE()
public struct GETCONFIGSETTINGS()
public any GETDATAMARSHALLER()
public any GETLOGBOX()
public any GETUTIL()
public any GETWIREBOX()
public void SETAPPHASH(string appHash)
appHash
public void SETAPPKEY(string appKey)
appKey
public void SETAPPROOTPATH(string appRootPath)
appRootPath
public void SETCACHEBOX(any cacheBox)
cacheBox
public void SETCOLDBOXINITIATED(boolean coldboxInitiated)
coldboxInitiated
public void SETCONFIGLOCATION(string configLocation)
configLocation
public void SETCONFIGLOCATIONOVERRIDE(boolean configLocationOverride)
configLocationOverride
public void SETCONFIGSETTINGS(struct configSettings)
configSettings
public void SETDATAMARSHALLER(any dataMarshaller)
dataMarshaller
public void SETLOGBOX(any logBox)
logBox
public void SETUTIL(any util)
util
public void SETWIREBOX(any wireBox)
wireBox
private RequestContext createContext()
public any defaultEventCheck(any event)
event
public RequestContext getContext()
public any getHandler(any ehBean, any requestContext)
ehBean
requestContext
private any getHandlerListing(any directory)
directory
public any getInterceptorService()
public any getRegisteredHandler(any event)
event
public any getRenderer()
public any getSetting(any name, [boolean FWSetting='false'], [any defaultValue])
name
FWSetting
defaultValue
public struct getSettingStructure([boolean FWSetting='false'], [boolean deepCopyFlag='false'])
FWSetting
deepCopyFlag
private any invalidEvent(any event, any ehBean)
event
ehBean
private any isViewDispatch(any event, any ehBean)
event
ehBean
public any loadApplication([any overrideConfigFile=''], [any overrideAppMapping=''])
overrideConfigFile
overrideAppMapping
public any newHandler(any invocationPath)
invocationPath
public any processShutdown()
public any registerHandlers()
public any removeContext()
public RequestContext requestCapture()
public any runEvent([any event=''], [boolean prePostExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArguments='[runtime expression]'])
event
prePostExempt
private
defaultEvent
eventArguments
private any sendRelocation(any url, [boolean addToken='false'], [numeric statusCode='0'])
url
addToken
statusCode
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'])
event
queryString
addToken
ssl
baseURL
postProcessExempt
URL
URI
statusCode
public any setSetting(any name, any value)
name
value
public any settingExists(any name, [boolean FWSetting='false'])
name
FWSetting
private any updateSSL(any inURL, any ssl)
inURL
ssl
private any validateAction(any action, [any inclusion=''], [any exclusion=''])
action
inclusion
exclusion
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |