contentbox.models.content

Class EntryService

lucee.Component
    extended by cborm.models.BaseORMService
      extended by cborm.models.VirtualEntityService
        extended by contentbox.models.content.ContentService
          extended by contentbox.models.content.EntryService

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manages blog entry content

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any contentService


    • access = public
    • returntype = any
    • inject = id:ContentService@contentbox
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any findPublishedEntriesByDate([numeric year='0'], [numeric month='0'], [numeric day='0'], [numeric max='0'], [numeric offset='0'], [boolean asQuery='false'], [string siteId=''])
         Find published entries by date filters.
    array getAllForExport(any site)
         Get all site content for export as flat data.
    any getArchiveReport()
         Get a query report of entries archive.
    any save(any entry, [string originalSlug=''])
         Save an entry.
    struct search([string search=''], [string isPublished='any'], [string author='all'], [string creator='all'], [string category='all'], [numeric max='0'], [numeric offset='0'], [string sortOrder=''], [boolean searchActiveContent='true'], [boolean showInSearch='false'], [string siteId=''], [string propertyList])
         Search for blog entries according to many filters.
     
    Methods inherited from class contentbox.models.content.ContentService
    addRelocation, bulkPublishStatus, clearAllCaches, clearAllCategoryCountCaches, clearAllPageWrapperCaches, clearAllSitemapCaches, clearPageWrapper, clearPageWrapperCaches, delete, findBySlug, findExpiredContent, findFuturePublishedContent, findPublishedContent, getAllFlatContent, getAllFlatSlugs, getByIdOrSlugOrFail, getIdBySlug, getLatestEdits, getServiceByType, getTopCommentedContent, getTopVisitedContent, getTotalContentCount, getUniqueSlugHash, importFromData, importFromFile, importFromStruct, isSlugUnique, searchContent, updateHits
     
    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 cborm.models.BaseORMService
    $transactioned, buildJavaProxy, clear, createService, evict, evictQueries, findAll, findByExample, findIt, findOrFail, getBeanPopulator, getDatasource, getDefaultAsQuery, getDirtyPropertyNames, getDynamicProcessor, getEntityGivenName, getEntityMetadata, getEventHandling, getKeyValue, getLogger, getORMEventHandler, getObjectPopulator, getOrm, getPropertyValues, getQueryCacheRegion, getRestrictions, getSessionStatistics, getStringBuilder, getUseQueryCaching, getUseTransactions, getWirebox, isDirty, isSessionDirty, merge, nullValue, populate, populateFromJson, populateFromQuery, populateFromXml, populateWithPrefix, refresh, saveAll, sessionContains, setDatasource, setDefaultAsQuery, setEventHandling, setLogger, setORM, setORMEventHandler, setQueryCacheRegion, setUseQueryCaching, setUseTransactions, setWirebox, when
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    contentService

    property any contentService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:ContentService@contentbox
    serializable - true

    Method Detail

    findPublishedEntriesByDate

    public any findPublishedEntriesByDate([numeric year='0'], [numeric month='0'], [numeric day='0'], [numeric max='0'], [numeric offset='0'], [boolean asQuery='false'], [string siteId=''])

    Find published entries by date filters

    Parameters:
    year - The year to filter on
    month - The month to filter on
    day - The day to filter on
    max - The maximum records to return
    offset - The offset on the pagination
    asQuery - Return query or array of structs
    siteId - The site ID to filter on
    Returns:
    struct of { entries, count }

    getAllForExport

    public array getAllForExport(any site)

    Get all site content for export as flat data

    Overrides:
    getAllForExport in class ContentService
    Parameters:
    site - The site to get the export from

    getArchiveReport

    public any getArchiveReport()

    Get a query report of entries archive


    save

    public any save(any entry, [string originalSlug=''])

    Save an entry

    Overrides:
    save in class cborm.models.BaseORMService
    Parameters:
    entry - The entry to save or update
    originalSlug - The original slug if the save is an update
    Returns:
    Saved entry

    search

    public struct search([string search=''], [string isPublished='any'], [string author='all'], [string creator='all'], [string category='all'], [numeric max='0'], [numeric offset='0'], [string sortOrder=''], [boolean searchActiveContent='true'], [boolean showInSearch='false'], [string siteId=''], [string propertyList])

    Search for blog entries according to many filters

    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. Default is `any`
    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'
    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
    siteId - The site ID to filter on
    propertyList - A list of properties to retrieve as a projection instead of array of objects
    Returns:
    struct of { entries, count }