contentbox.models.menu.item

Class SubMenuItem

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

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

Class Attributes:
  • discriminatorvalue : SubMenu
    •  
  • entityname : cbSubMenuItem
    •  
  • table : cb_menuItem
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : true
    •  
    Property Summary
    type property default serializable required
    any menuSlug


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


    • access = public
    • returntype = any
    • inject = contentbox.models.menu.providers.SubMenuProvider
    • persistent = false
    		 true false
    Method Summary
    boolean canDisplay(struct options='[runtime expression]')
         Available precheck to determine display-ability of menu item.
    struct getMemento()
         Get a flat representation of this menu item.
    string getMenuSlug()
    string getProvider()
    any setMenuSlug(any menuSlug)
    any setProvider(any provider)
     
    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

    menuSlug

    property any menuSlug

    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.SubMenuProvider
    persistent - false
    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

    getMemento

    public struct getMemento()

    Get a flat representation of this menu item

    Overrides:
    getMemento in class BaseMenuItem

    getMenuSlug

    public string getMenuSlug()

    getProvider

    public string getProvider()

    setMenuSlug

    public any setMenuSlug(any menuSlug)

    Parameters:
    menuSlug

    setProvider

    public any setProvider(any provider)

    Parameters:
    provider