lucee.Componentcborm.models.BaseORMService
cborm.models.VirtualEntityService
contentbox.models.modules.ModuleService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manage ContentBox Modules
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
coldboxModuleService
|
true
|
false
|
|
any
|
contentBoxSettings
|
true
|
false
|
|
string
|
coreModulesInvocationPath
The invocation path for core modules.
|
true
|
false
|
|
string
|
coreModulesPath
The absolute path to core module locations.
|
true
|
false
|
|
any
|
customModuleSettings
|
true
|
false
|
|
string
|
customModulesInvocationPath
The invocation path for custom modules.
|
true
|
false
|
|
string
|
customModulesPath
The absolute path to custom module locations.
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
struct
|
moduleConfigCache
ColdBox Module Config Cache reference.
|
true
|
false
|
|
struct
|
moduleMap
Module Map References.
|
true
|
false
|
|
struct
|
moduleRegistry
ColdBox Module Registry reference.
|
true
|
false
|
|
struct
|
moduleWidgetCache
The module widget cache.
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
widgetService
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
ModuleService
|
activateModule(any name)
Activate a module from ContentBox. |
private ModuleService
|
buildModuleWidgetsCache([array modules])
Iterates over all registered, active modules and sets any found widgets into a cache in moduleservice. |
ModuleService
|
deactivateModule(any name)
Deactivate a module from ContentBox. |
ModuleService
|
deleteModule(any name)
Delete Module, should only be done on deactivated modules. |
private ModuleService
|
detachColdBoxModuleRegistration(any name)
Detach coldbox module configuration registrations. |
Module
|
findModuleByEntryPoint(any entryPoint)
Find a module in the DB by entry point. |
struct
|
findModules([any isActive='any'], [any moduleType])
Find modules in ContentBox using the active criteria or `any`. |
string
|
getColdboxModuleService()
|
string
|
getContentBoxSettings()
|
string
|
getCoreModulesInvocationPath()
|
string
|
getCoreModulesPath()
|
string
|
getCustomModuleSettings()
|
string
|
getCustomModulesInvocationPath()
|
string
|
getCustomModulesPath()
|
string
|
getLog()
|
string
|
getModuleConfigCache()
|
string
|
getModuleMap()
|
string
|
getModuleRegistry()
|
string
|
getModuleWidgetCache()
|
string
|
getModuleWidgetInvocationPath(string widgetName)
Shortcut to get the invocation path for requested widget from modules' widget cache. |
private array
|
getModulesOnDisk(any path)
Get a collection of directory modules on disk at a specific location. |
string
|
getSettingService()
|
string
|
getWidgetService()
|
any
|
onDIComplete()
Executes after DI completion. |
any
|
populateModule([any module], [any config])
Populate module from Module Configuration CFC and returns the module. |
Module
|
registerNewModule(any name, any type)
Register a new module and return the module representation, this does not activate, just registers. |
ModuleService
|
resetModules()
Reset all modules by deactivating all of them and cleaning our db history. |
any
|
setColdboxModuleService(any coldboxModuleService)
|
any
|
setContentBoxSettings(any contentBoxSettings)
|
any
|
setCoreModulesInvocationPath(string coreModulesInvocationPath)
|
any
|
setCoreModulesPath(string coreModulesPath)
|
any
|
setCustomModuleSettings(any customModuleSettings)
|
any
|
setCustomModulesInvocationPath(string customModulesInvocationPath)
|
any
|
setCustomModulesPath(string customModulesPath)
|
any
|
setLog(any log)
|
any
|
setModuleConfigCache(struct moduleConfigCache)
|
any
|
setModuleMap(struct moduleMap)
|
any
|
setModuleRegistry(struct moduleRegistry)
|
any
|
setModuleWidgetCache(struct moduleWidgetCache)
|
any
|
setSettingService(any settingService)
|
any
|
setWidgetService(any widgetService)
|
ModuleService
|
startup()
Startup the service. |
Methods inherited from class cborm.models.VirtualEntityService |
---|
autoCast, convertIdValueToJavaType, convertValueToJavaType, count, countWhere, deleteAll, deleteByID, deleteByQuery, deleteWhere, evictCollection, executeQuery, exists, findAllWhere, findWhere, get, getAll, getEntityName, getKey, getOrFail, getPropertyNames, getTableName, idCast, list, new, newCriteria, onMissingMethod, setEntityName |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- coldbox:moduleServiceserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:moduleConfig:contentboxserializable
- trueThe invocation path for core modules
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe absolute path to core module locations
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:moduleConfig:contentbox-customserializable
- trueThe invocation path for custom modules
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe absolute path to custom module locations
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueColdBox Module Config Cache reference
access
- publicrequired
- falsereturntype
- anyserializable
- trueModule Map References
access
- publicrequired
- falsereturntype
- anyserializable
- trueColdBox Module Registry reference
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe module widget cache
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- settingService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- provider:widgetService@contentboxserializable
- trueMethod Detail |
---|
Activate a module from ContentBox
name
- The name of the module to activateIterates over all registered, active modules and sets any found widgets into a cache in moduleservice
modules
- Optional passed array to use to build the module cache with, else query the databaseDeactivate a module from ContentBox
name
- The module to deactivateDelete Module, should only be done on deactivated modules
name
- The name of the module to deleteDetach coldbox module configuration registrations
name
- The name of the module to detachFind a module in the DB by entry point
entryPoint
- The point to findFind modules in ContentBox using the active criteria or `any`
isActive
- The active criteria, true, false or any for all modulesmoduleType
- The module type criteriaShortcut to get the invocation path for requested widget from modules' widget cache
widgetName
- {String}Get a collection of directory modules on disk at a specific location
path
- The path to checkExecutes after DI completion
Populate module from Module Configuration CFC and returns the module
module
config
- The config object to populate withRegister a new module and return the module representation, this does not activate, just registers
name
- The name of the module to registertype
- The type of module: core or customReset all modules by deactivating all of them and cleaning our db history
coldboxModuleService
contentBoxSettings
coreModulesInvocationPath
coreModulesPath
customModuleSettings
customModulesInvocationPath
customModulesPath
log
moduleConfigCache
moduleMap
moduleRegistry
moduleWidgetCache
settingService
widgetService
Startup the service. This iterates through all modules on disk and if it finds a module that it has not been registered, it will register it. If it loads a module that is registered and marked as active it will activate it.