|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.frameworkSupertype
public class frameworkSupertype
This is the layer supertype cfc.
Method Summary | |
---|---|
private void |
abort()
Facade for cfabort |
private void |
announceInterception(string state, [struct interceptData='[runtime expression]'])
Announce an interception to the system. |
private void |
dump(any var, [boolean isAbort='false'])
Facade for cfmx dump |
private any |
getColdboxOCM()
Get ColdboxOCM: coldbox.system.cache.CacheManager |
private datasourceBean |
getDatasource([string alias])
I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct |
private boolean |
getDebugMode()
Facade to get your current debug mode |
string |
getHash()
Get the instance's unique UUID |
any |
getInstance()
Get the instance of this object |
private any |
getInterceptor(string interceptorClass)
Get an interceptor |
private mailsettingsBean |
getMailSettings()
I will return to you a mailsettingsBean modeled after your mail settings in your config file. |
any |
getModel(string name, [boolean useSetterInjection], [string onDICompleteUDF], [boolean debugMode], [string stopRecursion])
Create or retrieve model objects by convention |
private any |
getMyPlugin(any plugin, [boolean newInstance='false'])
Facade |
private any |
getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
Facade |
private any |
getResource([any resource])
Facade to i18n.getResource. Returns a string. |
private any |
getSetting(string name, [boolean FWSetting='false'])
Facade |
private struct |
getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
Facade |
private configBean |
getSettingsBean()
Returns a configBean with all the configuration structure. |
private any |
getcontroller()
Get controller: coldbox.system.controller |
any |
getfwLocale()
Get the default locale string used in the framework. Returns a string |
private void |
htmlhead(string content)
Facade to cfhtmlhead |
private void |
include([string template])
Facade for cfinclude |
private void |
includeUDF(string udflibrary)
Injects a UDF Library (*.cfc or *.udf). |
private string |
locateDirectoryPath(string pathToCheck)
Locate the real path location of a directory in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path |
private string |
locateFilePath(string pathToCheck)
Locate the real path location of a file in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path |
private void |
persistVariables([string persist=''], [struct varStruct])
Persist variables for flash redirections |
private Any |
populateModel(any model, [string scope=''], [boolean trustedSetter='false'])
Populate a named or instantiated model (java/cfc) from the request collection items |
private void |
relocate(string url, [boolean addtoken='false'])
Facade for cflocation |
private Any |
renderExternalView(string view)
Facade to plugins' render external view. |
private Any |
renderView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
Facade to plugin's render view. |
private void |
rethrowit(any throwObject)
Rethrow facade |
private any |
runEvent([string event=''], [boolean prepostExempt='false'], [boolean private='false'])
Facade to controller's runEvent() method. |
private void |
setDebugMode(boolean mode)
Facade to set your debug mode |
private void |
setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct varStruct='[runtime expression]'], [boolean ssl='false'])
Facade |
private 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 |
private void |
setSetting(string name, any value)
Facade |
private void |
setcontroller(any controller)
Set controller |
private boolean |
settingExists(string name, [boolean FWSetting='false'])
Facade |
private any |
throw(string message, [string detail=''], [string type='Framework'])
Facade for cfthrow |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Method Detail |
---|
private void abort()
private void announceInterception(string state, [struct interceptData='[runtime expression]'])
state
- The interception state to executeinterceptData
- A data structure used to pass intercepted information.private void dump(any var, [boolean isAbort='false'])
var
isAbort
- Abort alsoprivate any getColdboxOCM()
private datasourceBean getDatasource([string alias])
alias
- The alias of the datasource to get from the configstruct (alias property in the config file)private boolean getDebugMode()
public string getHash()
public any getInstance()
private any getInterceptor(string interceptorClass)
interceptorClass
- The qualified class of the itnerceptor to retrieveprivate mailsettingsBean getMailSettings()
public any getModel(string name, [boolean useSetterInjection], [string onDICompleteUDF], [boolean debugMode], [string stopRecursion])
name
- The name of the model to retrieveuseSetterInjection
- Whether to use setter injection alongside the annotations property injection. cfproperty injection takes precedence.onDICompleteUDF
- After Dependencies are injected, this method will look for this UDF and call it if it exists. The default value is onDICompletedebugMode
- Debugging Mode or notstopRecursion
- A comma-delimmited list of stoprecursion classpaths.private any getMyPlugin(any plugin, [boolean newInstance='false'])
plugin
- The plugin name as a stringnewInstance
private any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
plugin
- The Plugin object's name to instantiate, as a stringcustomPlugin
newInstance
private any getResource([any resource])
resource
- The resource to retrieve from the bundle.private any getSetting(string name, [boolean FWSetting='false'])
name
FWSetting
private struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
FWSetting
DeepCopyFlag
private configBean getSettingsBean()
private any getcontroller()
public any getfwLocale()
private void htmlhead(string content)
content
- The content to send to the headprivate void include([string template])
template
private void includeUDF(string udflibrary)
udflibrary
- The UDF library to inject.private string locateDirectoryPath(string pathToCheck)
pathToCheck
- The path to checkprivate string locateFilePath(string pathToCheck)
pathToCheck
- The path to checkprivate void persistVariables([string persist=''], [struct varStruct])
persist
- What request collection keys to persist in the relocationvarStruct
- A structure key-value pairs to persist.private Any populateModel(any model, [string scope=''], [boolean trustedSetter='false'])
model
- The name of the model to get and populate or the acutal model object. If you already have an instance of a model, then use the populateBean() methodscope
- Use scope injection instead of setters population. Ex: scope=variables.instance.trustedSetter
- If set to true, the setter method will be called even if it does not exist in the beanprivate void relocate(string url, [boolean addtoken='false'])
url
addtoken
private Any renderExternalView(string view)
view
private Any renderView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
view
cache
- True if you want to cache the view.cacheTimeout
- The cache timeoutcacheLastAccessTimeout
- The last access timeoutprivate void rethrowit(any throwObject)
throwObject
- The cfcatch objectprivate any runEvent([string event=''], [boolean prepostExempt='false'], [boolean private='false'])
event
prepostExempt
- If true, pre/post handlers will not be fired.private
- Execute a private event or not, default is falseprivate void setDebugMode(boolean mode)
mode
private void setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct varStruct='[runtime expression]'], [boolean ssl='false'])
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 falsepersist
- What request collection keys to persist in the relocationvarStruct
- A structure key-value pairs to persist.ssl
- Whether to relocate in SSL or not, only used when in SES mode.private void setNextRoute(string route, [string persist=''], [struct varStruct], [boolean addToken='false'], [boolean ssl='false'])
route
- The route to relocate to, do not prepend the baseURL or /.persist
- What request collection keys to persist in the relocationvarStruct
- A structure key-value pairs to persist.addToken
- Wether to add the tokens or not. Default is falsessl
- Whether to relocate in SSL or notprivate void setSetting(string name, any value)
name
value
private void setcontroller(any controller)
controller
- coldbox.system.controllerprivate boolean settingExists(string name, [boolean FWSetting='false'])
name
FWSetting
private any throw(string message, [string detail=''], [string type='Framework'])
message
detail
type
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |