contentbox.models.menu.providers

Class ContentProvider

lucee.Component
    extended by contentbox.models.menu.providers.BaseProvider
      extended by contentbox.models.menu.providers.ContentProvider
All Implemented Interfaces:
IMenuItemProvider

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Provider for Content-type menu items

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    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 requestService


    • access = public
    • returntype = any
    • inject = coldbox:requestService
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getAdminTemplate(any menuItem, struct options='[runtime expression]')
         Retrieves template for use in admin screens for this type of menu item provider.
    string getCBHelper()
    string getContentService()
    string getDisplayTemplate(any menuItem, struct options='[runtime expression]')
         Retrieves template for use in rendering menu item on the site.
    string getRequestService()
    any setCBHelper(any CBHelper)
    any setContentService(any contentService)
    any setRequestService(any requestService)
     
    Methods inherited from class contentbox.models.menu.providers.BaseProvider
    getDescription, getEntityName, getIconClass, getName, getRenderer, getType, setDescription, setEntityName, setIconClass, setName, setRenderer, setType
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    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

    requestService

    property any requestService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - coldbox:requestService
    serializable - true

    Method Detail

    getAdminTemplate

    public string getAdminTemplate(any menuItem, struct options='[runtime expression]')

    Retrieves template for use in admin screens for this type of menu item provider

    Specified by:
    getAdminTemplate in interface IMenuItemProvider
    Parameters:
    menuItem - The menu item object
    options - Additional arguments to be used in the method

    getCBHelper

    public string getCBHelper()


    getContentService

    public string getContentService()


    getDisplayTemplate

    public string getDisplayTemplate(any menuItem, struct options='[runtime expression]')

    Retrieves template for use in rendering menu item on the site

    Specified by:
    getDisplayTemplate in interface IMenuItemProvider
    Parameters:
    menuItem - The menu item object
    options - Additional arguments to be used in the method

    getRequestService

    public string getRequestService()


    setCBHelper

    public any setCBHelper(any CBHelper)

    Parameters:
    CBHelper

    setContentService

    public any setContentService(any contentService)

    Parameters:
    contentService

    setRequestService

    public any setRequestService(any requestService)

    Parameters:
    requestService