contentbox.models.content

Class Page

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

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am a cms page entity that totally rocks

Class Attributes:
  • discriminatorvalue : Page
  •  
  • entityname : cbPage
  •  
  • cacheuse : read-write
  •  
  • joincolumn : contentID
  •  
  • table : cb_page
  •  
  • synchronized : false
  •  
  • cachename : cbPage
  •  
  • batchsize : 25
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    any excerpt


    • access = public
    • returntype = any
    • notnull = false
    • ormtype = text
    • length = 8000
    true false
    any layout


    • access = public
    • returntype = any
    • notnull = false
    • length = 200
    true false
    any mobileLayout


    • access = public
    • returntype = any
    • notnull = false
    • length = 200
    true false
    any order


    • access = public
    • returntype = any
    • notnull = false
    • ormtype = integer
    0 true false
    any renderedExcerpt


    • access = public
    • returntype = any
    • persistent = false
    true false
    any showInMenu


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = boolean
    • index = idx_showInMenu
    true true false
    any SSLOnly


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = boolean
    • index = idx_ssl
    false true false
    Constructor Summary
    init()
          constructor.
    Method Summary
    string getExcerpt()
    string getLayout()
    any getLayoutWithDefault()
         Get the layout or if empty the default convention of "pages".
    any getLayoutWithInheritance()
         Get layout with layout inheritance, if none found return normal saved layout.
    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.
    string getMobileLayout()
    any getMobileLayoutWithInheritance()
         Get mobile layout with layout inheritance, if none found return normal saved layout.
    string getOrder()
    string getRenderedExcerpt()
    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.
    string getShowInMenu()
    string getSSLOnly()
    boolean hasExcerpt()
         has excerpt.
    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 renderExcerpt()
         Render excerpt.
    any setExcerpt(any excerpt)
    any setLayout(any layout)
    any setMobileLayout(any mobileLayout)
    any setOrder(any order)
    any setRenderedExcerpt(any renderedExcerpt)
    any setShowInMenu(any showInMenu)
    any setSSLOnly(any SSLOnly)
    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

    excerpt

    property any excerpt

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    ormtype - text
    length - 8000
    serializable - true

    layout

    property any layout

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    length - 200
    serializable - true

    mobileLayout

    property any mobileLayout

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    length - 200
    serializable - true

    order

    property any order = [0]

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - false
    ormtype - integer
    serializable - true

    renderedExcerpt

    property any renderedExcerpt

    Attributes:
    access - public
    required - false
    returntype - any
    persistent - false
    serializable - true

    showInMenu

    property any showInMenu = [true]

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - boolean
    index - idx_showInMenu
    serializable - true

    SSLOnly

    property any SSLOnly = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - boolean
    index - idx_ssl
    serializable - true

    Method Detail

    getExcerpt

    public string getExcerpt()


    getLayout

    public string getLayout()


    getLayoutWithDefault

    public any getLayoutWithDefault()

    Get the layout or if empty the default convention of "pages"


    getLayoutWithInheritance

    public any getLayoutWithInheritance()

    Get layout with layout inheritance, if none found return normal saved layout


    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

    getMobileLayout

    public string getMobileLayout()


    getMobileLayoutWithInheritance

    public any getMobileLayoutWithInheritance()

    Get mobile layout with layout inheritance, if none found return normal saved layout


    getOrder

    public string getOrder()


    getRenderedExcerpt

    public string getRenderedExcerpt()


    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

    getShowInMenu

    public string getShowInMenu()


    getSSLOnly

    public string getSSLOnly()


    hasExcerpt

    public boolean hasExcerpt()

    has excerpt


    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

    renderExcerpt

    public any renderExcerpt()

    Render excerpt


    setExcerpt

    public any setExcerpt(any excerpt)

    Parameters:
    excerpt

    setLayout

    public any setLayout(any layout)

    Parameters:
    layout

    setMobileLayout

    public any setMobileLayout(any mobileLayout)

    Parameters:
    mobileLayout

    setOrder

    public any setOrder(any order)

    Parameters:
    order

    setRenderedExcerpt

    public any setRenderedExcerpt(any renderedExcerpt)

    Parameters:
    renderedExcerpt

    setShowInMenu

    public any setShowInMenu(any showInMenu)

    Parameters:
    showInMenu

    setSSLOnly

    public any setSSLOnly(any SSLOnly)

    Parameters:
    SSLOnly

    validate

    public array validate()