contentbox.model.content

Class ContentStoreService

railo-context.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.ContentStoreService
Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  

    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. Entry service for contentbox

    Property Summary
    type property default serializable required
    any contentService


    • inject = id:ContentService@cb
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any findPublishedEntries([numeric max='0'], [numeric offset='0'], [any searchTerm=''], [any category=''], [boolean asQuery='false'], [string parent], [string sortOrder='publishedDate DESC'])
         Find published contentstore entries by filters.
    array getAllFlatEntries([any sortOrder='title asc'])
         Returns an array of [contentID, title, slug] structures of all the content store items in the system.
    array getAllForExport()
         Get all content for export as flat data.
    any saveContent(any content, [string originalSlug=''])
         Save content store object.
    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'])
         content search returns struct with keys [content,count].
     
    Methods inherited from class contentbox.model.content.ContentService
    bulkPublishStatus, clearAllCaches, clearAllPageWrapperCaches, clearPageWrapper, clearPageWrapperCaches, deleteContent, findBySlug, findPublishedContent, getAllFlatContent, getAllFlatSlugs, getIDBySlug, getTopCommentedContent, getTopVisitedContent, getUniqueSlugHash, importFromData, importFromFile, inflateFromStruct, isSlugUnique, searchContent, updateHits
     
    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

    init

    public init()

    Constructor


    Property Detail

    contentService

    property any contentService

    Attributes:
    required - false
    inject - id:ContentService@cb
    serializable - true

    Method Detail

    findPublishedEntries

    public any findPublishedEntries([numeric max='0'], [numeric offset='0'], [any searchTerm=''], [any category=''], [boolean asQuery='false'], [string parent], [string sortOrder='publishedDate DESC'])

    Find published contentstore entries by filters

    Parameters:
    max - The maximum number of records to retrieve
    offset - Where to start in the pagination
    searchTerm - The search term to use for search
    category - One or more categories to filter on
    asQuery - Return results as query or array of objects. Defaults to false
    parent - The parent ID to restrict the search on
    sortOrder - The sort order string, defaults to publisedDate DESC

    getAllFlatEntries

    public array getAllFlatEntries([any sortOrder='title asc'])

    Returns an array of [contentID, title, slug] structures of all the content store items in the system

    Parameters:
    sortOrder

    getAllForExport

    public array getAllForExport()

    Get all content for export as flat data

    Overrides:
    getAllForExport in class ContentService

    saveContent

    public any saveContent(any content, [string originalSlug=''])

    Save content store object

    Parameters:
    content - The content store object
    originalSlug - If an original slug is passed, then we need to update hierarchy slugs.

    search

    public 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'])

    content search returns struct with keys [content,count]

    Parameters:
    search - The search term to search on
    isPublished - 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 filter
    creator - 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 return
    offset - The offset on the pagination
    sortOrder - Sorting of the results, defaults to page title asc
    searchActiveContent - If true, it searches title and content on the page, else it just searches on title
    showInSearch - If true, it makes sure content has been stored as searchable, defaults to false, which means it searches no matter what this bit says