railo-context.Component
contentbox.model.content.BaseContent
A mapped super class used for contentbox content: entries and pages
| Property Summary | ||||
|---|---|---|---|---|
| type | property | default | serializable | required |
array
|
activeContent
|
true
|
false
|
|
any
|
allowComments
|
true
|
true
|
false
|
any
|
cache
|
true
|
true
|
false
|
any
|
cachebox
|
true
|
false
|
|
any
|
cacheLastAccessTimeout
|
0
|
true
|
false
|
any
|
cacheLayout
|
true
|
true
|
false
|
any
|
cacheTimeout
|
0
|
true
|
false
|
array
|
categories
|
true
|
false
|
|
any
|
categoryService
|
true
|
false
|
|
array
|
children
|
true
|
false
|
|
array
|
comments
|
true
|
false
|
|
array
|
commentSubscriptions
|
true
|
false
|
|
any
|
contentID
|
true
|
false
|
|
any
|
contentService
|
true
|
false
|
|
any
|
contentType
|
true
|
false
|
|
array
|
contentVersions
|
true
|
false
|
|
any
|
contentVersionService
|
true
|
false
|
|
any
|
createdDate
|
true
|
false
|
|
any
|
creator
|
true
|
false
|
|
array
|
customFields
|
true
|
false
|
|
any
|
customFieldService
|
true
|
false
|
|
any
|
expireDate
|
true
|
false
|
|
any
|
hits
|
0
|
true
|
false
|
any
|
HTMLDescription
|
true
|
false
|
|
any
|
HTMLKeywords
|
true
|
false
|
|
any
|
interceptorService
|
true
|
false
|
|
any
|
isPublished
|
true
|
true
|
false
|
array
|
linkedContent
|
true
|
false
|
|
any
|
markup
|
HTML
|
true
|
false
|
any
|
numberOfApprovedComments
|
0
|
true
|
false
|
any
|
numberOfChildren
|
0
|
true
|
false
|
any
|
numberOfComments
|
0
|
true
|
false
|
any
|
numberOfVersions
|
0
|
true
|
false
|
any
|
parent
|
true
|
false
|
|
any
|
passwordProtection
|
true
|
false
|
|
any
|
publishedDate
|
true
|
false
|
|
array
|
relatedContent
|
true
|
false
|
|
any
|
renderedContent
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
slug
|
true
|
false
|
|
any
|
title
|
true
|
false
|
|
| Constructor Summary | |
|---|---|
|
init()
Base constructor. |
|
| Method Summary | |
|---|---|
any
|
addActiveContent(any activeContent)
|
BaseContent
|
addCategories(any category)
Bi directional add. |
any
|
addChild(any child)
|
any
|
addComment(any comment)
|
any
|
addCommentSubscription(any commentSubscription)
|
any
|
addContentVersion(any contentVersion)
|
any
|
addCustomField(any customField)
|
any
|
addExpiredTime(any hour, any minute)
add expired timestamp to property. |
any
|
addLinkedContent(any linkedContent)
|
any
|
addNewContentVersion(any content, [any changelog=''], any author)
Add a new content version to save for this content object. |
any
|
addPublishedTime(any hour, any minute)
add published timestamp to property. |
any
|
addRelatedContent(any relatedContent)
|
string
|
buildContentCacheKey()
Build content cache keys according to sent content object. |
boolean
|
canCacheContent()
Verify we can do content caching on this content object using global and local rules. |
any
|
getActiveContent()
|
string
|
getAllowComments()
|
any
|
getAuthor()
Shorthand Author from latest version or null if any yet. |
string
|
getAuthorEmail()
Shorthand Author email from latest version. |
string
|
getAuthorName()
Shorthand Author name from latest version. |
string
|
getCache()
|
string
|
getCachebox()
|
string
|
getCacheLastAccessTimeout()
|
string
|
getCacheLayout()
|
string
|
getCacheTimeout()
|
string
|
getCategories()
|
any
|
getCategoriesList()
get flat categories list. |
string
|
getCategoryService()
|
string
|
getChildren()
|
string
|
getComments()
|
string
|
getCommentSubscriptions()
|
any
|
getContent()
|
string
|
getContentID()
|
string
|
getContentService()
|
string
|
getContentType()
|
string
|
getContentVersions()
|
string
|
getContentVersionService()
|
string
|
getCreatedDate()
|
string
|
getCreator()
|
string
|
getCreatorEmail()
Shorthand Creator email. |
string
|
getCreatorName()
Shorthand Creator name. |
any
|
getCustomField(any key, [any defaultValue])
Shortcut to get a custom field value. |
string
|
getCustomFields()
|
struct
|
getCustomFieldsAsStruct()
Get custom fields as a structure representation. |
string
|
getCustomFieldService()
|
string
|
getDisplayCreatedDate()
Get formatted createdDate. |
string
|
getDisplayExpireDate()
Get formatted expireDate. |
string
|
getDisplayPublishedDate()
Get display publishedDate. |
string
|
getExpireDate()
|
string
|
getExpireDateForEditor([boolean showTime='false'])
Get display expireDate. |
string
|
getHits()
|
string
|
getHTMLDescription()
|
string
|
getHTMLKeywords()
|
string
|
getInterceptorService()
|
string
|
getIsPublished()
|
string
|
getLinkedContent()
|
string
|
getMarkup()
|
any
|
getMemento(array slugCache='[runtime expression]', [any counter='0'])
Get a flat representation of this entry. |
string
|
getNumberOfApprovedComments()
|
string
|
getNumberOfChildren()
|
string
|
getNumberOfComments()
|
string
|
getNumberOfVersions()
|
string
|
getParent()
|
any
|
getParentID()
Get parent ID if set or empty if none. |
any
|
getParentName()
Get parent name or empty if none. |
string
|
getPasswordProtection()
|
string
|
getPublishedDate()
|
string
|
getPublishedDateForEditor([boolean showTime='false'])
Get display publishedDate. |
any
|
getRecursiveSlug([any separator='/'])
Get recursive slug paths to get ancestry, DEPRECATED. |
string
|
getRelatedContent()
|
string
|
getRelatedContentIDs()
Returns a list of active related content for this piece of content. |
string
|
getRenderedContent()
|
string
|
getSettingService()
|
string
|
getSlug()
|
string
|
getTitle()
|
boolean
|
hasActiveContent([any activeContent])
|
boolean
|
hasCategories([any categories])
|
boolean
|
hasChild([any child])
|
boolean
|
hasComment([any comment])
|
boolean
|
hasCommentSubscription([any commentSubscription])
|
boolean
|
hasContentVersion([any contentVersion])
|
boolean
|
hasCreator([any creator])
|
boolean
|
hasCustomField([any customField])
|
boolean
|
hasLinkedContent([any linkedContent])
|
boolean
|
hasParent([any parent])
|
boolean
|
hasRelatedContent([any relatedContent])
|
any
|
inflateCustomFields(numeric fieldCount, struct memento)
Inflate custom fields from the incoming count and memento structure. |
BaseContent
|
inflateRelatedContent(any relatedContent)
Inflates from comma-delimited list (or array) of id's. |
boolean
|
isContentPublished()
Bit that denotes if the content has been published or not. |
boolean
|
isExpired()
Bit that denotes if the content has expired or not, in order to be expired the content must have been published as well. |
boolean
|
isLoaded()
is loaded?. |
boolean
|
isPasswordProtected()
isPassword Protected. |
boolean
|
isPublishedInFuture()
Bit that denotes if the content has been published or not in the future. |
private any
|
maxContentVersionChecks()
|
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. |
boolean
|
removeActiveContent(any activeContent)
|
BaseContent
|
removeAllCategories()
|
BaseContent
|
removeAllLinkedContent()
|
BaseContent
|
removeCategories(any category)
Bi directional remove. |
boolean
|
removeChild(any child)
|
boolean
|
removeComment(any comment)
|
boolean
|
removeCommentSubscription(any commentSubscription)
|
boolean
|
removeContentVersion(any contentVersion)
|
boolean
|
removeCustomField(any customField)
|
boolean
|
removeLinkedContent(any linkedContent)
|
boolean
|
removeRelatedContent(any relatedContent)
|
any
|
renderContent()
Render content out using translations, caching, etc. |
any
|
renderContentSilent([any content='[runtime expression]'])
Renders the content silently so no caching, or extra fluff is done, just content translation rendering. |
any
|
setActiveContent(array activeContent)
|
any
|
setAllowComments(any allowComments)
|
any
|
setCache(any cache)
|
any
|
setCachebox(any cachebox)
|
any
|
setCacheLastAccessTimeout(any cacheLastAccessTimeout)
|
any
|
setCacheLayout(any cacheLayout)
|
any
|
setCacheTimeout(any cacheTimeout)
|
BaseContent
|
setCategories(array categories)
Override the setCategories. |
any
|
setCategoryService(any categoryService)
|
BaseContent
|
setChildren(array children)
Override the setChildren. |
BaseContent
|
setComments(array comments)
Override the setComments. |
any
|
setCommentSubscriptions(array commentSubscriptions)
|
any
|
setContentService(any contentService)
|
BaseContent
|
setContentVersions(array contentVersions)
Override the setContentVersions. |
any
|
setContentVersionService(any contentVersionService)
|
any
|
setCreatedDate(any createdDate)
|
any
|
setCreator(any creator)
|
BaseContent
|
setCustomFields(array customFields)
Override the setCustomFields. |
any
|
setCustomFieldService(any customFieldService)
|
any
|
setExpireDate(any expireDate)
|
any
|
setHits(any hits)
|
any
|
setHTMLDescription(any HTMLDescription)
|
any
|
setHTMLKeywords(any HTMLKeywords)
|
any
|
setInterceptorService(any interceptorService)
|
any
|
setIsPublished(any isPublished)
|
any
|
setLinkedContent(array linkedContent)
|
any
|
setMarkup(any markup)
|
any
|
setNumberOfApprovedComments(any numberOfApprovedComments)
|
any
|
setNumberOfChildren(any numberOfChildren)
|
any
|
setNumberOfComments(any numberOfComments)
|
any
|
setNumberOfVersions(any numberOfVersions)
|
any
|
setParent(any parent)
|
any
|
setPasswordProtection(any passwordProtection)
|
any
|
setPublishedDate(any publishedDate)
|
BaseContent
|
setRelatedContent(array relatedContent)
Override the setRelatedContent. |
any
|
setRenderedContent(any renderedContent)
|
any
|
setSettingService(any settingService)
|
any
|
setSlug(any slug)
|
any
|
setTitle(any title)
|
| Methods inherited from class railo-context.Component |
|---|
| None |
| Constructor Detail |
|---|
Base constructor
| Property Detail |
|---|
required - falseinverse - truefieldtype - one-to-manycascade - save-updatefkcolumn - FK_contentIDserializable - truecfc - contentbox.model.content.ContentVersionwhere - isActive=1lazy - extrarequired - falsenotnull - trueormtype - booleanserializable - truerequired - falsenotnull - trueormtype - booleanindex - idx_cacheserializable - truerequired - falseinject - cacheboxpersistent - falseserializable - truerequired - falsenotnull - falseormtype - integerindex - idx_cachelastaccesstimeoutserializable - truerequired - falsenotnull - trueormtype - booleanindex - idx_cachelayoutserializable - truerequired - falsenotnull - falseormtype - integerindex - idx_cachetimeoutserializable - truelinktable - cb_contentCategoriesrequired - falseinverse - truefieldtype - many-to-manycascade - allorderby - categoryfkcolumn - FK_contentIDserializable - trueinversejoincolumn - FK_categoryIDcfc - contentbox.model.content.Categorylazy - extrarequired - falseinject - categoryService@cbpersistent - falseserializable - truerequired - falseinverse - truefieldtype - one-to-manycascade - all-delete-orphanorderby - createdDatebatchsize - 25singularname - childfkcolumn - FK_parentIDserializable - truecfc - contentbox.model.content.BaseContentlazy - extrarequired - falseinverse - truefieldtype - one-to-manycascade - all-delete-orphanorderby - createdDatebatchsize - 25singularname - commentfkcolumn - FK_contentIDserializable - truecfc - contentbox.model.comments.Commentlazy - extrarequired - falseinverse - truefieldtype - one-to-manycascade - all-delete-orphanbatchsize - 25singularname - commentSubscriptionfkcolumn - FK_contentIDserializable - truecfc - contentbox.model.subscriptions.CommentSubscriptionlazy - extrarequired - falsefieldtype - idnotnull - truegenerator - nativeserializable - truesetter - norequired - falseinject - contentService@cbpersistent - falseserializable - truerequired - falseinsert - falseupdate - falseindex - idx_discriminator,idx_publishedserializable - truesetter - norequired - falseinverse - truefieldtype - one-to-manycascade - all-delete-orphanbatchsize - 25singularname - contentVersionfkcolumn - FK_contentIDserializable - truecfc - contentbox.model.content.ContentVersionlazy - extrarequired - falseinject - contentVersionService@cbpersistent - falseserializable - truerequired - falsenotnull - trueormtype - timestampupdate - falseindex - idx_createdDateserializable - truerequired - falsefieldtype - many-to-onefetch - joinnotnull - truefkcolumn - FK_authorIDserializable - truecfc - contentbox.model.security.Authorlazy - truerequired - falseinverse - truefieldtype - one-to-manycascade - all-delete-orphanbatchsize - 25singularname - customFieldfkcolumn - FK_contentIDserializable - truecfc - contentbox.model.content.CustomFieldlazy - extrarequired - falseinject - customFieldService@cbpersistent - falseserializable - truerequired - falsenotnull - falseormtype - timestampindex - idx_expireDateserializable - truerequired - falsenotnull - falseormtype - longserializable - truerequired - falsenotnull - falselength - 160serializable - truerequired - falsenotnull - falselength - 160serializable - truerequired - falseinject - coldbox:interceptorServicepersistent - falseserializable - truerequired - falsenotnull - trueormtype - booleanindex - idx_published,idx_search,idx_publishedSlugserializable - truelinktable - cb_relatedContentrequired - falseinverse - truefieldtype - many-to-manyorderby - titlefkcolumn - FK_relatedContentIDserializable - trueinversejoincolumn - FK_contentIDcfc - contentbox.model.content.BaseContentlazy - extrarequired - falsenotnull - truelength - 100serializable - truerequired - falseformula - select count(*) from cb_comment comment where comment.FK_contentID=contentID and comment.isApproved = 1serializable - truerequired - falseformula - select count(*) from cb_content content where content.FK_parentID=contentIDserializable - truerequired - falseformula - select count(*) from cb_comment comment where comment.FK_contentID=contentIDserializable - truerequired - falseformula - select count(*) from cb_contentVersion cv where cv.FK_contentID=contentIDserializable - truerequired - falsefieldtype - many-to-onefkcolumn - FK_parentIDserializable - truecfc - contentbox.model.content.BaseContentlazy - truerequired - falsenotnull - falseindex - idx_publishedlength - 100serializable - truerequired - falsenotnull - falseormtype - timestampindex - idx_publishedDateserializable - truelinktable - cb_relatedContentrequired - falsefieldtype - many-to-manycascade - allorderby - titlefkcolumn - FK_contentIDserializable - trueinversejoincolumn - FK_relatedContentIDcfc - contentbox.model.content.BaseContentlazy - extrarequired - falsepersistent - falseserializable - truerequired - falseinject - id:settingService@cbpersistent - falseserializable - trueunique - truerequired - falsenotnull - trueindex - idx_slug,idx_publishedSluglength - 200serializable - truerequired - falsenotnull - trueindex - idx_searchlength - 200serializable - true| Method Detail |
|---|
activeContentBi directional add
categorychildcommentcommentSubscriptioncontentVersioncustomFieldadd expired timestamp to property
hourminutelinkedContentAdd a new content version to save for this content object
contentchangelogauthoradd published timestamp to property
hourminuterelatedContentBuild content cache keys according to sent content object
Verify we can do content caching on this content object using global and local rules
Shorthand Author from latest version or null if any yet
Shorthand Author email from latest version
Shorthand Author name from latest version
get flat categories list
Shorthand Creator email
Shorthand Creator name
Shortcut to get a custom field value
key - The custom field key to getdefaultValue - The default value if the key is not found.Get custom fields as a structure representation
Get formatted createdDate
Get formatted expireDate
Get display publishedDate
Get display expireDate
showTimeGet a flat representation of this entry slugCache.hint Cache of slugs to prevent infinite recursions
slugCachecounterGet parent ID if set or empty if none
Get parent name or empty if none
Get display publishedDate
showTimeGet recursive slug paths to get ancestry, DEPRECATED.
separatorReturns a list of active related content for this piece of content
activeContentcategorieschildcommentcommentSubscriptioncontentVersioncreatorcustomFieldlinkedContentparentrelatedContentInflate custom fields from the incoming count and memento structure
fieldCountmementoInflates from comma-delimited list (or array) of id's
relatedContent - The list or array of relatedContent idsBit that denotes if the content has been published or not
Bit that denotes if the content has expired or not, in order to be expired the content must have been published as well
is loaded?
isPassword Protected
Bit that denotes if the content has been published or not in the future
Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies
author - The author doing the cloningoriginal - The original content object that will be cloned into this content objectoriginalService - The ContentBox content service objectpublish - Publish pages or leave as draftsoriginalSlugRoot - The original slug that will be replaced in all cloned contentnewSlugRoot - The new slug root that will be replaced in all cloned contentactiveContentBi directional remove
categorychildcommentcommentSubscriptioncontentVersioncustomFieldlinkedContentrelatedContentRender content out using translations, caching, etc.
Renders the content silently so no caching, or extra fluff is done, just content translation rendering.
content - The content markup to translate, by default it uses the active content version's contentactiveContentallowCommentscachecacheboxcacheLastAccessTimeoutcacheLayoutcacheTimeoutOverride the setCategories
categoriescategoryServiceOverride the setChildren
childrenOverride the setComments
commentscommentSubscriptionscontentServiceOverride the setContentVersions
contentVersionscontentVersionServicecreatedDatecreatorOverride the setCustomFields
customFieldscustomFieldServiceexpireDatehitsHTMLDescriptionHTMLKeywordsinterceptorServiceisPublishedlinkedContentmarkupnumberOfApprovedCommentsnumberOfChildrennumberOfCommentsnumberOfVersionsparentpasswordProtectionpublishedDateOverride the setRelatedContent
relatedContent - The related content to setrenderedContentsettingServiceslugtitle