contentbox.modules.contentbox-admin.handlers

Class comments

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

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

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


    • access = public
    • returntype = any
    • inject = commentService@contentbox
    true false
    any settingsService


    • access = public
    • returntype = any
    • inject = settingService@contentbox
    true false
    Method Summary
    any doStatusUpdate([any event], [any rc], [any prc])
         Submit a status udpate on a comment.
    any editor([any event], [any rc], [any prc])
         Show the comment editor.
    any index([any event], [any rc], [any prc])
         Main display of comments.
    any moderate([any event], [any rc], [any prc])
         Show the comment moderator.
    any pager([any event], [any rc], [any prc], [any contentID='all'], [any max='0'], [any pagination='true'])
         Comment Pager.
    any preHandler([any event], [any action], [any eventArguments], [any rc], [any prc])
         Pre handler.
    any quickLook([any event], [any rc], [any prc])
         Comment quick look.
    any remove([any event], [any rc], [any prc])
         Remove comments from the database.
    any removeAllModerated([any event], [any rc], [any prc])
         Remove all Moderated comments.
    any save([any event], [any rc], [any prc])
         Save a comment.
    any saveSettings([any event], [any rc], [any prc])
         Save the comment settings.
    any settings([any event], [any rc], [any prc])
         Show comment settings panel.
     
    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

    commentService

    property any commentService

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

    settingsService

    property any settingsService

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

    Method Detail

    doStatusUpdate

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

    Submit a status udpate on a comment

    Parameters:
    event - true
    rc - true
    prc - true

    editor

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

    Show the comment editor

    Parameters:
    event - true
    rc - true
    prc - true

    index

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

    Main display of comments

    Parameters:
    event - true
    rc - true
    prc - true

    moderate

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

    Show the comment moderator

    Parameters:
    event - true
    rc - true
    prc - true

    pager

    public any pager([any event], [any rc], [any prc], [any contentID='all'], [any max='0'], [any pagination='true'])

    Comment Pager

    Parameters:
    event - true
    rc - true
    prc - true
    contentID - The content ID to filter the comments on, defaults to all
    max - Max number of comments to show, shows the global default
    pagination - Turn pagination on or off

    preHandler

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

    Pre handler

    Parameters:
    event - true
    action - true
    eventArguments - true
    rc - true
    prc - true

    quickLook

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

    Comment quick look

    Parameters:
    event - true
    rc - true
    prc - true
    Returns:
    HTML

    remove

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

    Remove comments from the database

    Parameters:
    event - true
    rc - true
    prc - true
    Returns:
    JSON or relocation

    removeAllModerated

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

    Remove all Moderated comments

    Parameters:
    event - true
    rc - true
    prc - true
    Returns:
    JSON or relocation

    save

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

    Save a comment

    Parameters:
    event - true
    rc - true
    prc - true

    saveSettings

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

    Save the comment settings

    Parameters:
    event
    rc
    prc

    settings

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

    Show comment settings panel

    Parameters:
    event - true
    rc - true
    prc - true