contentbox.modules.contentbox-admin.handlers

Class tools

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

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

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


    • access = public
    • returntype = any
    • inject = HTMLHelper@coldbox
    true false
    any moduleService


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


    • access = public
    • returntype = any
    • inject = roleService@contentbox
    true false
    any staticExporter


    • access = public
    • returntype = any
    • inject = staticExporter@contentbox
    true false
    any templateService


    • access = public
    • returntype = any
    • inject = emailtemplateService@contentbox
    true false
    any themeService


    • access = public
    • returntype = any
    • inject = themeService@contentbox
    true false
    any widgetService


    • access = public
    • returntype = any
    • inject = widgetService@contentbox
    true false
    Method Summary
    any doCBImport([any event], [any rc], [any prc])
         Import action.
    any doCBPreImport([any event], [any rc], [any prc])
         Pre Import checks.
    any doDataImport([any event], [any rc], [any prc])
         Do a data import.
    any doExport([any event], [any rc], [any prc])
         Process a real export.
    any doStaticSite([any event], [any rc], [any prc])
         Export a static site.
    any exporter([any event], [any rc], [any prc])
         Show the exporter console.
    any importer([any event], [any rc], [any prc])
         Import Into ContentBox.
    any preHandler([any event], [any action], [any eventArguments], [any rc], [any prc])
    private struct prepareExportTargets(struct rc)
         Looks at incoming export variables and prepares correct target elements from.
    any previewExport([any event], [any rc], [any prc])
         Preview of the export.
     
    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

    HTMLHelper

    property any HTMLHelper

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

    moduleService

    property any moduleService

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

    roleService

    property any roleService

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

    staticExporter

    property any staticExporter

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

    templateService

    property any templateService

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

    themeService

    property any themeService

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

    widgetService

    property any widgetService

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

    Method Detail

    doCBImport

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

    Import action

    Parameters:
    event
    rc
    prc

    doCBPreImport

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

    Pre Import checks

    Parameters:
    event
    rc
    prc

    doDataImport

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

    Do a data import

    Parameters:
    event
    rc
    prc

    doExport

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

    Process a real export

    Parameters:
    event
    rc
    prc

    doStaticSite

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

    Export a static site

    Parameters:
    event
    rc
    prc

    exporter

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

    Show the exporter console

    Parameters:
    event
    rc
    prc

    importer

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

    Import Into ContentBox

    Parameters:
    event
    rc
    prc

    preHandler

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

    Parameters:
    event
    action
    eventArguments
    rc
    prc

    prepareExportTargets

    private struct prepareExportTargets(struct rc)

    Looks at incoming export variables and prepares correct target elements from the RC. Prefix is `EXPORT_`

    Parameters:
    rc

    previewExport

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

    Preview of the export

    Parameters:
    event
    rc
    prc