contentbox.model.menu.providers

Class ContentProvider

railo-context.Component
        extended by contentbox.model.menu.providers.BaseProvider
            extended by contentbox.model.menu.providers.ContentProvider
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    All Implemented Interfaces:
    IMenuItemProvider

    ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Provider for Content-type menu items

    Property Summary
    type property default serializable required
    any CBHelper


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


    • inject = id:contentService@cb
    true false
    any requestService


    • 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.model.menu.providers.BaseProvider
    getDescription, getEntityName, getIconClass, getName, getRenderer, getType, setDescription, setEntityName, setIconClass, setName, setRenderer, setType
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    CBHelper

    property any CBHelper

    Attributes:
    required - false
    inject - id:CBHelper@cb
    serializable - true

    contentService

    property any contentService

    Attributes:
    required - false
    inject - id:contentService@cb
    serializable - true

    requestService

    property any requestService

    Attributes:
    required - false
    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