railo-context.Componentcoldbox.system.orm.hibernate.BaseORMService
coldbox.system.orm.hibernate.VirtualEntityService
contentbox.model.modules.ModuleService
ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Manage ContentBox Modules
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
coldboxModuleService
|
true
|
false
|
|
any
|
contentBoxSettings
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
string
|
modulesInvocationPath
|
true
|
false
|
|
string
|
modulesPath
|
true
|
false
|
|
struct
|
moduleWidgetCache
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
zipUtil
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
ModuleService
|
activateModule(any name)
Activate a module from ContentBox. |
private void
|
buildModuleWidgetsCache()
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)
findModuleByEntryPoint. |
struct
|
findModules([any isActive='any'])
findModules. |
string
|
getColdboxModuleService()
|
string
|
getContentBoxSettings()
|
string
|
getLog()
|
string
|
getModulesInvocationPath()
|
private query
|
getModulesOnDisk(any path)
|
string
|
getModulesPath()
|
string
|
getModuleWidgetCache()
|
string
|
getModuleWidgetPath(string widgetName)
gets path for requested widget from modules' widget cache. |
string
|
getSettingService()
|
string
|
getZipUtil()
|
any
|
onDIComplete()
onDIComplete. |
any
|
populateModule([any module], [any config])
Populate module from Module Configuration CFC and returns the module. |
Module
|
registerNewModule(any name)
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
|
setLog(any log)
|
any
|
setModulesInvocationPath(string modulesInvocationPath)
|
any
|
setModulesPath(string modulesPath)
|
any
|
setModuleWidgetCache(struct moduleWidgetCache)
|
any
|
setSettingService(any settingService)
|
any
|
setZipUtil(any zipUtil)
|
ModuleService
|
startup()
Startup the modules. |
struct
|
uploadModule(any fileField)
Upload Module, returns structure with [error:boolean, logInfo=string]. |
Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService |
---|
clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getDatasource, getEntityName, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod, setDatasource, setEntityName |
Methods inherited from class coldbox.system.orm.hibernate.BaseORMService |
---|
$delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getDefaultAsQuery, getEntityGivenName, getEventHandling, getHQLDynamicCache, getORM, getORMEventHandler, getQueryCacheRegion, getRestrictions, getUseQueryCaching, getUseTransactions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, populateWithPrefix, refresh, save, saveAll, sessionContains, setDefaultAsQuery, setEventHandling, setHQLDynamicCache, setORM, setORMEventHandler, setQueryCacheRegion, setUseQueryCaching, setUseTransactions |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseinject
- coldbox:moduleServiceserializable
- truerequired
- falseinject
- coldbox:moduleConfig:contentboxserializable
- truerequired
- falseinject
- logbox:logger:{this}serializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseinject
- id:settingService@cbserializable
- truerequired
- falseinject
- coldbox:plugin:Zipserializable
- trueMethod Detail |
---|
Activate a module from ContentBox
name
Iterates over all registered, active modules and sets any found widgets into a cache in moduleservice return null
Deactivate a module from ContentBox
name
Delete Module, should only be done on deactivated modules
name
Detach coldbox module configuration registrations
name
findModuleByEntryPoint
entryPoint
findModules
isActive
- The active criteria, true, false or any for all modulespath
gets path for requested widget from modules' widget cache returns String
widgetName
- {String}onDIComplete
Populate module from Module Configuration CFC and returns the module
module
config
Register a new module and return the module representation, this does not activate, just registers
name
Reset all modules by deactivating all of them and cleaning our db history
coldboxModuleService
contentBoxSettings
log
modulesInvocationPath
modulesPath
moduleWidgetCache
settingService
zipUtil
Startup the modules
Upload Module, returns structure with [error:boolean, logInfo=string]
fileField