contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers

Class baseContentHandler

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler
        extended by coldbox.system.RestHandler
          extended by cborm.models.resources.BaseHandler
            extended by contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
              extended by contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseContentHandler
Direct Known Subclasses:
contentStore , entries , pages

Base handler for content based API handlers

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 authorService


    • access = public
    • returntype = any
    • inject = authorService@contentbox
    true false
    any categoryService


    • access = public
    • returntype = any
    • inject = categoryService@contentbox
    true false
    any contentService


    • access = public
    • returntype = any
    • inject = ContentService@contentbox
    true false
    any customFieldService


    • access = public
    • returntype = any
    • inject = customFieldService@contentbox
    true false
    Method Summary
    any preHandler([any event], [any rc], [any prc], [any action], [any eventArguments])
         Executes before all handler actions.
    private any save([any event], [any rc], [any prc], [struct populate='[runtime expression]'], [struct validate='[runtime expression]'], [string saveMethod='[runtime expression]'], [string contentType=''])
         Shared method for create and update to be DRY.
    any show([any event], [any rc], [any prc])
         Show a content item using an incoming slug or id.
     
    Methods inherited from class contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
    autoCast, create, delete, getByIdOrSlugOrFail, getMaxRows, getPageOffset, getSiteByIdOrSlugOrFail, index, newCriteria, update
     
    Methods inherited from class cborm.models.resources.BaseHandler
    None
     
    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

    authorService

    property any authorService

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

    categoryService

    property any categoryService

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

    contentService

    property any contentService

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

    customFieldService

    property any customFieldService

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

    Method Detail

    preHandler

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

    Executes before all handler actions

    Parameters:
    event
    rc
    prc
    action
    eventArguments

    save

    private any save([any event], [any rc], [any prc], [struct populate='[runtime expression]'], [struct validate='[runtime expression]'], [string saveMethod='[runtime expression]'], [string contentType=''])

    Shared method for create and update to be DRY

    Parameters:
    event
    rc
    prc
    populate - Population arguments
    validate - Validation arguments
    saveMethod - The method to use for saving entities
    contentType

    show

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

    Show a content item using an incoming slug or id

    Overrides:
    show in class baseHandler
    Parameters:
    event
    rc
    prc