contentbox.modules.contentbox-admin.handlers

Class modules

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.modules

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

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


    • access = public
    • returntype = any
    • inject = moduleService@contentbox
    true false
    any routingService


    • access = public
    • returntype = any
    • inject = coldbox:routingService
    true false
    Method Summary
    any activate([any event], [any rc], [any prc])
         Activate a module.
    any buildModuleLink([any event], [any rc], [any prc])
         Build Module Links.
    any deactivate([any event], [any rc], [any prc])
         Deactivate a module.
    any execute([any event], [any rc], [any prc])
         proxy a call to a module, all module calls are supposed to return content.
    any index([any event], [any rc], [any prc])
         Module Manager.
    any preHandler([any event], [any action], [any eventArguments], [any rc], [any prc])
    any remove([any event], [any rc], [any prc])
         Remove a module.
    any rescan([any event], [any rc], [any prc])
         Rescan all modules.
    any reset([any event], [any rc], [any prc])
         Reset all modules.
     
    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

    moduleService

    property any moduleService

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

    routingService

    property any routingService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - coldbox:routingService
    serializable - true

    Method Detail

    activate

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

    Activate a module

    Parameters:
    event
    rc
    prc

    buildModuleLink

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

    Build Module Links

    Parameters:
    event
    rc
    prc

    deactivate

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

    Deactivate a module

    Parameters:
    event
    rc
    prc

    execute

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

    proxy a call to a module, all module calls are supposed to return content This is used to proxy /cbadmin/{module} type of calls

    Parameters:
    event
    rc
    prc

    index

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

    Module Manager

    Parameters:
    event
    rc
    prc

    preHandler

    public any preHandler([any event], [any action], [any eventArguments], [any rc], [any prc])

    Parameters:
    event
    action
    eventArguments
    rc
    prc

    remove

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

    Remove a module

    Parameters:
    event
    rc
    prc

    rescan

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

    Rescan all modules

    Parameters:
    event
    rc
    prc

    reset

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

    Reset all modules

    Parameters:
    event
    rc
    prc