ColdBox Platform Version 2.6.3

coldbox.system
Class controller

WEB-INF.cftags.component
        extended by coldbox.system.controller
Direct Known Subclasses:
testcontroller

public class controller
extends WEB-INF.cftags.component

This is the ColdBox Front Controller.


Constructor Summary
init(string AppRootPath)
          I am the constructor
 
Method Summary
 string getAppHash()
          Get AppHash
 string getAppRootPath()
          Get this application's physical path
 boolean getAppStartHandlerFired()
          Get AppStartHandlerFired
 boolean getAspectsInitiated()
          Get AspectsInitiated
 boolean getColdboxInitiated()
          Get ColdboxInitiated
 any getColdboxOCM()
          Get ColdboxOCM: coldbox.system.cache.CacheManager
 struct getColdboxSettings()
          I retrieve the ColdBox Settings Structure by Reference
 struct getConfigSettings()
          I retrieve the Config Settings Structure by Reference
 any getDebuggerService()
          Get DebuggerService: coldbox.system.services.DebuggerService
 any getExceptionService()
          Get ExceptionService: coldbox.system.services.ExceptionService
 any getHandlerService()
          Get HandlerService: coldbox.system.services.HandlerService
 any getLoaderService()
          Get LoaderService: coldbox.system.services.LoaderService
 any getPlugin([string plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
          I am the Plugin cfc object factory.
 any getPluginService()
          Get PluginService: coldbox.system.services.PluginService
 any getRequestService()
          Get RequestService: coldbox.system.services.RequestService
 any getService(string service)
          DEPRECATED: Internal ColdBox Transient Minimalistic Service Locator.
 any getSetting([string name], [boolean FWSetting='false'])
          I get a setting from the FW Config structures. Use the FWSetting boolean argument to retrieve from the fwSettingsStruct.
 struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
          Compatability & Utility Method. By default I retrieve the Config Settings. You can change this by using the FWSetting flag.
private Util getUtil()
          Create and return a util object
 any getinterceptorService()
          Get interceptorService: coldbox.system.services.InterceptorService
 void persistVariables([string persist=''], [struct varStruct])
          Persist variables for flash redirections, it can use a structure of name-value pairs or keys from the request collection
private void pushTimers()
          Push timers into stack
 any runEvent([any event=''], [boolean prepostExempt='false'], [boolean private='false'], [boolean default='false'])
          I am an event handler runnable factory. If no event is passed in then it will run the default event from the config file.
 void setAppHash(string AppHash)
          Set AppHash
 void setAppRootPath(string AppRootPath)
          Set this application's physical path.
 void setAppStartHandlerFired(boolean AppStartHandlerFired)
          Set AppStartHandlerFired
 void setAspectsInitiated(boolean AspectsInitiated)
          Set AspectsInitiated
 void setColdboxInitiated(boolean ColdboxInitiated)
          Set ColdboxInitiated
 void setColdboxOCM(any ColdboxOCM)
          Set ColdboxOCM
 void setColdboxSettings(struct ColdboxSettings)
          Set ColdboxSettings
 void setConfigSettings(struct ConfigSettings)
          Set ConfigSettings
 void setDebuggerService(any DebuggerService)
          Set DebuggerService
 void setHandlerService(any HandlerService)
          Set HandlerService
 void setLoaderService(any LoaderService)
          Set LoaderService
 void setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct varStruct='[runtime expression]'], [boolean ssl='false'], [string baseURL=''])
          I Set the next event to run and relocate the browser to that event. If you are in SES mode, this method will use routing instead
 void setNextRoute(string route, [string persist=''], [struct varStruct], [boolean addToken='false'], [boolean ssl='false'])
          I Set the next ses route to relocate to. This method pre-pends the baseURL
 void setPluginService(Any PluginService)
          Set PluginService
 void setRequestService(any RequestService)
          Set RequestService
 void setSetting([string name], [any value])
          I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided. This only sets in the ConfigStruct
 void setinterceptorService(any interceptorService)
          Set interceptorService
 boolean settingExists([string name], [boolean FWSetting='false'])
          I Check if a value exists in the configstruct or the fwsettingsStruct.
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

Public init(string AppRootPath)

Method Detail

getAppHash

public string getAppHash()
Get AppHash


getAppRootPath

public string getAppRootPath()
Get this application's physical path


getAppStartHandlerFired

public boolean getAppStartHandlerFired()
Get AppStartHandlerFired


getAspectsInitiated

public boolean getAspectsInitiated()
Get AspectsInitiated


getColdboxInitiated

public boolean getColdboxInitiated()
Get ColdboxInitiated


getColdboxOCM

public any getColdboxOCM()
Get ColdboxOCM: coldbox.system.cache.CacheManager


getColdboxSettings

public struct getColdboxSettings()
I retrieve the ColdBox Settings Structure by Reference


getConfigSettings

public struct getConfigSettings()
I retrieve the Config Settings Structure by Reference


getDebuggerService

public any getDebuggerService()
Get DebuggerService: coldbox.system.services.DebuggerService


getExceptionService

public any getExceptionService()
Get ExceptionService: coldbox.system.services.ExceptionService


getHandlerService

public any getHandlerService()
Get HandlerService: coldbox.system.services.HandlerService


getLoaderService

public any getLoaderService()
Get LoaderService: coldbox.system.services.LoaderService


getPlugin

Public any getPlugin([string plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
I am the Plugin cfc object factory.

Parameters:
plugin - The Plugin object's name to instantiate
customPlugin - Used internally to create custom plugins.
newInstance - If true, it will create and return a new plugin. No caching or persistance.

getPluginService

public any getPluginService()
Get PluginService: coldbox.system.services.PluginService


getRequestService

public any getRequestService()
Get RequestService: coldbox.system.services.RequestService


getService

public any getService(string service)
DEPRECATED: Internal ColdBox Transient Minimalistic Service Locator.

Parameters:
service - The transient service/manager to create.

getSetting

public any getSetting([string name], [boolean FWSetting='false'])
I get a setting from the FW Config structures. Use the FWSetting boolean argument to retrieve from the fwSettingsStruct.

Parameters:
name - Name of the setting key to retrieve
FWSetting - Boolean Flag. If true, it will retrieve from the fwSettingsStruct else from the configStruct. Default is false.

getSettingStructure

public struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
Compatability & Utility Method. By default I retrieve the Config Settings. You can change this by using the FWSetting flag.

Parameters:
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.

getUtil

private Util getUtil()
Create and return a util object


getinterceptorService

public any getinterceptorService()
Get interceptorService: coldbox.system.services.InterceptorService


persistVariables

public void persistVariables([string persist=''], [struct varStruct])
Persist variables for flash redirections, it can use a structure of name-value pairs or keys from the request collection

Parameters:
persist - What request collection keys to persist in the relocation. Keys must exist in the relocation
varStruct - A structure of key-value pairs to persist.

pushTimers

private void pushTimers()
Push timers into stack


runEvent

Public any runEvent([any event=''], [boolean prepostExempt='false'], [boolean private='false'], [boolean default='false'])
I am an event handler runnable factory. If no event is passed in then it will run the default event from the config file.

Parameters:
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 string
prepostExempt - If true, pre/post handlers will not be fired.
private - Execute a private event or not, default is false
default - The flag that let's this service now if it is the default set event running or not. USED BY THE FRAMEWORK ONLY

setAppHash

public void setAppHash(string AppHash)
Set AppHash

Parameters:
AppHash

setAppRootPath

public void setAppRootPath(string AppRootPath)
Set this application's physical path.

Parameters:
AppRootPath

setAppStartHandlerFired

public void setAppStartHandlerFired(boolean AppStartHandlerFired)
Set AppStartHandlerFired

Parameters:
AppStartHandlerFired

setAspectsInitiated

public void setAspectsInitiated(boolean AspectsInitiated)
Set AspectsInitiated

Parameters:
AspectsInitiated

setColdboxInitiated

public void setColdboxInitiated(boolean ColdboxInitiated)
Set ColdboxInitiated

Parameters:
ColdboxInitiated

setColdboxOCM

public void setColdboxOCM(any ColdboxOCM)
Set ColdboxOCM

Parameters:
ColdboxOCM - coldbox.system.cache.CacheManager

setColdboxSettings

public void setColdboxSettings(struct ColdboxSettings)
Set ColdboxSettings

Parameters:
ColdboxSettings

setConfigSettings

public void setConfigSettings(struct ConfigSettings)
Set ConfigSettings

Parameters:
ConfigSettings

setDebuggerService

public void setDebuggerService(any DebuggerService)
Set DebuggerService

Parameters:
DebuggerService

setHandlerService

public void setHandlerService(any HandlerService)
Set HandlerService

Parameters:
HandlerService

setLoaderService

public void setLoaderService(any LoaderService)
Set LoaderService

Parameters:
LoaderService

setNextEvent

Public void setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct varStruct='[runtime expression]'], [boolean ssl='false'], [string baseURL=''])
I Set the next event to run and relocate the browser to that event. If you are in SES mode, this method will use routing instead

Parameters:
event - The name of the event to run.
queryString - The query string to append, if needed.
addToken - Whether to add the tokens or not. Default is false
persist - What request collection keys to persist in the relocation
varStruct - A structure key-value pairs to persist.
ssl - Whether to relocate in SSL or not, only used when 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.cfm

setNextRoute

Public void setNextRoute(string route, [string persist=''], [struct varStruct], [boolean addToken='false'], [boolean ssl='false'])
I Set the next ses route to relocate to. This method pre-pends the baseURL

Parameters:
route - The route to relocate to, do not prepend the baseURL or /.
persist - What request collection keys to persist in the relocation
varStruct - A structure key-value pairs to persist.
addToken - Wether to add the tokens or not. Default is false
ssl - Whether to relocate in SSL or not

setPluginService

public void setPluginService(Any PluginService)
Set PluginService

Parameters:
PluginService

setRequestService

public void setRequestService(any RequestService)
Set RequestService

Parameters:
RequestService

setSetting

Public void setSetting([string name], [any value])
I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided. This only sets in the ConfigStruct

Parameters:
name - The name of the setting
value - The value of the setting (Can be simple or complex)

setinterceptorService

public void setinterceptorService(any interceptorService)
Set interceptorService

Parameters:
interceptorService

settingExists

Public boolean settingExists([string name], [boolean FWSetting='false'])
I Check if a value exists in the configstruct or the fwsettingsStruct.

Parameters:
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.

ColdBox Platform Version 2.6.3