BaseMenuItem

contentbox.models.menu.item

Class BaseMenuItem

lucee.Component
    contentbox.models.BaseEntityMethods
      contentbox.models.menu.item.BaseMenuItem

Direct Known Subclasses:

ContentMenuItem , FreeMenuItem , JSMenuItem , MediaMenuItem , SubMenuItem , URLMenuItem

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Base entity for all subclasses of Menu Items

Class Attributes:

entityname : cbMenuItem

cacheuse : read-write

table : cb_menuItem

synchronized : false

cachename : cbMenuItem

discriminatorcolumn : menuType

accessors : false

persistent : true

Property Summary
type	property	default	serializable	required
`any`	active access = public returntype = any ormtype = boolean	`true`	`true`	`false`
`array`	children access = public inverse = true fieldtype = one-to-many returntype = any cascade = all-delete-orphan batchsize = 25 singularname = child fkcolumn = FK_parentID cfc = BaseMenuItem lazy = extra		`true`	`false`
`date`	createdDate access = public returntype = any notnull = true ormtype = timestamp update = false index = idx_createDate		`true`	`false`
`any`	data access = public returntype = any notnull = false ormtype = string		`true`	`false`
`any`	isDeleted access = public dbdefault = 0 returntype = any notnull = true ormtype = boolean index = idx_deleted sqltype = bit	`false`	`true`	`false`
`any`	itemClass access = public returntype = any notnull = false ormtype = string length = 200		`true`	`false`
`any`	label access = public returntype = any notnull = false ormtype = string length = 200		`true`	`false`
`any`	menu access = public fieldtype = many-to-one returntype = any notnull = true fetch = join fkcolumn = FK_menuID cfc = contentbox.models.menu.Menu lazy = true		`true`	`false`
`any`	menuItemID access = public fieldtype = id returntype = any params = { allocationSize = 1, sequence = 'menuItemID_seq' } generator = native setter = no		`true`	`false`
`any`	menuItemService access = public returntype = any inject = menuItemService@cb persistent = false		`true`	`false`
`any`	menuType access = public insert = false returntype = any update = false		`true`	`false`
`date`	modifiedDate access = public returntype = any notnull = true ormtype = timestamp index = idx_modifiedDate		`true`	`false`
`any`	parent access = public fieldtype = many-to-one returntype = any fkcolumn = FK_parentID cfc = BaseMenuItem lazy = true		`true`	`false`
`any`	title access = public returntype = any notnull = true ormtype = string index = idx_menuitemtitle length = 200		`true`	`false`

Constructor Summary
init() constructor.

Method Summary
`any`	addChild(any child)
`boolean`	canDisplay(struct options='[runtime expression]') Available precheck to determine display-ability of menu item.
`string`	getActive()
`string`	getAttributesAsString() Get a handy, formatted string of attributes that are applicable for the current menu item.
`string`	getChildren()
`string`	getCreatedDate()
`string`	getData()
`string`	getIsDeleted()
`string`	getItemClass()
`string`	getLabel()
`struct`	getMemento([any excludes='']) Get a flat representation of this menu item.
`string`	getMenu()
`string`	getMenuItemID()
`string`	getMenuItemService()
`string`	getMenuType()
`string`	getModifiedDate()
`string`	getParent()
`string`	getTitle()
`boolean`	hasChild([any child])
`boolean`	hasMenu([any menu])
`boolean`	hasParent([any parent])
`boolean`	removeChild(any child)
`any`	setActive(any active)
`any`	setChildren(array children)
`any`	setCreatedDate(date createdDate)
`any`	setData(any data)
`any`	setIsDeleted(any isDeleted)
`any`	setItemClass(any itemClass)
`any`	setLabel(any label)
`any`	setMenu(any menu)
`any`	setMenuItemService(any menuItemService)
`any`	setMenuType(any menuType)
`any`	setModifiedDate(date modifiedDate)
`any`	setParent(any parent)
`any`	setTitle(any title)

Methods inherited from class `contentbox.models.BaseEntityMethods`
getBaseMemento, getDisplayCreatedDate, getDisplayModifiedDate, isLoaded, preInsert, preUpdate

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init()

constructor

Property Detail

active

property any active = [true]

Attributes:: access - public; required - false; returntype - any; ormtype - boolean; serializable - true

children

property array children

Attributes:: access - public; required - false; inverse - true; fieldtype - one-to-many; returntype - any; cascade - all-delete-orphan; batchsize - 25; singularname - child; fkcolumn - FK_parentID; serializable - true; cfc - BaseMenuItem; lazy - extra

createdDate

property date createdDate

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - timestamp; update - false; index - idx_createDate; serializable - true

data

property any data

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

isDeleted

property any isDeleted = [false]

Attributes:: access - public; required - false; dbdefault - 0; returntype - any; notnull - true; ormtype - boolean; index - idx_deleted; serializable - true; sqltype - bit

itemClass

property any itemClass

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

label

property any label

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

menuItemID

property any menuItemID

Attributes:: access - public; required - false; fieldtype - id; returntype - any; params - { allocationSize = 1, sequence = 'menuItemID_seq' }; generator - native; serializable - true; setter - no

menuItemService

property any menuItemService

Attributes:: access - public; required - false; returntype - any; inject - menuItemService@cb; persistent - false; serializable - true

menuType

property any menuType

Attributes:: access - public; required - false; insert - false; returntype - any; update - false; serializable - true

modifiedDate

property date modifiedDate

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - timestamp; index - idx_modifiedDate; serializable - true

parent

property any parent

Attributes:: access - public; required - false; fieldtype - many-to-one; returntype - any; fkcolumn - FK_parentID; serializable - true; cfc - BaseMenuItem; lazy - true

title

property any title

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - string; index - idx_menuitemtitle; length - 200; serializable - true

Method Detail

addChild

public any addChild(any child)

Parameters:: child

canDisplay

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

Available precheck to determine display-ability of menu item

Parameters:: options - Additional arguments to be used in the method

getActive

public string getActive()

getAttributesAsString

public string getAttributesAsString()

Get a handy, formatted string of attributes that are applicable for the current menu item

getChildren

public string getChildren()

getCreatedDate

public string getCreatedDate()

getData

public string getData()

getIsDeleted

public string getIsDeleted()

getItemClass

public string getItemClass()

getLabel

public string getLabel()

getMemento

public struct getMemento([any excludes=''])

Get a flat representation of this menu item

Parameters:: excludes - Exclude properties

getMenu

public string getMenu()

getMenuItemID

public string getMenuItemID()

getMenuItemService

public string getMenuItemService()

getMenuType

public string getMenuType()

getModifiedDate

public string getModifiedDate()

getParent

public string getParent()

getTitle

public string getTitle()

hasChild

public boolean hasChild([any child])

Parameters:: child

hasMenu

public boolean hasMenu([any menu])

Parameters:: menu

hasParent

public boolean hasParent([any parent])

Parameters:: parent

removeChild

public boolean removeChild(any child)

Parameters:: child

setActive

public any setActive(any active)

Parameters:: active

setChildren

public any setChildren(array children)

Parameters:: children

setCreatedDate

public any setCreatedDate(date createdDate)

Parameters:: createdDate

setData

public any setData(any data)

Parameters:: data

setIsDeleted

public any setIsDeleted(any isDeleted)

Parameters:: isDeleted

setItemClass

public any setItemClass(any itemClass)

Parameters:: itemClass

setLabel

public any setLabel(any label)

Parameters:: label

setMenu

public any setMenu(any menu)

Parameters:: menu

setMenuItemService

public any setMenuItemService(any menuItemService)

Parameters:: menuItemService

setMenuType

public any setMenuType(any menuType)

Parameters:: menuType

setModifiedDate

public any setModifiedDate(date modifiedDate)

Parameters:: modifiedDate

setParent

public any setParent(any parent)

Parameters:: parent

setTitle

public any setTitle(any title)

Parameters:: title