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
          The excerpt for this page.

    • access = public
    • returntype = any
    • column = excerpt
    • notnull = false
    • ormtype = text
    • length = 8000
    true false
    any layout
          The layout in a theme that will be used to render the page out.

    • access = public
    • returntype = any
    • column = layout
    • notnull = false
    • length = 200
    true false
    any order
          The ordering numeric sequence.

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


    • access = public
    • returntype = any
    • persistent = false
    true false
    any showInMenu
          If true, this page is used when building automated menus.

    • access = public
    • returntype = any
    • column = showInMenu
    • notnull = true
    • ormtype = boolean
    • index = idx_showInMenu
    true true false
    Constructor Summary
    init()
    Method Summary
    BaseContent clone(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.
    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.
    string getOrder()
    string getShowInMenu()
    boolean hasExcerpt()
         Verifies an excerpt exists in this content object via length checks.
    boolean isHomepage()
         Verifies if the current page is the current site homepage.
    any renderExcerpt()
    any setExcerpt(any excerpt)
    any setLayout(any layout)
    any setOrder(any order)
    any setRenderedExcerpt(any renderedExcerpt)
    any setShowInMenu(any showInMenu)
     
    Methods inherited from class contentbox.models.content.BaseContent
    addCategories, addChild, addComment, addCommentSubscription, addContentVersion, addCustomField, addExpiredTime, addJoinedExpiredTime, addJoinedPublishedTime, addLinkedContent, addNewContentVersion, addPublishedTime, addRelatedContent, applyContentTemplate, buildContentCacheCleanupKey, buildContentCacheKey, canCacheContent, commentsAllowed, getActiveContent, getAllowComments, getAuthor, getAuthorEmail, getAuthorName, getCache, getCacheLastAccessTimeout, getCacheTimeout, getCategories, getCategoriesArray, getCategoriesList, getCategoryService, getChildContentTemplate, getChildren, getChildrenSnapshot, getCommentSubscriptions, getComments, getContent, getContentID, getContentService, getContentTemplate, getContentTemplateService, getContentType, getContentVersionService, getContentVersions, getCreatedDate, getCreator, getCreatorEmail, getCreatorName, getCreatorSnapshot, getCustomField, getCustomFieldService, getCustomFields, getCustomFieldsAsStruct, getDisplayExpireDate, getDisplayPublishedDate, getExpireDate, getExpireDateTime, getFeaturedImage, getFeaturedImageURL, getHTMLDescription, getHTMLKeywords, getHTMLTitle, getI18n, getInfoSnapshot, getIsDeleted, getIsPublished, getJSONPrettyPrint, getLastEditorSnapshot, getLinkedContent, getLinkedContentSnapshot, getMarkup, getMediaService, getModifiedDate, getNumberOfActiveVersions, getNumberOfApprovedComments, getNumberOfChildren, getNumberOfComments, getNumberOfHits, getNumberOfVersions, getParent, getParentID, getParentName, getParentSnapshot, getPasswordProtection, getPublishedDate, getPublishedDateTime, getRelatedContent, getRelatedContentIDs, getRelatedContentSnapshot, getRenderedContent, getRenderedExcerpt, getSettingService, getShowInSearch, getSite, getSiteID, getSiteName, getSiteSlug, getSiteSnapshot, getSlug, getStats, getTitle, hasActiveContent, hasCategories, hasChild, hasChildContentTemplate, hasComment, hasCommentSubscription, hasContentTemplate, hasContentVersion, hasCreator, hasCustomField, hasLinkedContent, hasParent, hasRelatedContent, hasSite, hasStats, inflateCustomFields, inflateRelatedContent, isContentPublished, isContentStore, isExpired, isLoaded, isPasswordProtected, isPublishedInFuture, isSameSite, maxContentVersionChecks, onDIComplete, removeAllCategories, removeAllCustomFields, removeAllLinkedContent, removeCategories, removeChild, removeComment, removeCommentSubscription, removeContentVersion, removeCustomField, removeLinkedContent, removeRelatedContent, renderContent, renderContentSilent, setActiveContent, setAllowComments, setCache, setCacheLastAccessTimeout, setCacheTimeout, setCategories, setCategoryService, setChildContentTemplate, setChildren, setCommentSubscriptions, setComments, setContentID, setContentService, setContentTemplate, setContentTemplateService, setContentVersionService, setContentVersions, setCreatedDate, setCreator, setCustomFieldService, setCustomFields, setExpireDate, setFeaturedImage, setHTMLDescription, setHTMLKeywords, setHTMLTitle, setI18n, setIsDeleted, setIsPublished, setJSONPrettyPrint, setLinkedContent, setMarkup, setMediaService, setModifiedDate, setNumberOfChildren, setNumberOfComments, setNumberOfHits, setNumberOfVersions, setParent, setPasswordProtection, setPublishedDate, setRelatedContent, setRenderedContent, setSettingService, setShowInSearch, setSite, setSlug, setStats, setTitle
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    appendToMemento, appendToMementoProfile, arrayWrap, getDisplayCreatedDate, getDisplayModifiedDate, getEntityName, getId, includeMixin, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    excerpt

    property any excerpt

    The excerpt for this page. This can be empty.

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

    layout

    property any layout

    The layout in a theme that will be used to render the page out

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

    order

    property any order = [0]

    The ordering numeric sequence

    Attributes:
    access - public
    required - false
    returntype - any
    column - order
    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]

    If true, this page is used when building automated menus. Else it is ignored.

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

    Method Detail

    clone

    public BaseContent clone(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:
    clone 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

    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


    getOrder

    public string getOrder()


    getShowInMenu

    public string getShowInMenu()


    hasExcerpt

    public boolean hasExcerpt()

    Verifies an excerpt exists in this content object via length checks


    isHomepage

    public boolean isHomepage()

    Verifies if the current page is the current site homepage


    renderExcerpt

    public any renderExcerpt()


    setExcerpt

    public any setExcerpt(any excerpt)

    Parameters:
    excerpt

    setLayout

    public any setLayout(any layout)

    Parameters:
    layout

    setOrder

    public any setOrder(any order)

    Parameters:
    order

    setRenderedExcerpt

    public any setRenderedExcerpt(any renderedExcerpt)

    Parameters:
    renderedExcerpt

    setShowInMenu

    public any setShowInMenu(any showInMenu)

    Parameters:
    showInMenu