railo-context.Componentcoldbox.system.orm.hibernate.BaseORMService
coldbox.system.orm.hibernate.VirtualEntityService
contentbox.model.content.ContentService
contentbox.model.content.PageService
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 layer for all Page operations
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
contentService
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
any
|
findPublishedPages([numeric max='0'], [numeric offset='0'], [string searchTerm=''], [string category=''], [boolean asQuery='false'], [string parent], [boolean showInMenu], [string sortOrder='publishedDate DESC'])
Find published pages in ContentBox that have no passwords. |
array
|
getAllFlatPages([any sortOrder='title asc'])
Returns an array of [contentID, title, slug] structures of all the pages in the system. |
array
|
getAllForExport()
Get all content for export as flat data. |
any
|
savePage(any page, [string originalSlug=''])
Save a page and do necessary updates. |
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'])
page search returns struct with keys [pages,count]. |
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:ContentService@cbserializable
- trueMethod Detail |
---|
Find published pages in ContentBox that have no passwords
max
- The max number of pages to return, defaults to 0=alloffset
- The pagination offsetsearchTerm
- Pass a search term to narrow down resultscategory
- Pass a list of categories to narrow down resultsasQuery
- Return results as array of objects or query, default is array of objectsparent
- The parent ID to restrict the search onshowInMenu
- If passed, it limits the search to this content propertysortOrder
- The sort order string, defaults to publisedDate DESCReturns an array of [contentID, title, slug] structures of all the pages in the system
sortOrder
Get all content for export as flat data
getAllForExport
in class
ContentService
Save a page and do necessary updates
page
- The page to save or updateoriginalSlug
- If an original slug is passed, then we need to update hierarchy slugs.page search returns struct with keys [pages,count]
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 says