contentbox.models.content

Class ContentStore

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.content.BaseContent
        extended by contentbox.models.content.ContentStore

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I represent a content value store

Class Attributes:
  • discriminatorvalue : ContentStore
    •  
  • entityname : cbContentStore
    •  
  • cacheuse : read-write
    •  
  • joincolumn : contentID
    •  
  • table : cb_contentStore
    •  
  • synchronized : false
    •  
  • cachename : cbContentStore
    •  
  • batchsize : 25
    •  
  • accessors : false
    •  
  • persistent : true
    •  
    Property Summary
    type property default serializable required
    any description


    • access = public
    • returntype = any
    • notnull = false
    • length = 500
    		 true false
    Constructor Summary
    init()
          constructor.
    Method Summary
    string getDescription()
    any getMemento(array slugCache='[runtime expression]', [any counter='0'], [boolean showAuthor='true'], [boolean showComments='true'], [boolean showCustomFields='true'], [boolean showContentVersions='true'], [boolean showParent='true'], [boolean showChildren='true'], [boolean showCategories='true'], [boolean showRelatedContent='true'], [boolean showStats='true'])
         Get a flat representation of this entry.
    struct getResponseMemento(array slugCache='[runtime expression]', [boolean showAuthor='true'], [boolean showComments='true'], [boolean showCustomFields='true'], [boolean showParent='true'], [boolean showChildren='true'], [boolean showCategories='true'], [boolean showRelatedContent='true'])
         Get a flat representation of this entry but for UI response format which.
    BaseContent prepareForClone(any author, any original, any originalService, boolean publish, any originalSlugRoot, any newSlugRoot)
         Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies.
    any setDescription(any description)
    array validate()
     
    Methods inherited from class contentbox.models.content.BaseContent
    addActiveContent, addCategories, addChild, addComment, addCommentSubscription, addContentVersion, addCustomField, addExpiredTime, addJoinedExpiredTime, addJoinedPublishedTime, addLinkedContent, addNewContentVersion, addPublishedTime, addRelatedContent, buildContentCacheKey, canCacheContent, getActiveContent, getAllowComments, getAuthor, getAuthorEmail, getAuthorName, getCache, getCachebox, getCacheLastAccessTimeout, getCacheLayout, getCacheTimeout, getCategories, getCategoriesList, getCategoryService, getChildren, getComments, getCommentSubscriptions, getContent, getContentID, getContentService, getContentType, getContentVersions, getContentVersionService, getCreatedDate, getCreator, getCreatorEmail, getCreatorName, getCustomField, getCustomFields, getCustomFieldsAsStruct, getCustomFieldService, getDisplayExpireDate, getDisplayPublishedDate, getExpireDate, getExpireDateForEditor, getFeaturedImage, getFeaturedImageURL, getHTMLDescription, getHTMLKeywords, getHTMLTitle, getInterceptorService, getIsDeleted, getIsPublished, getLinkedContent, getMarkup, getModifiedDate, getNumberOfActiveVersions, getNumberOfApprovedComments, getNumberOfChildren, getNumberOfComments, getNumberOfHits, getNumberOfVersions, getParent, getParentID, getParentName, getPasswordProtection, getPublishedDate, getPublishedDateForEditor, getRecursiveSlug, getRelatedContent, getRelatedContentIDs, getRenderedContent, getSettingService, getShowInSearch, getSlug, getStats, getTitle, hasActiveContent, hasActiveContentSet, hasCategories, hasChild, hasComment, hasCommentSubscription, hasContentVersion, hasCreator, hasCustomField, hasLinkedContent, hasParent, hasRelatedContent, hasStats, inflateCustomFields, inflateRelatedContent, isContentPublished, isExpired, isLoaded, isPasswordProtected, isPublishedInFuture, maxContentVersionChecks, removeActiveContent, removeAllCategories, removeAllLinkedContent, removeCategories, removeChild, removeComment, removeCommentSubscription, removeContentVersion, removeCustomField, removeLinkedContent, removeRelatedContent, renderContent, renderContentSilent, setActiveContent, setAllowComments, setCache, setCachebox, setCacheLastAccessTimeout, setCacheLayout, setCacheTimeout, setCategories, setCategoryService, setChildren, setComments, setCommentSubscriptions, setContentService, setContentVersions, setContentVersionService, setCreatedDate, setCreator, setCustomFields, setCustomFieldService, setExpireDate, setFeaturedImage, setFeaturedImageURL, setHTMLDescription, setHTMLKeywords, setHTMLTitle, setInterceptorService, setIsDeleted, setIsPublished, setLinkedContent, setMarkup, setModifiedDate, setNumberOfActiveVersions, setNumberOfApprovedComments, setNumberOfChildren, setNumberOfComments, setNumberOfHits, setNumberOfVersions, setParent, setPasswordProtection, setPublishedDate, setRelatedContent, setRenderedContent, setSettingService, setShowInSearch, setSlug, setStats, setTitle
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    getBaseMemento, getDisplayCreatedDate, getDisplayModifiedDate, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    constructor

    Property Detail

    description

    property any description

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    length - 500
    serializable - true
    Method Detail

    getDescription

    public string getDescription()

    getMemento

    public any getMemento(array slugCache='[runtime expression]', [any counter='0'], [boolean showAuthor='true'], [boolean showComments='true'], [boolean showCustomFields='true'], [boolean showContentVersions='true'], [boolean showParent='true'], [boolean showChildren='true'], [boolean showCategories='true'], [boolean showRelatedContent='true'], [boolean showStats='true'])

    Get a flat representation of this entry

    Overrides:
    getMemento in class BaseContent
    Parameters:
    slugCache - Cache of slugs to prevent infinite recursions
    counter - true
    showAuthor - Show author in memento or not
    showComments - Show comments in memento or not
    showCustomFields - Show comments in memento or not
    showContentVersions - Show content versions in memento or not
    showParent - Show parent in memento or not
    showChildren - Show children in memento or not
    showCategories - Show categories in memento or not
    showRelatedContent - Show related Content in memento or not
    showStats - Show stats in memento or not

    getResponseMemento

    public struct getResponseMemento(array slugCache='[runtime expression]', [boolean showAuthor='true'], [boolean showComments='true'], [boolean showCustomFields='true'], [boolean showParent='true'], [boolean showChildren='true'], [boolean showCategories='true'], [boolean showRelatedContent='true'])

    Get a flat representation of this entry but for UI response format which restricts the data being generated.

    Overrides:
    getResponseMemento in class BaseContent
    Parameters:
    slugCache - Cache of slugs to prevent infinite recursions
    showAuthor
    showComments - Show comments in memento or not
    showCustomFields - Show comments in memento or not
    showParent - Show parent in memento or not
    showChildren - Show children in memento or not
    showCategories - Show categories in memento or not
    showRelatedContent - Show related Content in memento or not

    prepareForClone

    public BaseContent prepareForClone(any author, any original, any originalService, boolean publish, any originalSlugRoot, any newSlugRoot)

    Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies

    Overrides:
    prepareForClone in class BaseContent
    Parameters:
    author - The author doing the cloning
    original - The original content object that will be cloned into this content object
    originalService - The ContentBox content service object
    publish - Publish pages or leave as drafts
    originalSlugRoot - The original slug that will be replaced in all cloned content
    newSlugRoot - The new slug root that will be replaced in all cloned content

    setDescription

    public any setDescription(any description)

    Parameters:
    description

    validate

    public array validate()