contentbox.modules.contentbox-admin.handlers

Class settings

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler
        extended by coldbox.system.RestHandler
          extended by contentbox.modules.contentbox-admin.handlers.baseHandler
            extended by contentbox.modules.contentbox-admin.handlers.settings

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manage system settings

Class Attributes:
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any LoginTrackerService


    • access = public
    • returntype = any
    • inject = LoginTrackerService@contentbox
    true false
    any editorService


    • access = public
    • returntype = any
    • inject = editorService@contentbox
    true false
    any mailService


    • access = public
    • returntype = any
    • inject = mailservice@cbMailservices
    true false
    any markdownEditor


    • access = public
    • returntype = any
    • inject = markdownEditor@contentbox-markdowneditor
    true false
    any mediaService


    • access = public
    • returntype = any
    • inject = mediaService@contentbox
    true false
    any pageService


    • access = public
    • returntype = any
    • inject = pageService@contentbox
    true false
    any settingsService


    • access = public
    • returntype = any
    • inject = settingService@contentbox
    true false
    any siteService


    • access = public
    • returntype = any
    • inject = siteService@contentbox
    true false
    any twoFactorService


    • access = public
    • returntype = any
    • inject = twoFactorService@contentbox
    true false
    Method Summary
    any authLogs([any event], [any rc], [any prc])
         Display the auth logs manager.
    any emailTest([any event], [any rc], [any prc])
         Email Testing of settings.
    any export([any event], [any rc], [any prc])
         Export a setting.
    any exportAll([any event], [any rc], [any prc])
         Export multiple settings.
    any flushCache([any event], [any rc], [any prc])
         Flush settings cache.
    any flushSingletons([any event], [any rc], [any prc])
         Flush WireBox singletons.
    any importAll([any event], [any rc], [any prc])
         Import all settings from a file packet.
    any index([any event], [any rc], [any prc])
         Settings manager.
    any mappingDump([any event], [any rc], [any prc])
         WireBox mapping dump.
    any raw([any event], [any rc], [any prc])
         Raw settings manager.
    any rawtable([any event], [any rc], [any prc])
         Present the raw settings table.
    any remove([any event], [any rc], [any prc])
         Remove a setting.
    any save([any event], [any rc], [any prc])
         Save settings.
    any saveRaw([any event], [any rc], [any prc])
         Save all raw settings.
    any truncateAuthLogs([any event], [any rc], [any prc])
         truncate all auth logs.
    any viewCached([any event], [any rc], [any prc])
         View settings cached data.
     
    Methods inherited from class contentbox.modules.contentbox-admin.handlers.baseHandler
    getMaxRows, getPageOffset
     
    Methods inherited from class coldbox.system.RestHandler
    aroundHandler, onAnyOtherException, onAuthenticationFailure, onAuthorizationFailure, onEntityNotFoundException, onError, onExpectationFailed, onInvalidHTTPMethod, onInvalidRoute, onMissingAction, onValidationException
     
    Methods inherited from class coldbox.system.EventHandler
    _actionExists, _actionMetadata, _privateInvoker, init, onHandlerDIComplete
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    announce, announceInterception, async, back, externalView, forAttribute, getCache, getCachebox, getColdBoxSetting, getController, getDateTimeHelper, getEnv, getFlash, getFlow, getInstance, getIsoTime, getJsonUtil, getLog, getLogBox, getModuleConfig, getModuleSettings, getRenderer, getRequestCollection, getRequestContext, getRootWireBox, getSetting, getSystemProperty, getSystemSetting, getUserSessionIdentifier, getWirebox, ifNull, ifPresent, inDebugMode, includeUDF, isDevelopment, isProduction, isTesting, layout, listen, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populate, populateModel, relocate, renderExternalView, renderLayout, renderview, runEvent, runRoute, setCachebox, setController, setEnv, setFlash, setFlow, setJsonUtil, setLog, setLogBox, setSetting, setWirebox, settingExists, throwIf, throwUnless, toJson, unless, view, when
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    LoginTrackerService

    property any LoginTrackerService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - LoginTrackerService@contentbox
    serializable - true

    editorService

    property any editorService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - editorService@contentbox
    serializable - true

    mailService

    property any mailService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - mailservice@cbMailservices
    serializable - true

    markdownEditor

    property any markdownEditor

    Attributes:
    access - public
    required - false
    returntype - any
    inject - markdownEditor@contentbox-markdowneditor
    serializable - true

    mediaService

    property any mediaService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - mediaService@contentbox
    serializable - true

    pageService

    property any pageService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - pageService@contentbox
    serializable - true

    settingsService

    property any settingsService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - settingService@contentbox
    serializable - true

    siteService

    property any siteService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - siteService@contentbox
    serializable - true

    twoFactorService

    property any twoFactorService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - twoFactorService@contentbox
    serializable - true

    Method Detail

    authLogs

    public any authLogs([any event], [any rc], [any prc])

    Display the auth logs manager

    Parameters:
    event
    rc
    prc
    Returns:
    html

    emailTest

    public any emailTest([any event], [any rc], [any prc])

    Email Testing of settings

    Parameters:
    event
    rc
    prc
    Returns:
    json

    export

    public any export([any event], [any rc], [any prc])

    Export a setting

    Parameters:
    event
    rc
    prc

    exportAll

    public any exportAll([any event], [any rc], [any prc])

    Export multiple settings

    Parameters:
    event
    rc
    prc

    flushCache

    public any flushCache([any event], [any rc], [any prc])

    Flush settings cache

    Parameters:
    event
    rc
    prc

    flushSingletons

    public any flushSingletons([any event], [any rc], [any prc])

    Flush WireBox singletons

    Parameters:
    event
    rc
    prc

    importAll

    public any importAll([any event], [any rc], [any prc])

    Import all settings from a file packet

    Parameters:
    event
    rc
    prc

    index

    public any index([any event], [any rc], [any prc])

    Settings manager

    Parameters:
    event
    rc
    prc
    Returns:
    html

    mappingDump

    public any mappingDump([any event], [any rc], [any prc])

    WireBox mapping dump

    Parameters:
    event
    rc
    prc
    Returns:
    html

    raw

    public any raw([any event], [any rc], [any prc])

    Raw settings manager

    Parameters:
    event
    rc
    prc
    Returns:
    html

    rawtable

    public any rawtable([any event], [any rc], [any prc])

    Present the raw settings table

    Parameters:
    event
    rc
    prc
    Returns:
    html

    remove

    public any remove([any event], [any rc], [any prc])

    Remove a setting

    Parameters:
    event
    rc
    prc

    save

    public any save([any event], [any rc], [any prc])

    Save settings

    Parameters:
    event
    rc
    prc

    saveRaw

    public any saveRaw([any event], [any rc], [any prc])

    Save all raw settings

    Parameters:
    event
    rc
    prc

    truncateAuthLogs

    public any truncateAuthLogs([any event], [any rc], [any prc])

    truncate all auth logs

    Parameters:
    event
    rc
    prc

    viewCached

    public any viewCached([any event], [any rc], [any prc])

    View settings cached data

    Parameters:
    event
    rc
    prc
    Returns:
    html