lucee.Componentcborm.models.BaseORMService
cborm.models.VirtualEntityService
contentbox.models.content.ContentService
contentbox.models.content.PageService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Service layer for all Page operations
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
contentService
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
any
|
findPublishedContent([numeric max='0'], [numeric offset='0'], [any searchTerm=''], [any category=''], [boolean asQuery='false'], [string sortOrder='publishedDate DESC'], [any parent], [string slugPrefix=''], [string siteID=''], [string properties], [string authorID=''], [boolean showInMenu], [string slugSearch=''])
Find published pages using different filters and output formats. |
array
|
getAllForExport(any site)
Get all site content for export as flat data. |
any
|
save(any page, [string originalSlug=''])
Save a page and do necessary updates to the hierarchies if there is a slug change. |
struct
|
search([string search=''], [string isPublished='any'], [string author='all'], [string creator='all'], [string parent], [string category='all'], [numeric max='0'], [numeric offset='0'], [string sortOrder=''], [boolean searchActiveContent='true'], [boolean showInSearch='false'], [string siteID=''], [string propertyList])
Search for pages according to many filters. |
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
- id:ContentService@contentboxserializable
- trueMethod Detail |
---|
Find published pages using different filters and output formats.
findPublishedContent
in class
ContentService
max
- The maximum number of records to paginateoffset
- The offset in the paginationsearchTerm
- The search term to searchcategory
- The category to filter the content onasQuery
- Return as query or array of objects, defaults to array of objectssortOrder
- how we need to sort the resultsparent
- The parentID or parent entity to filter on, don't pass or pass an empty value to ignore, defaults to 'all'slugPrefix
- If passed, this will do a hierarchical search according to this slug prefix. Remember that all hierarchical content's slug field contains its hierarchy: /products/awesome/product1. This prefix will be appended with a `/`siteID
- If passed, filter by site idproperties
- The list of properties to project on instead of giving you full object graphsauthorID
- The authorID to filter onshowInMenu
- If passed, it limits the search to this content propertyslugSearch
- If passed, we will search for content items with this field as a full text search on slugsGet all site content for export as flat data
getAllForExport
in class
ContentService
site
- The site to get the export fromSave a page and do necessary updates to the hierarchies if there is a slug change
save
in class
cborm.models.BaseORMService
page
- The page to save or updateoriginalSlug
- If an original slug is passed, then we need to update hierarchy slugs.Search for pages according to many filters
search
- The search term to search onisPublished
- Boolean bit to search if page is published or not, pass 'any' or not to ignore.author
- The authorID to filter on, pass 'all' to ignore filtercreator
- The creatorID to filter on, don't pass or pass an empty value to ignore, defaults to 'all'parent
- The parentID to filter on, don't pass or pass an empty value to ignore, defaults to 'all'category
- The categorie(s) to filter on. You can also pass 'all' or 'none'max
- The maximum records to returnoffset
- The offset on the paginationsortOrder
- Sorting of the results, defaults to page title ascsearchActiveContent
- If true, it searches title and content on the page, else it just searches on titleshowInSearch
- If true, it makes sure content has been stored as searchable, defaults to false, which means it searches no matter what this bit sayssiteID
- The site ID to filter onpropertyList
- A list of properties to retrieve as a projection instead of array of objects