Class FrameworkSupertype

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype

$abort

Facade for cfabort

$dump

Facade for cfmx dump

Parameters:

var

isAbort - Abort also

$htmlhead

Facade to cfhtmlhead

Parameters:

content - The content to send to the head

$include

Facade for cfinclude

Parameters:

template

$rethrow

Rethrow facade

Parameters:

throwObject - The cfcatch object

$throw

Facade for cfthrow

Parameters:

message

detail

type

addAsset

Add a js/css asset(s) to the html head section. You can also pass in a list of assets.

Parameters:

asset - The asset to load, only js or css files. This can also be a comma delimmited list.

announceInterception

Announce an interception to the system. If you use the asynchronous facilities, you will get a thread structure report as a result.

Parameters:

state - The interception state to execute

interceptData - 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 NORMAL

asyncJoinTimeout - The timeout in milliseconds for the join thread to wait for interceptor threads to finish. By default there is no timeout.

getColdboxOCM

Get a CacheBox Cache of type: coldbox.system.cache.IColdboxApplicationCache

Parameters:

cacheName - The cache name to retrieve

getController

Get controller: coldbox.system.web.Controller

getDatasource

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

Facade to get your current debug mode

getInterceptor

Get an interceptor

Parameters:

interceptorName - The name of the interceptor to search for

deepSearch - By default we search the cache for the interceptor reference. If true, we search all the registered interceptor states for a match.

getMailService

Get a reference to our Mail Service plugin

getMailSettings

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

getMemento

Get the memento of this object

getModel

Create or retrieve model objects by convention

Parameters:

name - The mapping name or CFC instance path to try to build up

dsl - 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 instance

getModuleSettings

Get a module's setting structure if it exists

Parameters:

module - The module name

getMyPlugin

Facade

Parameters:

plugin - The plugin name as a string

newInstance

module - The module to retrieve the plugin from

init - Auto init() the plugin upon construction

getNewMail

Get a new mail payload object ready for sending email through our mail service. This function's arguments match the cfmail tag, so send whatever you like

getPlugin

Facade

Parameters:

plugin - The Plugin object's name to instantiate, as a string

customPlugin

newInstance

module - The module to retrieve the plugin from

init - Auto init() the plugin upon construction

getResource

Facade to i18n.getResource. Returns a string.

Parameters:

resource - The resource (key) to retrieve from the main loaded bundle.

default - A default value to send back if the resource (key) not found

locale - Pass in which locale to take the resource from. By default it uses the user's current set locale

values - An array, struct or simple string of value replacements to use on the resource string

bundle - The bundle alias to use to get the resource from when using multiple resource bundles. By default the bundle name used is 'default'

getSetting

Facade

Parameters:

name

FWSetting

defaultValue - Default value to return if not found.

getSettingStructure

Facade

Parameters:

FWSetting

DeepCopyFlag

getSettingsBean

Returns a configBean with all the configuration structure.

Parameters:

FWSetting - Whether to build the config bean with coldbox settings or config settings

getValidationManager

Retrieve the application's configured Validation Manager

getfwLocale

Get the user's currently set locale or default locale

includeUDF

Injects a UDF Library (*.cfc or *.cfm) into the target object. It does not however, put the mixins on any of the cfc scopes. Therefore they can only be called internally.

Parameters:

udflibrary - The UDF library to inject.

loadGlobalUDFLibraries

Load the global UDF libraries defined in the UDFLibraryFile Setting

locateDirectoryPath

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

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

Persist variables for flash redirections

Parameters:

persist - What request collection keys to persist in the relocation

persistStruct - A structure key-value pairs to persist.

populateModel

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

include - A list of keys to include in the population

exclude - A list of keys to exclude in the population

ignoreEmpty - Ignore empty values on populations, great for ORM population

nullEmptyInclude - A list of keys to NULL when empty

nullEmptyExclude - A list of keys to NOT NULL when empty

composeRelationships - Automatically attempt to compose relationships from memento

relocate

This method will be deprecated, please use setNextEvent() instead.

Parameters:

url

addtoken

postProcessExempt - Do not fire the postProcess interceptors

renderExternalView

Renders external views

Parameters:

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 timeout

cacheLastAccessTimeout - The last access timeout

cacheSuffix - 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 ONLY

renderLayout

Renders a layout with view combinations

Parameters:

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.view

module - Explicitly render a layout from this module

args - An optional set of arguments that will be available to this layouts/view rendering ONLY

renderView

Renders all kinds of views

Parameters:

view

cache - True if you want to cache the view.

cacheTimeout - The cache timeout

cacheLastAccessTimeout - The last access timeout

cacheSuffix - Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.

module - Explicitly render a layout from this module

args - An optional set of arguments that will be available to this layouts/view rendering ONLY

collection - A collection to use by this Renderer to render the view as many times as the items in the collection

collectionAs - The name of the collection variable in the partial rendering. If not passed, we will use the name of the view by convention

runEvent

Facade to controller's runEvent() method.

Parameters:

event

prepostExempt - If true, pre/post handlers will not be fired. Boolean

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

eventArguments - A collection of arguments to passthrough to the calling event handler method. struct

setDebugMode

Facade to set your debug mode

Parameters:

mode

setNextEvent

Facade

Parameters:

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 pairs

addToken - Wether to add the tokens or not. Default is false

persist - What request collection keys to persist in flash ram

persistStruct - A structure key-value pairs to persist in flash ram.

ssl - Whether to relocate in SSL or not

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

postProcessExempt - Do not fire the postProcess interceptors

URL - 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 relocation

setNextRoute

This method is now deprecated, please use setNextEvent(). This method will be removed later on

Parameters:

route - The route to relocate to, do not prepend the baseURL or /.

persist - What request collection keys to persist in the relocation

persistStruct - 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

Facade

Parameters:

name

value

setfwLocale

Set the default locale to use in the framework for a specific user. Utility Method

Parameters:

locale - The locale to change and set. Must be Java Style: en_US

dontloadRBFlag - Flag to load the resource bundle for the specified locale (If not already loaded) or just change the framework's locale. Boolean

settingExists

Facade

Parameters:

name

FWSetting

validateModel

Validate a target object

Parameters:

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 constraints

constraints - The shared constraint name to use, or an actual constraints structure

locale - The locale to validate in

excludeFields - The fields to exclude in the validation