WEB-INF.cftags.component coldbox.system.web.services.BaseService coldbox.system.web.services.ModuleService
I oversee and manage ColdBox modules
Constructor Summary | |
---|---|
init(any controller)
Constructor. |
Method Summary | |
---|---|
void
|
activateAllModules()
Go over all the loaded module configurations and activate them for usage within the application. |
boolean
|
activateModule(string moduleName)
Activate a module. |
private void
|
buildRegistry(array locations)
Build the modules registry. |
private boolean
|
canLoad(string moduleName)
Checks if the module can be loaded or registered. |
array
|
getLoadedModules()
Get a listing of all loaded modules. |
struct
|
getModuleConfigCache()
Return the loaded module's configuration objects. |
struct
|
getModuleRegistry()
Get the discovered module's registry structure. |
any
|
loadModuleConfiguration(struct config)
Load the module configuration object. |
void
|
onConfigurationLoad()
Called by loader service when configuration file loads. |
void
|
onShutdown()
Called when the application stops. |
any
|
rebuildModuleRegistry()
Rescan the module locations directories and re-register all located modules, this method does NOT register or activate any modules, it just reloads the found registry. |
void
|
registerAllModules()
Register all modules for the application. |
void
|
registerAndActivateModule(string moduleName, [string invocationPath=''])
Register and activate a new module. |
boolean
|
registerModule(string moduleName, [string invocationPath=''])
Register a module's configuration information and config object. |
void
|
reload(string moduleName)
Reload a targeted module. |
void
|
reloadAll()
Reload all modules. |
private void
|
scanModulesDirectory(string dirPath)
Get an array of modules found and add to the registry structure. |
boolean
|
unload(string moduleName)
Unload a module if found from the configuration. |
void
|
unloadAll()
Unload all registered modules. |
Methods inherited from class coldbox.system.web.services.BaseService |
---|
convertToColdBox, getColdboxOCM, getController, getUtil, isFamilyType, setController |
Methods inherited from class WEB-INF.cftags.component |
---|
None |
Constructor Detail |
---|
Constructor
controller
Method Detail |
---|
Go over all the loaded module configurations and activate them for usage within the application
Activate a module
moduleName
- The name of the module to load. It must exist and be valid. Else we ignore it by logging a warning and returning false.Build the modules registry
locations
- The array of locations to registerChecks if the module can be loaded or registered
moduleName
- The module nameGet a listing of all loaded modules
Return the loaded module's configuration objects
Get the discovered module's registry structure
Load the module configuration object
config
- The module config structureCalled by loader service when configuration file loads
onConfigurationLoad
in class
BaseService
Called when the application stops
onShutdown
in class
BaseService
Rescan the module locations directories and re-register all located modules, this method does NOT register or activate any modules, it just reloads the found registry
Register all modules for the application. Usually called by framework to load configuration data.
Register and activate a new module
moduleName
- The name of the module to load.invocationPath
- The module's invocation path to its root from the webroot (the instantiation path,ex:myapp.myCustomModules), if empty we use registry location, if not we are doing a explicit name+path registration. Do not include the module name, you passed that in the first argument rightRegister a module's configuration information and config object
moduleName
- The name of the module to load.invocationPath
- The module's invocation path to its root from the webroot (the instantiation path,ex:myapp.myCustomModules), if empty we use registry location, if not we are doing a explicit name+path registration. Do not include the module name, you passed that in the first argument rightReload a targeted module
moduleName
- The module to reloadReload all modules
Get an array of modules found and add to the registry structure
dirPath
- Path to scanUnload a module if found from the configuration
moduleName
- The module name to unloadUnload all registered modules