lucee.Componentcontentbox.models.BaseEntityMethods
contentbox.models.BaseEntity
contentbox.models.menu.Menu
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Core Menu Entity
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
ORMService
|
true
|
false
|
|
date
|
createdDate
|
true
|
false
|
|
any
|
isDeleted
|
false
|
true
|
false
|
any
|
listClass
|
true
|
false
|
|
any
|
listType
|
ul
|
true
|
false
|
any
|
menuClass
|
true
|
false
|
|
any
|
menuID
|
true
|
false
|
|
any
|
menuItemService
|
true
|
false
|
|
array
|
menuItems
|
true
|
false
|
|
any
|
menuService
|
true
|
false
|
|
date
|
modifiedDate
|
true
|
false
|
|
any
|
site
|
true
|
false
|
|
any
|
slug
|
true
|
false
|
|
any
|
title
|
true
|
false
|
Constructor Summary | |
---|---|
init()
constructor. |
Method Summary | |
---|---|
Menu
|
addMenuItem(any menuItem)
|
private array
|
createMenuItems(array rawData)
Recursive function to build menu items hierarchy from raw data. |
string
|
getListClass()
|
string
|
getListType()
|
string
|
getMenuClass()
|
string
|
getMenuID()
|
string
|
getMenuItemService()
|
string
|
getMenuItems()
|
string
|
getMenuService()
|
string
|
getORMService()
|
array
|
getRootMenuItems()
Retrieves root menu items (only items with no parents). |
string
|
getSite()
|
any
|
getSiteId()
Shortcut to get the site id. |
any
|
getSiteName()
Shortcut to get the site name. |
any
|
getSiteSlug()
Shortcut to get the site slug. |
struct
|
getSiteSnapshot()
Build a site snapshot. |
string
|
getSlug()
|
string
|
getTitle()
|
boolean
|
hasMenuItem([any menuItem])
|
boolean
|
hasSite([any site])
|
array
|
populateMenuItems(array rawData)
Creates menu items from raw data objects and attaches them to this menu. |
boolean
|
removeMenuItem(any menuItem)
|
any
|
setListClass(any listClass)
|
any
|
setListType(any listType)
|
any
|
setMenuClass(any menuClass)
|
any
|
setMenuID(any menuID)
|
any
|
setMenuItemService(any menuItemService)
|
Menu
|
setMenuItems(array menuItems)
|
any
|
setMenuService(any menuService)
|
any
|
setORMService(any ORMService)
|
any
|
setSite(any site)
|
any
|
setSlug(any slug)
|
any
|
setTitle(any title)
|
Methods inherited from class contentbox.models.BaseEntity |
---|
getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate |
Methods inherited from class contentbox.models.BaseEntityMethods |
---|
appendToMemento, appendToMementoProfile, arrayWrap, getDisplayCreatedDate, getDisplayModifiedDate, getEntityName, getId, includeMixin, isLoaded, preInsert, preUpdate |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- provider:entityservicepersistent
- falseserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- createdDatenotnull
- trueormtype
- timestampupdate
- falsepersistent
- trueserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- isDeletednotnull
- trueormtype
- booleanpersistent
- trueserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- listClassormtype
- stringlength
- 160serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- listTypeormtype
- stringlength
- 20serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- menuClassormtype
- stringlength
- 160serializable
- trueaccess
- publicrequired
- falsefieldtype
- idreturntype
- anycolumn
- menuIDormtype
- stringupdate
- falsegenerator
- uuidlength
- 36serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- provider:menuItemService@contentboxpersistent
- falseserializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphansingularname
- menuItemfkcolumn
- FK_menuIDserializable
- truecfc
- contentbox.models.menu.item.BaseMenuItemlazy
- extraaccess
- publicrequired
- falsereturntype
- anyinject
- provider:menuService@contentboxpersistent
- falseserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- modifiedDatenotnull
- trueormtype
- timestamppersistent
- trueserializable
- trueaccess
- publicrequired
- falsefieldtype
- many-to-onereturntype
- anyfetch
- joinnotnull
- truefkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.system.Sitelazy
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- slugnotnull
- trueormtype
- stringindex
- idx_menusluglength
- 200serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- titlenotnull
- trueormtype
- stringindex
- idx_menutitlelength
- 200serializable
- trueMethod Detail |
---|
menuItem
Recursive function to build menu items hierarchy from raw data
rawData
- The raw data definitions for the menu itemsRetrieves root menu items (only items with no parents)
Shortcut to get the site id
Shortcut to get the site name
Shortcut to get the site slug
Build a site snapshot
menuItem
site
Creates menu items from raw data objects and attaches them to this menu.
rawData
- The raw data from which to create menu itemsmenuItem
listClass
listType
menuClass
menuID
menuItemService
menuItems
menuService
ORMService
site
slug
title