|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
public class FrameworkSupertype
This is the layer supertype cfc for all ColdBox related objects.
Method Summary | |
---|---|
void |
$abort()
Facade for cfabort |
void |
$dump(any var, [boolean isAbort='false'])
Facade for cfmx dump |
void |
$htmlhead(string content)
Facade to cfhtmlhead |
void |
$include([string template])
Facade for cfinclude |
void |
$rethrow(any throwObject)
Rethrow facade |
any |
$throw(string message, [string detail=''], [string type='Framework'])
Facade for cfthrow |
any |
addAsset(any asset)
Add a js/css asset(s) to the html head section |
any |
announceInterception(any state, [any interceptData], [boolean async='false'], [boolean asyncAll='false'], [boolean asyncAllJoin='true'], [string asyncPriority='NORMAL'], [numeric asyncJoinTimeout='0'])
Announce an interception to the system |
any<IColdboxApplicationCache> |
getColdboxOCM([any cacheName='default'])
Get a CacheBox Cache of type: coldbox |
any |
getController()
Get controller: coldbox |
any<DatasourceBean> |
getDatasource([any alias])
I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct |
boolean |
getDebugMode()
Facade to get your current debug mode |
any |
getInterceptor([any interceptorName], [any<Boolean> deepSearch='false'])
Get an interceptor |
any |
getMailService()
Get a reference to our Mail Service plugin |
any<MailSettingsBean> |
getMailSettings()
I will return to you a mailsettingsBean modeled after your mail settings in your config file |
any |
getMemento()
Get the memento of this object |
any |
getModel([any name], [any dsl], [any<struct> initArguments='[runtime expression]'])
Create or retrieve model objects by convention |
any |
getModuleSettings(any module)
Get a module's setting structure if it exists |
any |
getMyPlugin(any plugin, [any<Boolean> newInstance='false'], [any module=''], [any<Boolean> init='true'])
Facade |
any |
getNewMail()
Get a new mail payload object ready for sending email through our mail service |
any |
getPlugin([any plugin], [any<Boolean> customPlugin='false'], [any<Boolean> newInstance='false'], [any module=''], [any<Boolean> init='true'])
Facade |
any |
getResource(any resource, [any default], [any locale])
Facade to i18n |
any |
getSetting(any name, [boolean FWSetting='false'], [any defaultValue])
Facade |
struct |
getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
Facade |
ConfigBean |
getSettingsBean([boolean FWSetting='false'])
Returns a configBean with all the configuration structure |
IValidationManager |
getValidationManager()
Retrieve the application's configured Validation Manager |
any |
getfwLocale()
Get the user's currently set locale or default locale |
void |
includeUDF(any udflibrary)
Injects a UDF Library (* |
any |
loadGlobalUDFLibraries()
Load the global UDF libraries defined in the UDFLibraryFile Setting |
string |
locateDirectoryPath(any pathToCheck)
Locate the real path location of a directory in a coldbox application |
string |
locateFilePath(any pathToCheck)
Locate the real path location of a file in a coldbox application |
void |
persistVariables([string persist=''], [struct persistStruct])
Persist variables for flash redirections |
Any |
populateModel(any model, [any scope=''], [boolean<Boolean> trustedSetter='false'], [any include=''], [any exclude=''], [boolean ignoreEmpty='false'], [string nullEmptyInclude=''], [string nullEmptyExclude=''], [boolean composeRelationships='false'])
Populate a named or instantiated model (java/cfc) from the request collection items |
void |
relocate(string url, [boolean addtoken='false'], [boolean postProcessExempt='false'])
This method will be deprecated, please use setNextEvent() instead |
Any |
renderExternalView(any view, [any cache], [any cacheTimeout], [any cacheLastAccessTimeout], [any cacheSuffix], [struct args='[runtime expression]'])
Renders external views |
any |
renderLayout([any layout], [any view], [any module], [struct args='[runtime expression]'])
Renders a layout with view combinations |
Any |
renderView(any view, [any cache], [any cacheTimeout], [any cacheLastAccessTimeout], [any cacheSuffix], [any module], [struct args='[runtime expression]'], [any collection], [any collectionAs])
Renders all kinds of views |
any |
runEvent([any event=''], [any<boolean> prepostExempt='false'], [any<boolean> private='false'], [any<boolean> default='false'], [any<struct> eventArguments='[runtime expression]'])
Facade to controller's runEvent() method |
void |
setDebugMode(boolean mode)
Facade to set your debug mode |
void |
setNextEvent([string event], [string queryString], [boolean addToken], [string persist], [struct persistStruct], [boolean ssl], [string baseURL], [boolean postProcessExempt], [string URL], [string URI], [numeric statusCode])
Facade |
void |
setNextRoute(string route, [string persist=''], [struct persistStruct], [boolean addToken='false'], [boolean ssl='false'])
This method is now deprecated, please use setNextEvent() |
void |
setSetting(any name, any value)
Facade |
any |
setfwLocale([any locale], [any<Boolean> dontloadRBFlag])
Set the default locale to use in the framework for a specific user |
boolean |
settingExists(any name, [boolean FWSetting='false'])
Facade |
IValidationResult |
validateModel(any target, [string fields='*'], [any constraints], [string locale=''], [string excludeFields=''])
Validate a target object |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Method Detail |
---|
public void $abort()
public void $dump(any var, [boolean isAbort='false'])
var
isAbort
- Abort alsopublic void $htmlhead(string content)
content
- The content to send to the headpublic void $include([string template])
template
public void $rethrow(any throwObject)
throwObject
- The cfcatch objectpublic any $throw(string message, [string detail=''], [string type='Framework'])
message
detail
type
public any addAsset(any asset)
asset
- The asset to load, only js or css files. This can also be a comma delimmited list.public any announceInterception(any state, [any interceptData], [boolean async='false'], [boolean asyncAll='false'], [boolean asyncAllJoin='true'], [string asyncPriority='NORMAL'], [numeric asyncJoinTimeout='0'])
state
- The interception state to executeinterceptData
- A data structure used to pass intercepted information.async
- If true, the entire interception chain will be ran in a separate thread.asyncAll
- If true, each interceptor in the interception chain will be ran in a separate thread and then joined together at the end.asyncAllJoin
- If true, each interceptor in the interception chain will be ran in a separate thread and joined together at the end by default. If you set this flag to false then there will be no joining and waiting for the threads to finalize.asyncPriority
- The thread priority to be used. Either LOW, NORMAL or HIGH. The default value is NORMALasyncJoinTimeout
- The timeout in milliseconds for the join thread to wait for interceptor threads to finish. By default there is no timeout.public any<IColdboxApplicationCache> getColdboxOCM([any cacheName='default'])
cacheName
- The cache name to retrievepublic any getController()
public any<DatasourceBean> getDatasource([any alias])
alias
- The alias of the datasource to get from the configstruct (alias property in the config file)public boolean getDebugMode()
public any getInterceptor([any interceptorName], [any<Boolean> deepSearch='false'])
interceptorName
- The name of the interceptor to search fordeepSearch
- By default we search the cache for the interceptor reference. If true, we search all the registered interceptor states for a match.public any getMailService()
public any<MailSettingsBean> getMailSettings()
public any getMemento()
public any getModel([any name], [any dsl], [any<struct> initArguments='[runtime expression]'])
name
- The mapping name or CFC instance path to try to build updsl
- The dsl string to use to retrieve the instance model object, mutually exclusive with 'name'initArguments
- The constructor structure of arguments to passthrough when initializing the instancepublic any getModuleSettings(any module)
module
- The module namepublic any getMyPlugin(any plugin, [any<Boolean> newInstance='false'], [any module=''], [any<Boolean> init='true'])
plugin
- The plugin name as a stringnewInstance
module
- The module to retrieve the plugin frominit
- Auto init() the plugin upon constructionpublic any getNewMail()
public any getPlugin([any plugin], [any<Boolean> customPlugin='false'], [any<Boolean> newInstance='false'], [any module=''], [any<Boolean> init='true'])
plugin
- The Plugin object's name to instantiate, as a stringcustomPlugin
newInstance
module
- The module to retrieve the plugin frominit
- Auto init() the plugin upon constructionpublic any getResource(any resource, [any default], [any locale])
resource
- The resource to retrieve from the loaded localized bundledefault
- A default value to send back if resource not foundlocale
- Pass in which locale to take the resource from. By default it uses the user's current set localepublic any getSetting(any name, [boolean FWSetting='false'], [any defaultValue])
name
FWSetting
defaultValue
- Default value to return if not found.public struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
FWSetting
DeepCopyFlag
public ConfigBean getSettingsBean([boolean FWSetting='false'])
FWSetting
- Whether to build the config bean with coldbox settings or config settingspublic IValidationManager getValidationManager()
public any getfwLocale()
public void includeUDF(any udflibrary)
udflibrary
- The UDF library to inject.public any loadGlobalUDFLibraries()
public string locateDirectoryPath(any pathToCheck)
pathToCheck
- The path to checkpublic string locateFilePath(any pathToCheck)
pathToCheck
- The path to checkpublic void persistVariables([string persist=''], [struct persistStruct])
persist
- What request collection keys to persist in the relocationpersistStruct
- A structure key-value pairs to persist.public Any populateModel(any model, [any scope=''], [boolean<Boolean> trustedSetter='false'], [any include=''], [any exclude=''], [boolean ignoreEmpty='false'], [string nullEmptyInclude=''], [string nullEmptyExclude=''], [boolean composeRelationships='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 beaninclude
- A list of keys to include in the populationexclude
- A list of keys to exclude in the populationignoreEmpty
- Ignore empty values on populations, great for ORM populationnullEmptyInclude
- A list of keys to NULL when emptynullEmptyExclude
- A list of keys to NOT NULL when emptycomposeRelationships
- Automatically attempt to compose relationships from mementopublic void relocate(string url, [boolean addtoken='false'], [boolean postProcessExempt='false'])
url
addtoken
postProcessExempt
- Do not fire the postProcess interceptorspublic Any renderExternalView(any view, [any cache], [any cacheTimeout], [any cacheLastAccessTimeout], [any cacheSuffix], [struct args='[runtime expression]'])
view
- The full path to the view. This can be an expanded path or relative. Include extension.cache
- True if you want to cache the view.cacheTimeout
- The cache timeoutcacheLastAccessTimeout
- The last access timeoutcacheSuffix
- Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.args
- An optional set of arguments that will be available to this layouts/view rendering ONLYPublic any renderLayout([any layout], [any view], [any module], [struct args='[runtime expression]'])
layout
- The explicit layout to use in rendering.view
- The name of the view to passthrough as an argument so you can refer to it as arguments.viewmodule
- Explicitly render a layout from this moduleargs
- An optional set of arguments that will be available to this layouts/view rendering ONLYpublic Any renderView(any view, [any cache], [any cacheTimeout], [any cacheLastAccessTimeout], [any cacheSuffix], [any module], [struct args='[runtime expression]'], [any collection], [any collectionAs])
view
cache
- True if you want to cache the view.cacheTimeout
- The cache timeoutcacheLastAccessTimeout
- The last access timeoutcacheSuffix
- Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.module
- Explicitly render a layout from this moduleargs
- An optional set of arguments that will be available to this layouts/view rendering ONLYcollection
- A collection to use by this Renderer to render the view as many times as the items in the collectioncollectionAs
- The name of the collection variable in the partial rendering. If not passed, we will use the name of the view by conventionpublic any runEvent([any event=''], [any<boolean> prepostExempt='false'], [any<boolean> private='false'], [any<boolean> default='false'], [any<struct> eventArguments='[runtime expression]'])
event
prepostExempt
- If true, pre/post handlers will not be fired. Booleanprivate
- Execute a private event or not, default is falsedefault
- The flag that let's this service now if it is the default set event running or not. USED BY THE FRAMEWORK ONLYeventArguments
- A collection of arguments to passthrough to the calling event handler method. structpublic void setDebugMode(boolean mode)
mode
public void setNextEvent([string event], [string queryString], [boolean addToken], [string persist], [struct persistStruct], [boolean ssl], [string baseURL], [boolean postProcessExempt], [string URL], [string URI], [numeric statusCode])
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 notbaseURL
- 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 void setNextRoute(string route, [string persist=''], [struct persistStruct], [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 relocationpersistStruct
- A structure key-value pairs to persist.addToken
- Wether to add the tokens or not. Default is falsessl
- Whether to relocate in SSL or notpublic void setSetting(any name, any value)
name
value
public any setfwLocale([any locale], [any<Boolean> dontloadRBFlag])
locale
- The locale to change and set. Must be Java Style: en_USdontloadRBFlag
- Flag to load the resource bundle for the specified locale (If not already loaded) or just change the framework's locale. Booleanpublic boolean settingExists(any name, [boolean FWSetting='false'])
name
FWSetting
public IValidationResult validateModel(any target, [string fields='*'], [any constraints], [string locale=''], [string excludeFields=''])
target
- The target object to validate or a structure of name-value paris to validate.fields
- Validate on all or one or a list of fields (properties) on the target, by default we validate all fields declared in its constraintsconstraints
- The shared constraint name to use, or an actual constraints structurelocale
- The locale to validate inexcludeFields
- The fields to exclude in the validation
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |