|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.orm.hibernate.BaseORMService
coldbox.system.orm.hibernate.VirtualEntityService
contentbox.model.modules.ModuleService
public class ModuleService
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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 & Description | Default | Serializable | Required |
any
|
coldboxModuleService
Attributes:
|
|
true
|
false
|
any
|
contentBoxSettings
Attributes:
|
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
struct
|
moduleWidgetCache
Attributes: |
|
true
|
false
|
string
|
modulesInvocationPath
Attributes: |
|
true
|
false
|
string
|
modulesPath
Attributes: |
|
true
|
false
|
any
|
settingService
Attributes:
|
|
true
|
false
|
any
|
zipUtil
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
GETCOLDBOXMODULESERVICE()
get: |
any |
GETCONTENTBOXSETTINGS()
get: |
any |
GETLOG()
get: |
string |
GETMODULESINVOCATIONPATH()
get: |
string |
GETMODULESPATH()
get: |
struct |
GETMODULEWIDGETCACHE()
get: |
any |
GETSETTINGSERVICE()
get: |
any |
GETZIPUTIL()
get: |
ModuleService |
SETCOLDBOXMODULESERVICE(any coldboxModuleService)
set: |
ModuleService |
SETCONTENTBOXSETTINGS(any contentBoxSettings)
set: |
ModuleService |
SETLOG(any log)
set: |
ModuleService |
SETMODULESINVOCATIONPATH(string modulesInvocationPath)
set: |
ModuleService |
SETMODULESPATH(string modulesPath)
set: |
ModuleService |
SETMODULEWIDGETCACHE(struct moduleWidgetCache)
set: |
ModuleService |
SETSETTINGSERVICE(any settingService)
set: |
ModuleService |
SETZIPUTIL(any zipUtil)
set: |
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 return null |
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 |
getModuleWidgetPath(string widgetName)
gets path for requested widget from modules' widget cache returns String |
private query |
getModulesOnDisk(any path)
|
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 |
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 |
---|
GETDATASOURCE, GETENTITYNAME, SETDATASOURCE, SETENTITYNAME, clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod
|
Methods inherited from class coldbox.system.orm.hibernate.BaseORMService |
---|
$delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, GETDEFAULTASQUERY, GETEVENTHANDLING, GETHQLDYNAMICCACHE, GETORM, GETORMEVENTHANDLER, GETQUERYCACHEREGION, GETUSEQUERYCACHING, GETUSETRANSACTIONS, SETDEFAULTASQUERY, SETEVENTHANDLING, SETHQLDYNAMICCACHE, SETORM, SETORMEVENTHANDLER, SETQUERYCACHEREGION, SETUSEQUERYCACHING, SETUSETRANSACTIONS, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getEntityGivenName, getRestrictions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, populateWithPrefix, refresh, save, saveAll, sessionContains
|
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any coldboxModuleService
inject
- coldbox:moduleServicerequired
- falseserializable
- truedefault
- any contentBoxSettings
inject
- coldbox:moduleConfig:contentboxrequired
- falseserializable
- truedefault
- any log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- struct moduleWidgetCache
default
- serializable
- truerequired
- falsestring modulesInvocationPath
default
- serializable
- truerequired
- falsestring modulesPath
default
- serializable
- truerequired
- falseany settingService
inject
- id:settingService@cbrequired
- falseserializable
- truedefault
- any zipUtil
inject
- coldbox:plugin:Ziprequired
- falseserializable
- truedefault
- Method Detail |
---|
public any GETCOLDBOXMODULESERVICE()
public any GETCONTENTBOXSETTINGS()
public any GETLOG()
public string GETMODULESINVOCATIONPATH()
public string GETMODULESPATH()
public struct GETMODULEWIDGETCACHE()
public any GETSETTINGSERVICE()
public any GETZIPUTIL()
public ModuleService SETCOLDBOXMODULESERVICE(any coldboxModuleService)
coldboxModuleService
public ModuleService SETCONTENTBOXSETTINGS(any contentBoxSettings)
contentBoxSettings
public ModuleService SETLOG(any log)
log
public ModuleService SETMODULESINVOCATIONPATH(string modulesInvocationPath)
modulesInvocationPath
public ModuleService SETMODULESPATH(string modulesPath)
modulesPath
public ModuleService SETMODULEWIDGETCACHE(struct moduleWidgetCache)
moduleWidgetCache
public ModuleService SETSETTINGSERVICE(any settingService)
settingService
public ModuleService SETZIPUTIL(any zipUtil)
zipUtil
public ModuleService activateModule(any name)
name
private void buildModuleWidgetsCache()
public ModuleService deactivateModule(any name)
name
public ModuleService deleteModule(any name)
name
private ModuleService detachColdBoxModuleRegistration(any name)
name
public Module findModuleByEntryPoint(any entryPoint)
entryPoint
public struct findModules([any isActive='any'])
isActive
- The active criteria, true, false or any for all modulespublic string getModuleWidgetPath(string widgetName)
widgetName
- {String}private query getModulesOnDisk(any path)
path
public any onDIComplete()
public any populateModule([any module], [any config])
module
config
public Module registerNewModule(any name)
name
public ModuleService resetModules()
public ModuleService startup()
public struct uploadModule(any fileField)
fileField
|
ContentBox Core API 1.6.0 | ||||
FRAMES |