|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.orm.hibernate.BaseORMService
coldbox.system.orm.hibernate.VirtualEntityService
contentbox.model.system.SettingService
public class SettingService
******************************************************************************* 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. ******************************************************************************* Setting Service for contentbox
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
appMapping
Attributes:
|
|
true
|
false
|
any
|
cache
Attributes:
|
|
true
|
false
|
any
|
moduleSettings
Attributes:
|
|
true
|
false
|
any
|
requestService
Attributes:
|
|
true
|
false
|
string
|
settingsCacheKey
Attributes: |
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
GETAPPMAPPING()
|
any |
GETCACHE()
|
any |
GETMODULESETTINGS()
|
any |
GETREQUESTSERVICE()
|
string |
GETSETTINGSCACHEKEY()
|
SettingService |
SETAPPMAPPING(any appMapping)
|
SettingService |
SETCACHE(any cache)
|
SettingService |
SETMODULESETTINGS(any moduleSettings)
|
SettingService |
SETREQUESTSERVICE(any requestService)
|
SettingService |
SETSETTINGSCACHEKEY(string settingsCacheKey)
|
any |
activateCB()
Mark cb as ready to serve |
struct |
buildFileBrowserSettings()
Build file browser settings structure |
any |
bulkSave([struct memento])
Bulk saving of options using a memento structure of options |
boolean |
deleteDSNCreator()
Delete the dsn creator module |
boolean |
deleteInstaller()
Delete the installer module |
any |
flushSettingsCache()
flush settings cache |
array |
getAllForExport()
Get all data prepared for export |
any |
getAllSettings([any asStruct='false'])
Get all settings |
any |
getSetting(any name, [any defaultValue])
Get a setting |
string |
importFromData(any importData, [boolean override='false'], [any importLog])
Import data from an array of structures of settings |
string |
importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file |
boolean |
isCBReady()
Check if contentbox has been installed by checking if there are no settings and no cb_active ONLY |
struct |
isInstallationPresent()
Check if the installer and dsn creator modules are present |
struct |
search([any search=''], [any max='0'], [any offset='0'], [any sortOrder='name asc'])
setting search returns struct with keys [settings,count] |
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 appMapping
inject
- coldbox:setting:appMappingrequired
- falseserializable
- truedefault
- any cache
inject
- cachebox:defaultrequired
- falseserializable
- truedefault
- any moduleSettings
inject
- coldbox:setting:modulesrequired
- falseserializable
- truedefault
- any requestService
inject
- coldbox:requestServicerequired
- falseserializable
- truedefault
- string settingsCacheKey
default
- serializable
- truerequired
- falseMethod Detail |
---|
public any GETAPPMAPPING()
public any GETCACHE()
public any GETMODULESETTINGS()
public any GETREQUESTSERVICE()
public string GETSETTINGSCACHEKEY()
public SettingService SETAPPMAPPING(any appMapping)
appMapping
public SettingService SETCACHE(any cache)
cache
public SettingService SETMODULESETTINGS(any moduleSettings)
moduleSettings
public SettingService SETREQUESTSERVICE(any requestService)
requestService
public SettingService SETSETTINGSCACHEKEY(string settingsCacheKey)
settingsCacheKey
public any activateCB()
public struct buildFileBrowserSettings()
public any bulkSave([struct memento])
memento
public boolean deleteDSNCreator()
public boolean deleteInstaller()
public any flushSettingsCache()
public array getAllForExport()
public any getAllSettings([any asStruct='false'])
asStruct
public any getSetting(any name, [any defaultValue])
name
defaultValue
public string importFromData(any importData, [boolean override='false'], [any importLog])
importData
override
importLog
public string importFromFile(any importFile, [boolean override='false'])
importFile
override
public boolean isCBReady()
public struct isInstallationPresent()
public struct search([any search=''], [any max='0'], [any offset='0'], [any sortOrder='name asc'])
search
max
offset
sortOrder
|
ContentBox Core API 1.6.0 | ||||
FRAMES |