contentbox.modules.contentbox-ui.modules.contentbox-sitemap.handlers

Class main

lucee.Component
    extended by contentbox.modules.contentbox-ui.modules.contentbox-sitemap.handlers.main

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manages the creations of dynamic sitemaps in ContentBox

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


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


    • access = public
    • returntype = any
    • inject = id:contentService@contentbox
    true false
    any entryService


    • access = public
    • returntype = any
    • inject = id:entryService@contentbox
    true false
    any pageService


    • access = public
    • returntype = any
    • inject = id:pageService@contentbox
    true false
    any settingService


    • access = public
    • returntype = any
    • inject = id:settingService@contentbox
    true false
    Method Summary
    private struct _index([any event], [any rc], [any prc])
         Single entry point, outputs the sitemap according to the incoming `rc.
    any index([any event], [any rc], [any prc])
         Sitemap Wrapper.
    any preHandler([any event], [any rc], [any prc], [any action], [any eventArguments])
         Executes before all handler actions.
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    CBHelper

    property any CBHelper

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

    contentService

    property any contentService

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

    entryService

    property any entryService

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

    pageService

    property any pageService

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

    settingService

    property any settingService

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

    Method Detail

    _index

    private struct _index([any event], [any rc], [any prc])

    Single entry point, outputs the sitemap according to the incoming `rc.format`

    Parameters:
    event
    rc
    prc
    Returns:
    { data, contentType }

    index

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

    Sitemap Wrapper

    Parameters:
    event
    rc
    prc

    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