railo-context.Componentcoldbox.system.orm.hibernate.BaseORMService
coldbox.system.orm.hibernate.VirtualEntityService
contentbox.model.menu.MenuService
ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Service to handle menu operations.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
menuItemService
|
true
|
false
|
|
any
|
populator
|
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)
Find a menu object by slug, if not found it returns a new menu object. |
array
|
getAllForExport()
Get all data prepared for export. |
array
|
getAllSlugs()
Returns an array of slugs of all the content objects in the system. |
string
|
getMenuItemService()
|
string
|
getPopulator()
|
string
|
getRenderer()
|
private any
|
getUniqueSlugHash(string slug)
Get a unique slug hash. |
string
|
importFromData(any importData, [boolean override='false'], [any importLog])
Import data from an array of structures of authors or just one structure of author. |
string
|
importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file. |
any
|
isSlugUnique(any slug, [any menuID=''])
Verify an incoming slug is unique or not. |
any
|
saveMenu(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'])
Menu search by title or slug. |
any
|
setMenuItemService(any menuItemService)
|
any
|
setPopulator(any populator)
|
any
|
setRenderer(any renderer)
|
Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService |
---|
clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getDatasource, getEntityName, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod, setDatasource, setEntityName |
Methods inherited from class coldbox.system.orm.hibernate.BaseORMService |
---|
$delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getDefaultAsQuery, getEntityGivenName, getEventHandling, getHQLDynamicCache, getORM, getORMEventHandler, getQueryCacheRegion, getRestrictions, getUseQueryCaching, getUseTransactions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, populateWithPrefix, refresh, save, saveAll, sessionContains, setDefaultAsQuery, setEventHandling, setHQLDynamicCache, setORM, setORMEventHandler, setQueryCacheRegion, setUseQueryCaching, setUseTransactions |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseinject
- id:menuItemService@cbserializable
- truerequired
- falseinject
- wirebox:populatorserializable
- truerequired
- falseinject
- provider:ColdBoxRendererserializable
- 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 searchGet all data prepared for export
Returns an array of slugs of all the content objects in the system.
Get a unique slug hash
slug
- The slug to make uniqueImport data from an array of structures of authors or just one structure of author
importData
override
importLog
Import data from a ContentBox JSON file. Returns the import log
importFile
override
Verify an incoming slug is unique or not
slug
- The slug to search for uniquenessmenuID
- Limit the search to the passed menuID usually for updatesSave a menu and do necessary updates
menu
- The menu to save or updateoriginalSlug
- If an original slug is passed, then we need to update hierarchy slugs.Menu search by title or slug
searchTerm
- Search in firstname, lastname and email fieldsmax
- The max returned objectsoffset
- The offset for paginationasQuery
- Query or objectssortOrder
- The sort order to applymenuItemService
populator
renderer