contentbox.modules.contentbox-admin.handlers

Class baseContentHandler

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.baseContentHandler
Direct Known Subclasses:
contentStore , entries , pages

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- The base content handler which is used by the entries, contentstore and pages handlers to provide uniformity

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
    any editorService


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


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


    • access = public
    • returntype = any
    • inject = themeService@contentbox
    true false
    Method Summary
    any bulkStatus([any event], [any rc], [any prc], any relocateTo)
         Change the status of many content objects.
    any changeOrder([any event], [any rc], [any prc])
         Change order of content items.
    any clone([any event], [any rc], [any prc], any relocateTo)
         Clone Content.
    any contentTable([any event], [any rc], [any prc])
         Content table.
    any editor([any event], [any rc], [any prc])
         Show the editor.
    any editorSelector([any event], [any rc], [any prc], [any sortOrder])
         Called by editors to bring a modal selector of content.
    any export([any event], [any rc], [any prc])
         Export a piece of content.
    any exportAll([any event], [any rc], [any prc])
         Export All or Selected Content.
    private any getUserDefaultEditor(any author)
         Get the user's default editor with some logic.
    any importAll([any event], [any rc], [any prc], any relocateTo)
         Import content.
    any index([any event], [any rc], [any prc])
         Show Content.
    any pager([any event], [any rc], [any prc], [any authorID='all'], [any parent], [any max='0'], [any pagination='true'], [any latest='false'])
         Content pager viewlet.
    any preHandler([any event], [any action], [any eventArguments], [any rc], [any prc])
         Pre Handler interceptions.
    any quickLook([any event], [any rc], [any prc])
         Content quick look.
    any remove([any event], [any rc], [any prc], any relocateTo)
         Remove one or more pieces of content.
    any save([any event], [any rc], [any prc], any adminPermission, any relocateTo)
         Save Content Abstraction.
    any slugify([any event], [any rc], [any prc])
         Slugify helper for content slugs.
     
    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

    authorService

    property any authorService

    -------------------------------------------------------------------------- Core Dependencies --------------------------------------------------------------------------

    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

    editorService

    property any editorService

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

    templateService

    property any templateService

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

    themeService

    property any themeService

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

    Method Detail

    bulkStatus

    public any bulkStatus([any event], [any rc], [any prc], any relocateTo)

    Change the status of many content objects

    Parameters:
    event
    rc
    prc
    relocateTo - Where to relocate when done updating

    changeOrder

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

    Change order of content items

    Parameters:
    event
    rc
    prc
    Returns:
    json

    clone

    public any clone([any event], [any rc], [any prc], any relocateTo)

    Clone Content

    Parameters:
    event
    rc
    prc
    relocateTo - Where to relocate to when saving is done

    contentTable

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

    Content table

    Parameters:
    event
    rc
    prc
    Returns:
    HTML

    editor

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

    Show the editor

    Parameters:
    event
    rc
    prc

    editorSelector

    public any editorSelector([any event], [any rc], [any prc], [any sortOrder])

    Called by editors to bring a modal selector of content

    Parameters:
    event
    rc
    prc
    sortOrder - The sorting for the results table
    Returns:
    html

    export

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

    Export a piece of content

    Parameters:
    event
    rc
    prc
    Returns:
    json

    exportAll

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

    Export All or Selected Content

    Parameters:
    event
    rc
    prc

    getUserDefaultEditor

    private any getUserDefaultEditor(any author)

    Get the user's default editor with some logic

    Parameters:
    author - The author object to get the default editor from
    Returns:
    The default editor in string format

    importAll

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

    Import content

    Parameters:
    event
    rc
    prc
    relocateTo - Where to relocate to when saving is done

    index

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

    Show Content

    Parameters:
    event
    rc
    prc

    pager

    public any pager([any event], [any rc], [any prc], [any authorID='all'], [any parent], [any max='0'], [any pagination='true'], [any latest='false'])

    Content pager viewlet. Used for embedding a table visualizer of content according to arguments

    Parameters:
    event
    rc
    prc
    authorID - The author to filter the viewlet on. By default we show all content by all authors
    parent - Do we want to root the content at a specific parent not or not, by default we do not
    max - The maximum number of records to show, default is using the settings maxrows
    pagination - Show pagination caroussel or not, default is true
    latest - Show the latest content ordering or by natural ordering
    Returns:
    HTML

    preHandler

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

    Pre Handler interceptions

    Parameters:
    event
    action
    eventArguments
    rc
    prc

    quickLook

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

    Content quick look

    Parameters:
    event
    rc
    prc
    Returns:
    HTML

    remove

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

    Remove one or more pieces of content

    Parameters:
    event
    rc
    prc
    relocateTo - Where to relocate to when saving is done

    save

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

    Save Content Abstraction

    Parameters:
    event
    rc
    prc
    adminPermission - The admin permission(s) to verify in order to allow for publishing content.
    relocateTo - Where to relocate to when saving is done

    slugify

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

    Slugify helper for content slugs

    Parameters:
    event
    rc
    prc
    Returns:
    plain