ContentBox Core API 1.6.0

contentbox.model.content
Class PageService

WEB-INF.cftags.component
        extended by coldbox.system.orm.hibernate.BaseORMService
            extended by coldbox.system.orm.hibernate.VirtualEntityService
                extended by contentbox.model.content.ContentService
                    extended by contentbox.model.content.PageService

public class PageService
extends ContentService

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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. ******************************************************************************* Page service for contentbox

Constructor Summary
init()
          Constructor
 
Method Summary
 any findPublishedPages([any max='0'], [any offset='0'], [any searchTerm=''], [any category=''], [any asQuery='false'], [any parent], [boolean showInMenu])
 array getAllFlatPages()
          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([any search=''], [any isPublished], [any author], [any parent], [any category], [any max='0'], [any offset='0'], [any sortOrder='title asc'], [boolean searchActiveContent='true'])
          page search returns struct with keys [pages,count]
 
Methods inherited from class contentbox.model.content.ContentService
bulkPublishStatus, clearAllCaches, clearAllPageWrapperCaches, clearPageWrapper, clearPageWrapperCaches, deleteContent, findBySlug, findPublishedContent, getAllFlatSlugs, getIDBySlug, getTopCommentedContent, getTopVisitedContent, importFromData, importFromFile, inflateFromStruct, isSlugUnique, searchContent, syncUpdateHits, updateHits
 
Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService
GETDATASOURCE, GETENTITYNAME, SETDATASOURCE, SETENTITYNAME, clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod
 
Methods inherited from class coldbox.system.orm.hibernate.BaseORMService
$delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, GETDEFAULTASQUERY, GETEVENTHANDLING, GETHQLDYNAMICCACHE, GETORM, GETORMEVENTHANDLER, GETQUERYCACHEREGION, GETUSEQUERYCACHING, GETUSETRANSACTIONS, SETDEFAULTASQUERY, SETEVENTHANDLING, SETHQLDYNAMICCACHE, SETORM, SETORMEVENTHANDLER, SETQUERYCACHEREGION, SETUSEQUERYCACHING, SETUSETRANSACTIONS, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getEntityGivenName, getRestrictions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, populateWithPrefix, refresh, save, saveAll, sessionContains
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()
Constructor

Method Detail

findPublishedPages

public any findPublishedPages([any max='0'], [any offset='0'], [any searchTerm=''], [any category=''], [any asQuery='false'], [any parent], [boolean showInMenu])

Parameters:
max
offset
searchTerm
category
asQuery
parent
showInMenu

getAllFlatPages

public array getAllFlatPages()
Returns an array of [contentID, title, slug] structures of all the pages in the system


getAllForExport

public array getAllForExport()
Get all content for export as flat data

Overrides:
getAllForExport in class ContentService

savePage

public any savePage(any page, [string originalSlug=''])
Save a page and do necessary updates

Parameters:
page - The page to save or update
originalSlug - If an original slug is passed, then we need to update hierarchy slugs.

search

public struct search([any search=''], [any isPublished], [any author], [any parent], [any category], [any max='0'], [any offset='0'], [any sortOrder='title asc'], [boolean searchActiveContent='true'])
page search returns struct with keys [pages,count]

Parameters:
search
isPublished
author
parent - If empty, then looks for empty parent nodes. If you do not want to attach it, send as null
category
max
offset
sortOrder
searchActiveContent

ContentBox Core API 1.6.0