Built with
Coldbox

Visit the Model Glue Version of this Site

Home

Complex Data Types

Lists

Arrays

Structures

Advanced Structures

CFC Functionality (It's a specialized complex data type w/methods)

Request a username using your email

Add Employee
How it works

Show Employees

* For sake of simplistic examples, <cfqueryparam> is not used in any of the examples. Please be sure to use <cfqueryparam> in your production code

Thanks to Jeff Peters for writing his great book, "ColdFusion Lists, Arrays, and Structures"

Let's dump the application scope to view our cfcs in application memory. Wooo!

struct
applicationname 0DEC54A87A48263FE84925134F90E647
cbcontroller
component coldbox.system.controller
OCFMLENGINE
component coldbox.system.util.CFMLEngine
ADOBE ADOBE
BLUEDRAGON BLUEDRAGON
RAILO RAILO
METHODS
GETENGINE
function getEngine
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current CFML Engine
Description:  
INIT
function init
Arguments:none
ReturnType: CFMLEngine
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Constructor
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the current running CFML version
Description:  
ISMT
function isMT
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Checks if the engine is MT.
Description:  
METHODS
SETNEXTROUTE
function setNextRoute
Arguments:
Name Required Type Default
route Required string  
persist Optional string [empty string]
ReturnType: void
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Set the next ses route to relocate to. This method pre-pends the baseURL
Description:  
RUNEVENT
function runEvent
Arguments:
Name Required Type Default
event Optional any [empty string]
prepostExempt Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output:  
DisplayName:  
Hint: I am an event handler runnable factory. If no event is passed in then it will run the default event from the config file.
Description:  
GETPLUGINSERVICE
function getPluginService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get PluginService: coldbox.system.services.pluginService
Description:  
GETCOLDBOXSETTINGS
function getColdboxSettings
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I retrieve the ColdBox Settings Structure by Reference
Description:  
SETCOLDBOXSETTINGS
function setColdboxSettings
Arguments:
Name Required Type Default
ColdboxSettings Required struct  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ColdboxSettings
Description:  
SETAPPSTARTHANDLERFIRED
function setAppStartHandlerFired
Arguments:
Name Required Type Default
AppStartHandlerFired Required boolean  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set AppStartHandlerFired
Description:  
GETINTERCEPTORSERVICE
function getinterceptorService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get interceptorService: coldbox.system.services.interceptorService
Description:  
SETSETTING
function setSetting
Arguments:
Name Required Type Default
name Optional string  
value Optional any  
ReturnType: void
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided. This only sets in the ConfigStruct
Description:  
GETREQUESTSERVICE
function getRequestService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get RequestService: coldbox.system.services.requestService
Description:  
GETCOLDBOXOCM
function getColdboxOCM
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get ColdboxOCM: coldbox.system.cache.cacheManager
Description:  
PERSISTVARIABLES
function persistVariables
Arguments:
Name Required Type Default
persist Optional string [empty string]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Persist variables for flash redirections
Description:  
SETAPPROOTPATH
function setAppRootPath
Arguments:
Name Required Type Default
AppRootPath Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SETNEXTEVENT
function setNextEvent
Arguments:
Name Required Type Default
event Optional string [runtime expression]
queryString Optional string [empty string]
addToken Optional boolean false
persist Optional string [empty string]
ReturnType: void
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Set the next event to run and relocate the browser to that event.
Description:  
SETREQUESTSERVICE
function setRequestService
Arguments:
Name Required Type Default
RequestService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set RequestService
Description:  
SETTINGEXISTS
function settingExists
Arguments:
Name Required Type Default
name Optional string  
FWSetting Optional boolean false
ReturnType: boolean
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Check if a value exists in the configstruct or the fwsettingsStruct.
Description:  
INIT
function init
Arguments:
Name Required Type Default
AppRootPath Required string  
ReturnType: coldbox.system.controller
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I am the constructor
Description:  
GETAPPROOTPATH
function getAppRootPath
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SETINTERCEPTORSERVICE
function setinterceptorService
Arguments:
Name Required Type Default
interceptorService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set interceptorService
Description:  
GETHANDLERSERVICE
function getHandlerService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get HandlerService: coldbox.system.services.handlerService
Description:  
GETCOLDBOXINITIATED
function getColdboxInitiated
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get ColdboxInitiated
Description:  
SETAPPHASH
function setAppHash
Arguments:
Name Required Type Default
AppHash Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set AppHash
Description:  
SETDEBUGGERSERVICE
function setDebuggerService
Arguments:
Name Required Type Default
DebuggerService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set DebuggerService
Description:  
GETSETTING
function getSetting
Arguments:
Name Required Type Default
name Optional string  
FWSetting Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I get a setting from the FW Config structures. Use the FWSetting boolean argument to retrieve from the fwSettingsStruct.
Description:  
SETCOLDBOXOCM
function setColdboxOCM
Arguments:
Name Required Type Default
ColdboxOCM Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ColdboxOCM
Description:  
THROW
function throw
Arguments:
Name Required Type Default
message Required string  
detail Optional string [empty string]
type Optional string Framework
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade for cfthrow
Description:  
GETSETTINGSTRUCTURE
function getSettingStructure
Arguments:
Name Required Type Default
FWSetting Optional boolean false
DeepCopyFlag Optional boolean false
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Compatability & Utility Method. By default I retrieve the Config Settings. You can change this by using the FWSetting flag.
Description:  
SETHANDLERSERVICE
function setHandlerService
Arguments:
Name Required Type Default
HandlerService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set HandlerService
Description:  
GETAPPSTARTHANDLERFIRED
function getAppStartHandlerFired
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get AppStartHandlerFired
Description:  
GETDEBUGGERSERVICE
function getDebuggerService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get DebuggerService: coldbox.system.services.debuggerService
Description:  
GETUTIL
function getUtil
Arguments:none
ReturnType: coldbox.system.util.util
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Create and return a util object
Description:  
SETCONFIGSETTINGS
function setConfigSettings
Arguments:
Name Required Type Default
ConfigSettings Required struct  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ConfigSettings
Description:  
GETPLUGIN
function getPlugin
Arguments:
Name Required Type Default
plugin Optional string  
customPlugin Optional boolean false
newInstance Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: true
DisplayName:  
Hint: I am the Plugin cfc object factory.
Description:  
GETSERVICE
function getService
Arguments:
Name Required Type Default
service Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Internal ColdBox Transient Minimalistic Service Locator.
Description:  
SETCOLDBOXINITIATED
function setColdboxInitiated
Arguments:
Name Required Type Default
ColdboxInitiated Required boolean  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ColdboxInitiated
Description:  
GETCONFIGSETTINGS
function getConfigSettings
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I retrieve the Config Settings Structure by Reference
Description:  
GETAPPHASH
function getAppHash
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get AppHash
Description:  
SETPLUGINSERVICE
function setPluginService
Arguments:
Name Required Type Default
PluginService Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set PluginService
Description: