contentbox.models.menu.item

Class ContentMenuItem

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.menu.item.BaseMenuItem
        extended by contentbox.models.menu.item.ContentMenuItem

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- A Content-based Menu Item

Class Attributes:
  • discriminatorvalue : Content
    •  
  • entityname : cbContentMenuItem
    •  
  • table : cb_menuItem
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : true
    •  
    Property Summary
    type property default serializable required
    any contentService


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


    • access = public
    • returntype = any
    • notnull = false
    • ormtype = string
    		 true false
    any provider


    • access = public
    • returntype = any
    • inject = contentbox.models.menu.providers.ContentProvider
    • persistent = false
    		 true false
    any target


    • access = public
    • returntype = any
    • notnull = false
    • ormtype = string
    		 true false
    any urlClass


    • access = public
    • returntype = any
    • notnull = false
    • ormtype = string
    		 true false
    Method Summary
    boolean canDisplay(struct options='[runtime expression]')
         Available precheck to determine display-ability of menu item.
    string getContentService()
    string getContentSlug()
    struct getMemento()
         Get a flat representation of this menu item.
    string getProvider()
    string getTarget()
    string getUrlClass()
    any setContentService(any contentService)
    any setContentSlug(any contentSlug)
    any setProvider(any provider)
    any setTarget(any target)
    any setUrlClass(any urlClass)
     
    Methods inherited from class contentbox.models.menu.item.BaseMenuItem
    addChild, getActive, getAttributesAsString, getChildren, getCreatedDate, getData, getIsDeleted, getItemClass, getLabel, getMenu, getMenuItemID, getMenuItemService, getMenuType, getModifiedDate, getParent, getTitle, hasChild, hasMenu, hasParent, init, removeChild, setActive, setChildren, setCreatedDate, setData, setIsDeleted, setItemClass, setLabel, setMenu, setMenuItemService, setMenuType, setModifiedDate, setParent, setTitle
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    getBaseMemento, getDisplayCreatedDate, getDisplayModifiedDate, isLoaded, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None
    Property Detail

    contentService

    property any contentService

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

    contentSlug

    property any contentSlug

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    ormtype - string
    serializable - true

    provider

    property any provider

    Attributes:
    access - public
    required - false
    returntype - any
    inject - contentbox.models.menu.providers.ContentProvider
    persistent - false
    serializable - true

    target

    property any target

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    ormtype - string
    serializable - true

    urlClass

    property any urlClass

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    ormtype - string
    serializable - true
    Method Detail

    canDisplay

    public boolean canDisplay(struct options='[runtime expression]')

    Available precheck to determine display-ability of menu item

    Overrides:
    canDisplay in class BaseMenuItem
    Parameters:
    options - Additional arguments to be used in the method

    getContentService

    public string getContentService()

    getContentSlug

    public string getContentSlug()

    getMemento

    public struct getMemento()

    Get a flat representation of this menu item

    Overrides:
    getMemento in class BaseMenuItem

    getProvider

    public string getProvider()

    getTarget

    public string getTarget()

    getUrlClass

    public string getUrlClass()

    setContentService

    public any setContentService(any contentService)

    Parameters:
    contentService

    setContentSlug

    public any setContentSlug(any contentSlug)

    Parameters:
    contentSlug

    setProvider

    public any setProvider(any provider)

    Parameters:
    provider

    setTarget

    public any setTarget(any target)

    Parameters:
    target

    setUrlClass

    public any setUrlClass(any urlClass)

    Parameters:
    urlClass