contentbox.modules.contentbox-admin.handlers

Class content

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler
        extended by contentbox.modules.contentbox-admin.handlers.baseHandler
          extended by contentbox.modules.contentbox-admin.handlers.content

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

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


    • access = public
    • returntype = any
    • inject = id:authorService@cb
    true false
    any CBHelper


    • access = public
    • returntype = any
    • inject = id:CBHelper@cb
    true false
    any contentService


    • access = public
    • returntype = any
    • inject = id:contentService@cb
    true false
    any contentStoreService


    • access = public
    • returntype = any
    • inject = id:contentStoreService@cb
    true false
    any statsService


    • access = public
    • returntype = any
    • inject = id:statsService@cb
    true false
    Method Summary
    any breakContentLink([any event], [any rc], [any prc])
         Break related content links.
    any contentByPublishedStatus([any event], [any rc], [any prc], [boolean showExpired='false'], [any author], [boolean offset='0'], [numeric max='25'], [boolean showHits='true'], [boolean colorCodings='true'], [boolean showPublishedStatus='true'], [boolean showAuthor='true'])
         This viewlet shows future or expired content using filters.
    any latestContentEdits([any event], [any rc], [any prc], [any author], [boolean isPublished], [numeric max='25'], [boolean showHits='true'], [boolean colorCodings='true'], [boolean showPublishedStatus='true'], [boolean showAuthor='true'])
         This viewlet shows latest content edits via arguments.
    any preview([any event], [any rc], [any prc])
         Quick Content Preview from editors.
    any relatedContentSelector([any event], [any rc], [any prc])
         Render the content selector from editors.
    any resetHits([any event], [any rc], [any prc])
         Reset Content Hits on one or more content items.
    any search([any event], [any rc], [any prc])
         Global Content Search.
    any showRelatedContentSelector([any event], [any rc], [any prc])
         Show the related content panel.
    any slugUnique([any event], [any rc], [any prc])
         Check if a slug is unique.
     
    Methods inherited from class contentbox.modules.contentbox-admin.handlers.baseHandler
    aroundHandler, onAuthenticationFailure, onAuthorizationFailure, onError, onExpectationFailed, onInvalidHTTPMethod, onMissingAction, routeNotFound
     
    Methods inherited from class coldbox.system.EventHandler
    _actionExists, _actionMetadata, _privateInvoker, getCachebox, getFlash, getLog, getLogBox, getWirebox, init, setCachebox, setFlash, setLog, setLogBox, setWirebox
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getDatasource, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    authorService

    property any authorService

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

    CBHelper

    property any CBHelper

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:CBHelper@cb
    serializable - true

    contentService

    property any contentService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:contentService@cb
    serializable - true

    contentStoreService

    property any contentStoreService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:contentStoreService@cb
    serializable - true

    statsService

    property any statsService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:statsService@cb
    serializable - true

    Method Detail

    breakContentLink

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

    Break related content links

    Parameters:
    event
    rc
    prc
    Returns:
    json

    contentByPublishedStatus

    public any contentByPublishedStatus([any event], [any rc], [any prc], [boolean showExpired='false'], [any author], [boolean offset='0'], [numeric max='25'], [boolean showHits='true'], [boolean colorCodings='true'], [boolean showPublishedStatus='true'], [boolean showAuthor='true'])

    This viewlet shows future or expired content using filters. By default it shows future published content

    Parameters:
    event
    rc
    prc
    showExpired - Show expired content, defaults to false (future published content)
    author - The optional author to look for latest edits only
    offset - The offset when doing pagination
    max - The maximum number of records, capped at 25 by default
    showHits - Show hit count on content item, defaults to true
    colorCodings - Show content row color codings
    showPublishedStatus - Show published status columns
    showAuthor - Show the author in the table
    Returns:
    html

    latestContentEdits

    public any latestContentEdits([any event], [any rc], [any prc], [any author], [boolean isPublished], [numeric max='25'], [boolean showHits='true'], [boolean colorCodings='true'], [boolean showPublishedStatus='true'], [boolean showAuthor='true'])

    This viewlet shows latest content edits via arguments

    Parameters:
    event
    rc
    prc
    author - The optional author to look for latest edits only
    isPublished - Boolean indicator if you need to search on all published states, only published, or only draft
    max - The maximum number of records, capped at 25 by default
    showHits - Show hit count on content item, defaults to true
    colorCodings - Show content row color codings
    showPublishedStatus - Show published status columns
    showAuthor - Show the author in the table
    Returns:
    html

    preview

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

    Quick Content Preview from editors

    Parameters:
    event
    rc
    prc
    Returns:
    html

    relatedContentSelector

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

    Render the content selector from editors

    Parameters:
    event
    rc
    prc
    Returns:
    html

    resetHits

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

    Reset Content Hits on one or more content items

    Parameters:
    event
    rc
    prc
    Returns:
    json

    search

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

    Global Content Search

    Parameters:
    event
    rc
    prc
    Returns:
    html

    showRelatedContentSelector

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

    Show the related content panel

    Parameters:
    event
    rc
    prc
    Returns:
    html

    slugUnique

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

    Check if a slug is unique

    Parameters:
    event
    rc
    prc
    Returns:
    json