|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.web.Controller
public class Controller
This is the ColdBox Front Controller that dispatches events and manages your ColdBox application.
Constructor Summary | |
---|---|
init(any appRootPath, any appKey)
Constructor |
Method Summary | |
---|---|
any |
getAppHash()
Get AppHash |
any |
getAppKey()
Get this application's key in memory space (application scope) |
any |
getAppRootPath()
Get this application's physical path |
any<boolean> |
getAspectsInitiated()
Get AspectsInitiated |
any |
getCFMLEngine()
Get the CFMLEngine utility(coldbox |
any<CacheFactory> |
getCacheBox()
Get the application's CacheBox instance as coldbox |
any |
getColdboxInitiated()
Get ColdboxInitiated: Boolean |
any<IColdboxApplicationCache> |
getColdboxOCM([any cacheName='default'])
Get ColdboxOCM: coldbox |
any<struct> |
getColdboxSettings()
I retrieve the ColdBox Settings Structure by Reference |
any<struct> |
getConfigSettings()
I retrieve the Config Settings Structure by Reference |
any |
getDebuggerService()
Get DebuggerService: coldbox |
any |
getExceptionService()
Get ExceptionService: coldbox |
any |
getHandlerService()
Get HandlerService: coldbox |
any |
getInterceptorService()
Get interceptorService: coldbox |
any |
getLoaderService()
Get LoaderService: coldbox |
any<coldbox.system.logging.LogBox> |
getLogBox()
Get the application's LogBox instance |
any |
getMemento()
Get the controller's internal state |
any |
getModuleService()
Get ModuleService: coldbox |
any |
getPlugin(any plugin, [any customPlugin='false'], [any newInstance='false'], [any module=''], [any init='true'])
I am the Plugin cfc object factory |
any |
getPluginService()
Get PluginService: coldbox |
any |
getRequestService()
Get RequestService: coldbox |
any<coldbox.system.web.coldbox> |
getServices()
Get all the registered services structure |
any |
getSetting([any name], [any FWSetting='false'], [any defaultValue])
I get a setting from the FW Config structures |
any<struct> |
getSettingStructure([any FWSetting='false'], [any deepCopyFlag='false'])
Compatability & Utility Method |
private any<coldbox.system.core.util.Util> |
getUtil()
Create and return a util object |
any |
getValidationManager()
Get the validation manager for the application |
any<coldbox.system.logging.LogBox> |
getWireBox()
Get the application's LogBox instance |
private any |
invoker(any target, any method, [any argCollection='[runtime expression]'], [any private='false'])
Method Invoker |
any |
persistVariables([any persist=''], [any<struct> persistStruct])
@deprecated DO NOT USE ANYMORE |
private any |
pushTimers()
Push timers into stack |
any |
runEvent([any event=''], [any<boolean> prepostExempt='false'], [any<boolean> private='false'], [any<boolean> default='false'], [any<struct> eventArguments='[runtime expression]'])
I am an event handler runnable factory |
private any |
sendRelocation(any url, [any<boolean> addtoken='false'], [any<numeric> statusCode='0'])
Send a CF relocation via ColdBox |
any |
setAppHash(any appHash)
Set AppHash |
any |
setAppRootPath(any appRootPath)
Set this application's physical path |
any |
setAspectsInitiated(any aspectsInitiated)
Set AspectsInitiated |
any |
setCacheBox(any<CacheFactory> cacheBox)
Set the application's CacheBox instance |
any |
setColdboxInitiated(any coldboxInitiated)
Set ColdboxInitiated |
any |
setColdboxOCM(any coldboxOCM)
Set ColdboxOCM |
any |
setColdboxSettings(any<struct> coldboxSettings)
Set ColdboxSettings |
any |
setConfigSettings(any<struct> configSettings)
Set ConfigSettings |
any |
setDebuggerService(any debuggerService)
Set DebuggerService |
any |
setHandlerService(any handlerService)
Set HandlerService |
any |
setInterceptorService(any interceptorService)
Set interceptorService |
any |
setLoaderService(any loaderService)
Set LoaderService |
any |
setLog(any logger)
Set the class logger object |
any |
setLogBox(any<coldbox.system.logging.LogBox> logBox)
Set the logBox instance |
any |
setModuleService(any moduleService)
Set ModuleService |
any |
setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct persistStruct='[runtime expression]'], [boolean ssl], [string baseURL=''], [boolean postProcessExempt='false'], [string URL], [string URI], [numeric statusCode='0'])
I Set the next event to run and relocate the browser to that event |
any |
setPluginService(Any pluginService)
Set PluginService |
any |
setRequestService(any requestService)
Set RequestService |
any |
setSetting([any name], [any value])
I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided |
any |
setValidationManager(any validationManager)
Store the validation manager for the application |
any |
setWireBox(any<coldbox.system.ioc.Injector> wireBox)
Set the WireBox instance |
any<boolean> |
settingExists(any name, [any FWSetting='false'])
I Check if a value exists in the configstruct or the fwsettingsStruct |
private any |
updateSSL(any inURL, any ssl)
Update SSL or not on a request string |
private any |
validateAction(any action='', [any inclusion=''], [any exclusion=''])
Checks if an action can be executed according to inclusion/exclusion lists |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any appRootPath, any appKey)
appRootPath
- The application root pathappKey
- The application registered application keyMethod Detail |
---|
public any getAppHash()
public any getAppKey()
public any getAppRootPath()
public any<boolean> getAspectsInitiated()
public any getCFMLEngine()
public any<CacheFactory> getCacheBox()
public any getColdboxInitiated()
public any<IColdboxApplicationCache> getColdboxOCM([any cacheName='default'])
cacheName
- The cache name to retrievepublic any<struct> getColdboxSettings()
public any<struct> getConfigSettings()
public any getDebuggerService()
public any getExceptionService()
public any getHandlerService()
public any getInterceptorService()
public any getLoaderService()
public any<coldbox.system.logging.LogBox> getLogBox()
public any getMemento()
public any getModuleService()
Public any getPlugin(any plugin, [any customPlugin='false'], [any newInstance='false'], [any module=''], [any init='true'])
plugin
- The Plugin object's name to instantiatecustomPlugin
- Used internally to create custom plugins. BooleannewInstance
- If true, it will create and return a new plugin. No caching or persistance.module
- The module to retrieve the plugin frominit
- Auto init() the plugin upon construction, Booleanpublic any getPluginService()
public any getRequestService()
public any<coldbox.system.web.coldbox> getServices()
public any getSetting([any name], [any FWSetting='false'], [any defaultValue])
name
- Name of the setting key to retrieveFWSetting
- Boolean Flag. If true, it will retrieve from the fwSettingsStruct else from the configStruct. Default is false.defaultValue
- Default value to return if not found.public any<struct> getSettingStructure([any FWSetting='false'], [any deepCopyFlag='false'])
FWSetting
- Boolean Flag. If true, it will retrieve from the fwSettingsStruct else the configStruct. Default is false.deepCopyFlag
- Default is false. True, creates a deep copy of the structure.private any<coldbox.system.core.util.Util> getUtil()
public any getValidationManager()
public any<coldbox.system.logging.LogBox> getWireBox()
private any invoker(any target, any method, [any argCollection='[runtime expression]'], [any private='false'])
target
- method
- argCollection
- The argument collection to passprivate
- Private method or not? Booleanpublic any persistVariables([any persist=''], [any<struct> persistStruct])
persist
- What request collection keys to persist in the relocation. Keys must exist in the relocationpersistStruct
- A structure of key-value pairs to persist.private any pushTimers()
Public any runEvent([any event=''], [any<boolean> prepostExempt='false'], [any<boolean> private='false'], [any<boolean> default='false'], [any<struct> eventArguments='[runtime expression]'])
event
- The event to run as a string. If no current event is set, use the default event from the config.xml. This is a stringprepostExempt
- If true, pre/post handlers will not be fired. Booleanprivate
- Execute a private event or not, default is false. Booleandefault
- The flag that let's this service now if it is the default set event running or not. USED BY THE FRAMEWORK ONLY. BooleaneventArguments
- A collection of arguments to passthrough to the calling event handler method. Structprivate any sendRelocation(any url, [any<boolean> addtoken='false'], [any<numeric> statusCode='0'])
url
- The URL to relocate toaddtoken
- Add the CF tokens or notstatusCode
- The status code to usepublic any setAppHash(any appHash)
appHash
public any setAppRootPath(any appRootPath)
appRootPath
public any setAspectsInitiated(any aspectsInitiated)
aspectsInitiated
public any setCacheBox(any<CacheFactory> cacheBox)
cacheBox
- As coldbox.system.cache.CacheFactorypublic any setColdboxInitiated(any coldboxInitiated)
coldboxInitiated
public any setColdboxOCM(any coldboxOCM)
coldboxOCM
- coldbox.system.cache.CacheManagerpublic any setColdboxSettings(any<struct> coldboxSettings)
coldboxSettings
public any setConfigSettings(any<struct> configSettings)
configSettings
public any setDebuggerService(any debuggerService)
debuggerService
public any setHandlerService(any handlerService)
handlerService
public any setInterceptorService(any interceptorService)
interceptorService
public any setLoaderService(any loaderService)
loaderService
public any setLog(any logger)
logger
public any setLogBox(any<coldbox.system.logging.LogBox> logBox)
logBox
- The logBox instancepublic any setModuleService(any moduleService)
moduleService
public any setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct persistStruct='[runtime expression]'], [boolean ssl], [string baseURL=''], [boolean postProcessExempt='false'], [string URL], [string URI], [numeric statusCode='0'])
event
- The name of the event to run, if not passed, then it will use the default event found in your configuration file.queryString
- The query string to append, if needed. If in SES mode it will be translated to convention name value pairsaddToken
- Wether to add the tokens or not. Default is falsepersist
- What request collection keys to persist in flash rampersistStruct
- A structure key-value pairs to persist in flash ram.ssl
- Whether to relocate in SSL or not. You need to explicitly say TRUE or FALSE if going out from SSL. If none passed, we look at the even's SES base URL (if in SES mode)baseURL
- Use this baseURL instead of the index.cfm that is used by default. You can use this for ssl or any full base url you would like to use. Ex: https://mysite.com/index.cfmpostProcessExempt
- Do not fire the postProcess interceptorsURL
- The full URL you would like to relocate to instead of an event: ex: URL='http://www.google.com'URI
- The relative URI you would like to relocate to instead of an event: ex: URI='/mypath/awesome/here'statusCode
- The status code to use in the relocationpublic any setPluginService(Any pluginService)
pluginService
public any setRequestService(any requestService)
requestService
public any setSetting([any name], [any value])
name
- The name of the settingvalue
- The value of the setting (Can be simple or complex)public any setValidationManager(any validationManager)
validationManager
public any setWireBox(any<coldbox.system.ioc.Injector> wireBox)
wireBox
- The WireBox instancepublic any<boolean> settingExists(any name, [any FWSetting='false'])
name
- Name of the setting to find.FWSetting
- Boolean Flag. If true, it will retrieve from the fwSettingsStruct else from the configStruct. Default is false.private any updateSSL(any inURL, any ssl)
inURL
ssl
private any validateAction(any action='', [any inclusion=''], [any exclusion=''])
action
- The action to checkinclusion
- inclusion listexclusion
- exclusion list
|
ColdBox Platform v3.8.0 | ||||
FRAMES |