Reserved Words & Methods Guide
Introduction
This guide will show you which methods and variables are reserved and cannot be overriden when you are developing ColdBox applications. The affected sections of your applications are your event handlers and plugins. Why? Well, because they need to extend the base classes that the framework provides for you. Therefore, you will inherit functionality in all your event handlers and plugins. Some that can be overriden, others cannot, and if you do, quirky and nasty things may happen. So to start off we will investigate the anatomy of an event handler.
Event Handler Reserved Words & Methods
The event handler is a workhorse object in your application. It concentrates all its energies on directing requests to business tiers and preparing views and what not. For more information on event handlers, please see the Event Handlers Guide. So lets see what variables you inherit.
Reserved Words
| controller | The ColdBox Controller |
| instance | Internal private scope |
| instance.__hash | An internal hash id for the event handler. |
Reserved Facade/Concrete Methods
| abort | cfabort facade |
| announceInterception | A way to announce custom interceptions |
| dump | cfdump facade |
| getColdBoxOCM | Get a reference to the ColdBox Object Cache Manager |
| getcontroller | Get a reference to the ColdBox controller |
| getDatasource | Get a named datasource bean |
| getDebugMode | Get the current debug mode for the user |
| getfwlocale | If using i18N, then retrieves the current locale |
| getHash | Get the hash |
| getMailSettings | Get a mail settings bean |
| getMyPlugin | Get a custom plugin |
| getPlugin | Get a core or custom plugin |
| getResource | If using i18N, then retrieves a resource from a resource bundle |
| getSetting | Get a setting |
| getSettingsBean | Geta a config settings bean |
| getSettingStructure | Get the ColdBox or Application Settings Structure |
| include | cfinclude facade |
| includeUDF | A mixin injection method, so you can inject your handler with your own methods at runtime. |
| purgeView | The ability to purge a named view from the cache |
| relocate | Facade to cflocation |
| renderExternalView | Render an external view |
| renderView | Render a view |
| runEvent | Execute a ColdBox event |
| setDebugMode | Set the debug mode for the user |
| setNextEvent | Relocate to another event |
| setNextRoute | Relocate to another route |
| setSetting | Set a setting |
| settingExists | Check if a setting exists |
| throw | cfthrow facade |
Plugin Reserved Words & Methods
ColdBox plugins are the way that you can extend the framework to do more application specific tasks or aspects around an application. For more information on plugins, please see the Plugins Guide. So lets see what variables you inherit.
Reserved Words
| controller | The ColdBox Controller |
| instance | Internal private scope |
| instance.__hash | An internal hash id for the event handler |
| instance.pluginName | The name of the plugin |
| instance.pluginVersion | The version of the plugin |
| instance.pluginDescription | The description of the plugin |
| instance.pluginPath | The current template path of the plugin location |
Reserved Facade/Concrete Methods
| set/getPluginName | Set/Get the plugin name |
| set/getPluginVersion | Set/Get the plugin Version |
| set/getPluginDescription | Set/Get the plugin description |
| getPluginPath | Get the current plugin path |
| abort | cfabort facade |
| announceInterception | A way to announce custom interceptions |
| dump | cfdump facade |
| getColdBoxOCM | Get a reference to the ColdBox Object Cache Manager |
| getcontroller | Get a reference to the ColdBox controller |
| getDatasource | Get a named datasource bean |
| getDebugMode | Get the current debug mode for the user |
| getfwlocale | If using i18N, then retrieves the current locale |
| getHash | Get the hash |
| getMailSettings | Get a mail settings bean |
| getMyPlugin | Get a custom plugin |
| getPlugin | Get a core or custom plugin |
| getResource | If using i18N, then retrieves a resource from a resource bundle |
| getSetting | Get a setting |
| getSettingsBean | Geta a config settings bean |
| getSettingStructure | Get the ColdBox or Application Settings Structure |
| include | cfinclude facade |
| includeUDF | A mixin injection method, so you can inject your handler with your own methods at runtime. |
| purgeView | The ability to purge a named view from the cache |
| relocate | Facade to cflocation |
| renderExternalView | Render an external view |
| renderView | Render a view |
| runEvent | Execute a ColdBox event |
| setDebugMode | Set the debug mode for the user |
| setNextEvent | Relocate to another event |
| setNextRoute | Relocate to another route |
| setSetting | Set a setting |
| settingExists | Check if a setting exists |
| throw | cfthrow facade |
Conclusion
As you can see from the listing above, there are several methods and variables that you inherit as an event handler or a plugin. There is no reason why you should not override them, if you know what you are doing and would like to actually decorate the internal methods via the event handler or a decorator UDF injection. So the possibilities of making ColdBox adapt to your needs is ENDLESS!!
