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

Class authors

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

RESTFul CRUD for Authors Only tokens with the `AUTHOR_ADMIN` can interact with this endpoint

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


    • access = public
    • returntype = any
    • inject = AuthorService@contentbox
    true false
    any permissionService


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


    • access = public
    • returntype = any
    • inject = roleService@contentbox
    true false
    Method Summary
    any create([any event], [any rc], [any prc])
         Create an author in ContentBox.
    any delete([any event], [any rc], [any prc])
         Delete an author using an id.
    any index([any event], [any rc], [any prc])
         Display all authors according to query options.
    any show([any event], [any rc], [any prc])
         Show an author using the id.
    any update([any event], [any rc], [any prc])
         Update an existing author.
     
    Methods inherited from class contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
    autoCast, getByIdOrSlugOrFail, getMaxRows, getPageOffset, getSiteByIdOrSlugOrFail, newCriteria
     
    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

    ormService

    property any ormService

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

    permissionService

    property any permissionService

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

    roleService

    property any roleService

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

    Method Detail

    create

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

    Create an author in ContentBox

    Overrides:
    create in class baseHandler
    Parameters:
    event
    rc
    prc

    delete

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

    Delete an author using an id

    Overrides:
    delete in class baseHandler
    Parameters:
    event
    rc
    prc

    index

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

    Display all authors according to query options

    Overrides:
    index in class baseHandler
    Parameters:
    event
    rc
    prc

    show

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

    Show an author using the id

    Overrides:
    show in class baseHandler
    Parameters:
    event
    rc
    prc

    update

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

    Update an existing author

    Overrides:
    update in class baseHandler
    Parameters:
    event
    rc
    prc