ContentBox Core API 1.6.0

contentbox.model.system
Class SettingService

WEB-INF.cftags.component
        extended by coldbox.system.orm.hibernate.BaseORMService
            extended by coldbox.system.orm.hibernate.VirtualEntityService
                extended by contentbox.model.system.SettingService

public class SettingService
extends coldbox.system.orm.hibernate.VirtualEntityService

******************************************************************************* 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:
  • inject = coldbox:setting:appMapping
true false
 any cache


Attributes:
  • inject = cachebox:default
true false
 any moduleSettings


Attributes:
  • inject = coldbox:setting:modules
true false
 any requestService


Attributes:
  • inject = coldbox:requestService
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

init

public init()
Constructor

Property Detail

appMapping

any appMapping

Attributes:
inject - coldbox:setting:appMapping
required - false
serializable - true
default -

cache

any cache

Attributes:
inject - cachebox:default
required - false
serializable - true
default -

moduleSettings

any moduleSettings

Attributes:
inject - coldbox:setting:modules
required - false
serializable - true
default -

requestService

any requestService

Attributes:
inject - coldbox:requestService
required - false
serializable - true
default -

settingsCacheKey

string settingsCacheKey

Attributes:
default -
serializable - true
required - false

Method Detail

GETAPPMAPPING

public any GETAPPMAPPING()


GETCACHE

public any GETCACHE()


GETMODULESETTINGS

public any GETMODULESETTINGS()


GETREQUESTSERVICE

public any GETREQUESTSERVICE()


GETSETTINGSCACHEKEY

public string GETSETTINGSCACHEKEY()


SETAPPMAPPING

public SettingService SETAPPMAPPING(any appMapping)

Parameters:
appMapping

SETCACHE

public SettingService SETCACHE(any cache)

Parameters:
cache

SETMODULESETTINGS

public SettingService SETMODULESETTINGS(any moduleSettings)

Parameters:
moduleSettings

SETREQUESTSERVICE

public SettingService SETREQUESTSERVICE(any requestService)

Parameters:
requestService

SETSETTINGSCACHEKEY

public SettingService SETSETTINGSCACHEKEY(string settingsCacheKey)

Parameters:
settingsCacheKey

activateCB

public any activateCB()
Mark cb as ready to serve


buildFileBrowserSettings

public struct buildFileBrowserSettings()
Build file browser settings structure


bulkSave

public any bulkSave([struct memento])
Bulk saving of options using a memento structure of options

Parameters:
memento

deleteDSNCreator

public boolean deleteDSNCreator()
Delete the dsn creator module


deleteInstaller

public boolean deleteInstaller()
Delete the installer module


flushSettingsCache

public any flushSettingsCache()
flush settings cache


getAllForExport

public array getAllForExport()
Get all data prepared for export


getAllSettings

public any getAllSettings([any asStruct='false'])
Get all settings

Parameters:
asStruct

getSetting

public any getSetting(any name, [any defaultValue])
Get a setting

Parameters:
name
defaultValue

importFromData

public string importFromData(any importData, [boolean override='false'], [any importLog])
Import data from an array of structures of settings

Parameters:
importData
override
importLog

importFromFile

public string importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file. Returns the import log

Parameters:
importFile
override

isCBReady

public boolean isCBReady()
Check if contentbox has been installed by checking if there are no settings and no cb_active ONLY


isInstallationPresent

public struct isInstallationPresent()
Check if the installer and dsn creator modules are present


search

public struct search([any search=''], [any max='0'], [any offset='0'], [any sortOrder='name asc'])
setting search returns struct with keys [settings,count]

Parameters:
search
max
offset
sortOrder

ContentBox Core API 1.6.0