contentbox.modules.contentbox-admin.handlers

Class categories

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

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

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 categoryService


    • access = public
    • returntype = any
    • inject = categoryService@contentbox
    true false
    Method Summary
    any export([any event], [any rc], [any prc])
         Export a category.
    any exportAll([any event], [any rc], [any prc])
         Export all categories.
    any importAll([any event], [any rc], [any prc])
         Import all categories.
    any index([any event], [any rc], [any prc])
         Manage categories.
    any preHandler([any event], [any action], [any eventArguments], [any rc], [any prc])
         Pre handler.
    any remove([any event], [any rc], [any prc])
         Remove categories.
    any save([any event], [any rc], [any prc])
         Save categories.
    any search([any event], [any rc], [any prc])
         Search categories.
     
    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

    categoryService

    property any categoryService

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

    Method Detail

    export

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

    Export a category

    Parameters:
    event
    rc
    prc

    exportAll

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

    Export all categories

    Parameters:
    event
    rc
    prc

    importAll

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

    Import all categories

    Parameters:
    event
    rc
    prc

    index

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

    Manage categories

    Parameters:
    event
    rc
    prc

    preHandler

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

    Pre handler

    Parameters:
    event
    action
    eventArguments
    rc
    prc

    remove

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

    Remove categories

    Parameters:
    event
    rc
    prc

    save

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

    Save categories

    Parameters:
    event
    rc
    prc

    search

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

    Search categories

    Parameters:
    event
    rc
    prc
    Returns:
    json