lucee.Componentcborm.models.BaseORMService
cborm.models.VirtualEntityService
contentbox.models.menu.MenuService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Service to handle menu operations.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
dateUtil
|
true
|
false
|
|
any
|
menuItemService
|
true
|
false
|
|
any
|
renderer
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
string
|
buildEditableMenu(array menu, string menuString='', [boolean inChild='false'])
Builds editable menu for interface. |
any
|
findBySlug(any slug, [string siteID=''])
Find a menu object by slug, if not found it returns a new menu object. |
array
|
getAllForExport(any site)
Get all data prepared for export. |
array
|
getAllSlugs([string siteID=''])
Returns an array of slugs of all the content objects in the system. |
string
|
getDateUtil()
|
string
|
getMenuItemService()
|
string
|
getRenderer()
|
private any
|
getUniqueSlugHash(string slug)
Get a unique slug hash. |
string
|
importFromData(any importData, [boolean override='false'], any importLog, [any site])
Import data from an array of structures or a single structure of data. |
string
|
importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file. |
any
|
isSlugUnique(any slug, [any menuID=''], [string siteID=''])
Verify an incoming slug is unique or not. |
any
|
save(any menu, [string originalSlug=''])
Save a menu and do necessary updates. |
any
|
search([string searchTerm=''], [numeric max='0'], [numeric offset='0'], [boolean asQuery='false'], [string sortOrder='title'], [string siteID=''])
Menu search using different filters and return options. |
any
|
setDateUtil(any dateUtil)
|
any
|
setMenuItemService(any menuItemService)
|
any
|
setRenderer(any renderer)
|
Methods inherited from class cborm.models.VirtualEntityService |
---|
autoCast, convertIdValueToJavaType, convertValueToJavaType, count, countWhere, deleteAll, deleteByID, deleteByQuery, deleteWhere, evictCollection, executeQuery, exists, findAllWhere, findWhere, get, getAll, getEntityName, getKey, getOrFail, getPropertyNames, getTableName, idCast, list, new, newCriteria, onMissingMethod, setEntityName |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- DateUtil@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- menuItemService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:rendererserializable
- trueMethod Detail |
---|
Builds editable menu for interface
menu
- the menu to parsemenuString
- build-up string for menu contentinChild
- flag for whether the content item is being evaluated as itself, or as a child of another itemFind a menu object by slug, if not found it returns a new menu object
slug
- The slug to searchsiteID
- The site this slug is onGet all data prepared for export
site
- The site to export fromReturns an array of slugs of all the content objects in the system.
siteID
- Filter by siteGet a unique slug hash
slug
- The slug to make uniqueImport data from an array of structures or a single structure of data
importData
- A struct or array of data to importoverride
- Override content if found in the database, defaults to falseimportLog
- The import log buffersite
- If passed, we use this specific site, else we discover it via content dataImport data from a ContentBox JSON file. Returns the import log
importFile
- The json file to importoverride
- Override content if found in the database, defaults to falseVerify an incoming slug is unique or not
slug
- The slug to search for uniquenessmenuID
- Limit the search to the passed menuID usually for updatessiteID
- The site to filter onSave a menu and do necessary updates
save
in class
cborm.models.BaseORMService
menu
- The menu to save or updateoriginalSlug
- If an original slug is passed, then we need to update hierarchy slugs.Menu search using different filters and return options
searchTerm
- Search in firstname, lastname and email fieldsmax
- The max returned objectsoffset
- The offset for paginationasQuery
- Query or objectssortOrder
- The sort order to applysiteID
- The site to filter ondateUtil
menuItemService
renderer