ColdBox Platform Version 2.6.3

coldbox.system
Class frameworkSupertype

WEB-INF.cftags.component
        extended by coldbox.system.frameworkSupertype
Direct Known Subclasses:
eventhandler , interceptor , plugin

public class frameworkSupertype
extends WEB-INF.cftags.component

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

abort

private void abort()
Facade for cfabort


announceInterception

private void announceInterception(string state, [struct interceptData='[runtime expression]'])
Announce an interception to the system.

Parameters:
state - The interception state to execute
interceptData - A data structure used to pass intercepted information.

dump

private void dump(any var, [boolean isAbort='false'])
Facade for cfmx dump

Parameters:
var
isAbort - Abort also

getColdboxOCM

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


getDatasource

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

Parameters:
alias - The alias of the datasource to get from the configstruct (alias property in the config file)

getDebugMode

private boolean getDebugMode()
Facade to get your current debug mode


getHash

public string getHash()
Get the instance's unique UUID


getInstance

public any getInstance()
Get the instance of this object


getInterceptor

private any getInterceptor(string interceptorClass)
Get an interceptor

Parameters:
interceptorClass - The qualified class of the itnerceptor to retrieve

getMailSettings

private mailsettingsBean getMailSettings()
I will return to you a mailsettingsBean modeled after your mail settings in your config file.


getModel

public any getModel(string name, [boolean useSetterInjection], [string onDICompleteUDF], [boolean debugMode], [string stopRecursion])
Create or retrieve model objects by convention

Parameters:
name - The name of the model to retrieve
useSetterInjection - 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 onDIComplete
debugMode - Debugging Mode or not
stopRecursion - A comma-delimmited list of stoprecursion classpaths.

getMyPlugin

private any getMyPlugin(any plugin, [boolean newInstance='false'])
Facade

Parameters:
plugin - The plugin name as a string
newInstance

getPlugin

private any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
Facade

Parameters:
plugin - The Plugin object's name to instantiate, as a string
customPlugin
newInstance

getResource

private any getResource([any resource])
Facade to i18n.getResource. Returns a string.

Parameters:
resource - The resource to retrieve from the bundle.

getSetting

private any getSetting(string name, [boolean FWSetting='false'])
Facade

Parameters:
name
FWSetting

getSettingStructure

private struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
Facade

Parameters:
FWSetting
DeepCopyFlag

getSettingsBean

private configBean getSettingsBean()
Returns a configBean with all the configuration structure.


getcontroller

private any getcontroller()
Get controller: coldbox.system.controller


getfwLocale

public any getfwLocale()
Get the default locale string used in the framework. Returns a string


htmlhead

private void htmlhead(string content)
Facade to cfhtmlhead

Parameters:
content - The content to send to the head

include

private void include([string template])
Facade for cfinclude

Parameters:
template

includeUDF

private void includeUDF(string udflibrary)
Injects a UDF Library (*.cfc or *.udf).

Parameters:
udflibrary - The UDF library to inject.

locateDirectoryPath

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

Parameters:
pathToCheck - The path to check

locateFilePath

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

Parameters:
pathToCheck - The path to check

persistVariables

private void persistVariables([string persist=''], [struct varStruct])
Persist variables for flash redirections

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

populateModel

private Any populateModel(any model, [string scope=''], [boolean trustedSetter='false'])
Populate a named or instantiated model (java/cfc) from the request collection items

Parameters:
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() method
scope - 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 bean

relocate

private void relocate(string url, [boolean addtoken='false'])
Facade for cflocation

Parameters:
url
addtoken

renderExternalView

private Any renderExternalView(string view)
Facade to plugins' render external view.

Parameters:
view

renderView

private Any renderView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
Facade to plugin's render view.

Parameters:
view
cache - True if you want to cache the view.
cacheTimeout - The cache timeout
cacheLastAccessTimeout - The last access timeout

rethrowit

private void rethrowit(any throwObject)
Rethrow facade

Parameters:
throwObject - The cfcatch object

runEvent

private any runEvent([string event=''], [boolean prepostExempt='false'], [boolean private='false'])
Facade to controller's runEvent() method.

Parameters:
event
prepostExempt - If true, pre/post handlers will not be fired.
private - Execute a private event or not, default is false

setDebugMode

private void setDebugMode(boolean mode)
Facade to set your debug mode

Parameters:
mode

setNextEvent

private void setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct varStruct='[runtime expression]'], [boolean ssl='false'])
Facade

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.

setNextRoute

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

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

setSetting

private void setSetting(string name, any value)
Facade

Parameters:
name
value

setcontroller

private void setcontroller(any controller)
Set controller

Parameters:
controller - coldbox.system.controller

settingExists

private boolean settingExists(string name, [boolean FWSetting='false'])
Facade

Parameters:
name
FWSetting

throw

private any throw(string message, [string detail=''], [string type='Framework'])
Facade for cfthrow

Parameters:
message
detail
type

ColdBox Platform Version 2.6.3