|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.content.BaseContent
public class BaseContent
A mapped super class used for contentbox content: entries and pages
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
HTMLDescription
Attributes:
|
|
true
|
false
|
any
|
HTMLKeywords
Attributes:
|
|
true
|
false
|
array
|
activeContent
Attributes:
|
|
true
|
false
|
any
|
allowComments
Attributes:
|
true
|
true
|
false
|
any
|
cache
Attributes:
|
true
|
true
|
false
|
any
|
cacheLastAccessTimeout
Attributes:
|
0
|
true
|
false
|
any
|
cacheLayout
Attributes:
|
true
|
true
|
false
|
any
|
cacheTimeout
Attributes:
|
0
|
true
|
false
|
any
|
cachebox
Attributes:
|
|
true
|
false
|
array
|
categories
Attributes:
|
|
true
|
false
|
any
|
categoryService
Attributes:
|
|
true
|
false
|
array
|
children
Attributes:
|
|
true
|
false
|
array
|
comments
Attributes:
|
|
true
|
false
|
any
|
contentID
Attributes:
|
|
true
|
false
|
any
|
contentService
Attributes:
|
|
true
|
false
|
any
|
contentType
Attributes:
|
|
true
|
false
|
any
|
contentVersionService
Attributes:
|
|
true
|
false
|
array
|
contentVersions
Attributes:
|
|
true
|
false
|
any
|
createdDate
Attributes:
|
|
true
|
false
|
any
|
creator
Attributes:
|
|
true
|
false
|
any
|
customFieldService
Attributes:
|
|
true
|
false
|
array
|
customFields
Attributes:
|
|
true
|
false
|
any
|
expireDate
Attributes:
|
|
true
|
false
|
any
|
hits
Attributes:
|
0
|
true
|
false
|
any
|
interceptorService
Attributes:
|
|
true
|
false
|
any
|
isPublished
Attributes:
|
true
|
true
|
false
|
any
|
markup
Attributes:
|
html
|
true
|
false
|
any
|
numberOfApprovedComments
Attributes:
|
0
|
true
|
false
|
any
|
numberOfChildren
Attributes:
|
0
|
true
|
false
|
any
|
numberOfComments
Attributes:
|
0
|
true
|
false
|
any
|
numberOfVersions
Attributes:
|
0
|
true
|
false
|
any
|
parent
Attributes:
|
|
true
|
false
|
any
|
passwordProtection
Attributes:
|
|
true
|
false
|
any
|
publishedDate
Attributes:
|
|
true
|
false
|
any
|
renderedContent
Attributes:
|
|
true
|
false
|
any
|
settingService
Attributes:
|
|
true
|
false
|
any
|
slug
Attributes:
|
|
true
|
false
|
any
|
title
Attributes:
|
|
true
|
false
|
Method Summary | |
---|---|
void |
ADDACTIVECONTENT(ContentVersion activeContent)
|
void |
ADDCHILD(BaseContent child)
|
void |
ADDCOMMENT(Comment comment)
|
void |
ADDCONTENTVERSION(ContentVersion contentVersion)
|
void |
ADDCUSTOMFIELD(CustomField customField)
|
any |
GETALLOWCOMMENTS()
|
any |
GETCACHE()
|
any |
GETCACHEBOX()
|
any |
GETCACHELASTACCESSTIMEOUT()
|
any |
GETCACHELAYOUT()
|
any |
GETCACHETIMEOUT()
|
array |
GETCATEGORIES()
|
any |
GETCATEGORYSERVICE()
|
array |
GETCHILDREN()
|
array |
GETCOMMENTS()
|
any |
GETCONTENTID()
|
any |
GETCONTENTSERVICE()
|
any |
GETCONTENTTYPE()
|
array |
GETCONTENTVERSIONS()
|
any |
GETCONTENTVERSIONSERVICE()
|
any |
GETCREATEDDATE()
|
any |
GETCREATOR()
|
array |
GETCUSTOMFIELDS()
|
any |
GETCUSTOMFIELDSERVICE()
|
any |
GETEXPIREDATE()
|
any |
GETHITS()
|
any |
GETHTMLDESCRIPTION()
|
any |
GETHTMLKEYWORDS()
|
any |
GETINTERCEPTORSERVICE()
|
any |
GETISPUBLISHED()
|
any |
GETMARKUP()
|
any |
GETNUMBEROFAPPROVEDCOMMENTS()
|
any |
GETNUMBEROFCHILDREN()
|
any |
GETNUMBEROFCOMMENTS()
|
any |
GETNUMBEROFVERSIONS()
|
any |
GETPARENT()
|
any |
GETPASSWORDPROTECTION()
|
any |
GETPUBLISHEDDATE()
|
any |
GETRENDEREDCONTENT()
|
any |
GETSETTINGSERVICE()
|
any |
GETSLUG()
|
any |
GETTITLE()
|
boolean |
HASACTIVECONTENT([ContentVersion activeContent])
|
boolean |
HASCATEGORIES([Category categories])
|
boolean |
HASCHILD([BaseContent children])
|
boolean |
HASCOMMENT([Comment comments])
|
boolean |
HASCONTENTVERSION([ContentVersion contentVersions])
|
boolean |
HASCREATOR()
|
boolean |
HASCUSTOMFIELD([CustomField customFields])
|
boolean |
HASPARENT()
|
boolean |
REMOVEACTIVECONTENT(ContentVersion activeContent)
|
boolean |
REMOVECHILD(BaseContent child)
|
boolean |
REMOVECOMMENT(Comment comment)
|
boolean |
REMOVECONTENTVERSION(ContentVersion contentVersion)
|
boolean |
REMOVECUSTOMFIELD(CustomField customField)
|
BaseContent |
SETACTIVECONTENT(array activeContent)
|
BaseContent |
SETALLOWCOMMENTS(any allowComments)
|
BaseContent |
SETCACHE(any cache)
|
BaseContent |
SETCACHEBOX(any cachebox)
|
BaseContent |
SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
|
BaseContent |
SETCACHELAYOUT(any cacheLayout)
|
BaseContent |
SETCACHETIMEOUT(any cacheTimeout)
|
BaseContent |
SETCATEGORYSERVICE(any categoryService)
|
BaseContent |
SETCONTENTSERVICE(any contentService)
|
BaseContent |
SETCONTENTVERSIONSERVICE(any contentVersionService)
|
BaseContent |
SETCREATEDDATE(any createdDate)
|
BaseContent |
SETCREATOR(any creator)
|
BaseContent |
SETCUSTOMFIELDSERVICE(any customFieldService)
|
BaseContent |
SETEXPIREDATE(any expireDate)
|
BaseContent |
SETHITS(any hits)
|
BaseContent |
SETHTMLDESCRIPTION(any HTMLDescription)
|
BaseContent |
SETHTMLKEYWORDS(any HTMLKeywords)
|
BaseContent |
SETINTERCEPTORSERVICE(any interceptorService)
|
BaseContent |
SETISPUBLISHED(any isPublished)
|
BaseContent |
SETMARKUP(any markup)
|
BaseContent |
SETNUMBEROFAPPROVEDCOMMENTS(any numberOfApprovedComments)
|
BaseContent |
SETNUMBEROFCHILDREN(any numberOfChildren)
|
BaseContent |
SETNUMBEROFCOMMENTS(any numberOfComments)
|
BaseContent |
SETNUMBEROFVERSIONS(any numberOfVersions)
|
BaseContent |
SETPARENT(any parent)
|
BaseContent |
SETPASSWORDPROTECTION(any passwordProtection)
|
BaseContent |
SETPUBLISHEDDATE(any publishedDate)
|
BaseContent |
SETRENDEREDCONTENT(any renderedContent)
|
BaseContent |
SETSETTINGSERVICE(any settingService)
|
BaseContent |
SETSLUG(any slug)
|
BaseContent |
SETTITLE(any title)
|
BaseContent |
addCategories(any category)
Bi directional add |
any |
addExpiredTime(any hour, any minute)
add expired timestamp to property |
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 |
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()
|
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 |
any |
getCategoriesList()
get flat categories list |
any |
getContent()
|
string |
getCreatorEmail()
Shorthand Creator email |
string |
getCreatorName()
Shorthand Creator name |
struct |
getCustomFieldsAsStruct()
Get custom fields as a structure representation |
string |
getDisplayCreatedDate()
Get formatted createdDate |
string |
getDisplayExpireDate()
Get formatted expireDate |
string |
getDisplayPublishedDate()
Get display publishedDate |
string |
getExpireDateForEditor([boolean showTime='false'])
Get display expireDate |
any |
getMemento()
Get a flat representation of this entry |
any |
getParentID()
Get parent ID if set or empty if none |
any |
getParentName()
Get parent name or empty if none |
string |
getPublishedDateForEditor([boolean showTime='false'])
Get display publishedDate |
any |
getRecursiveSlug([any separator='/'])
Get recursive slug paths to get ancestry, DEPRECATED |
any |
inflateCustomFields(numeric fieldCount, struct memento)
Inflate custom fields from the incoming count and memento structure |
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 |
BaseContent |
removeAllCategories()
|
BaseContent |
removeCategories(any category)
Bi directional remove |
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 |
BaseContent |
setCategories(array categories)
Override the setCategories |
BaseContent |
setChildren(array children)
Override the setChildren |
BaseContent |
setComments(array comments)
Override the setComments |
BaseContent |
setContentVersions(array contentVersions)
Override the setContentVersions |
BaseContent |
setCustomFields(array customFields)
Override the setCustomFields |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Property Detail |
---|
any HTMLDescription
serializable
- truerequired
- falsenotnull
- falselength
- 160default
- any HTMLKeywords
serializable
- truerequired
- falsenotnull
- falselength
- 160default
- array activeContent
inverse
- truewhere
- isActive=1serializable
- truelazy
- extradefault
- fieldtype
- one-to-manyrequired
- falsecascade
- save-updatecfc
- contentbox.model.content.ContentVersionfkcolumn
- FK_contentIDany allowComments
ormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 1default
- trueany cache
index
- idx_cacheormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 1default
- trueany cacheLastAccessTimeout
index
- idx_cachelastaccesstimeoutormtype
- integerserializable
- truerequired
- falsenotnull
- falsedbdefault
- 0default
- 0any cacheLayout
index
- idx_cachelayoutormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 1default
- trueany cacheTimeout
index
- idx_cachetimeoutormtype
- integerserializable
- truerequired
- falsenotnull
- falsedbdefault
- 0default
- 0any cachebox
inject
- cacheboxserializable
- truerequired
- falsepersistent
- falsedefault
- array categories
inverse
- trueserializable
- truelazy
- extradefault
- linktable
- cb_contentCategoriesfieldtype
- many-to-manyorderby
- categoryrequired
- falseinversejoincolumn
- FK_categoryIDcascade
- allcfc
- contentbox.model.content.Categoryfkcolumn
- FK_contentIDany categoryService
inject
- categoryService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- array children
inverse
- trueserializable
- truelazy
- extrabatchsize
- 25default
- fieldtype
- one-to-manysingularname
- childorderby
- createdDaterequired
- falsecascade
- all-delete-orphancfc
- contentbox.model.content.BaseContentfkcolumn
- FK_parentIDarray comments
inverse
- trueserializable
- truelazy
- extrabatchsize
- 25default
- fieldtype
- one-to-manysingularname
- commentorderby
- createdDaterequired
- falsecascade
- all-delete-orphancfc
- contentbox.model.comments.Commentfkcolumn
- FK_contentIDany contentID
generator
- nativefieldtype
- idserializable
- truerequired
- falsenotnull
- truedefault
- setter
- falseany contentService
inject
- contentService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- any contentType
update
- falseindex
- idx_discriminator,idx_publishedinsert
- falseserializable
- truerequired
- falsedbdefault
- setter
- falsedefault
- any contentVersionService
inject
- contentVersionService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- array contentVersions
inverse
- trueserializable
- truelazy
- extrabatchsize
- 25default
- fieldtype
- one-to-manysingularname
- contentVersionrequired
- falsecascade
- all-delete-orphancfc
- contentbox.model.content.ContentVersionfkcolumn
- FK_contentIDany createdDate
update
- falseindex
- idx_createdDateormtype
- timestampserializable
- truerequired
- falsenotnull
- truedefault
- any creator
fieldtype
- many-to-onefetch
- joinserializable
- truerequired
- falsenotnull
- truelazy
- truecfc
- contentbox.model.security.Authordefault
- fkcolumn
- FK_authorIDany customFieldService
inject
- customFieldService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- array customFields
inverse
- trueserializable
- truelazy
- extrabatchsize
- 25default
- fieldtype
- one-to-manysingularname
- customFieldrequired
- falsecascade
- all-delete-orphancfc
- contentbox.model.content.CustomFieldfkcolumn
- FK_contentIDany expireDate
index
- idx_expireDateormtype
- timestampserializable
- truerequired
- falsenotnull
- falsedefault
- any hits
ormtype
- longserializable
- truerequired
- falsenotnull
- falsedbdefault
- 0default
- 0any interceptorService
inject
- coldbox:interceptorServiceserializable
- truerequired
- falsepersistent
- falsedefault
- any isPublished
index
- idx_published,idx_search,idx_publishedSlugormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 1default
- trueany markup
serializable
- truerequired
- falsenotnull
- truedbdefault
- 'HTML'length
- 100default
- htmlany numberOfApprovedComments
formula
- select count(*) from cb_comment comment where comment.FK_contentID=contentID and comment.isApproved = 1required
- falseserializable
- truedefault
- 0any numberOfChildren
formula
- select count(*) from cb_content content where content.FK_parentID=contentIDrequired
- falseserializable
- truedefault
- 0any numberOfComments
formula
- select count(*) from cb_comment comment where comment.FK_contentID=contentIDrequired
- falseserializable
- truedefault
- 0any numberOfVersions
formula
- select count(*) from cb_contentVersion cv where cv.FK_contentID=contentIDrequired
- falseserializable
- truedefault
- 0any parent
fieldtype
- many-to-oneserializable
- truerequired
- falselazy
- truecfc
- contentbox.model.content.BaseContentdefault
- fkcolumn
- FK_parentIDany passwordProtection
index
- idx_publishedserializable
- truerequired
- falsenotnull
- falselength
- 100default
- any publishedDate
index
- idx_publishedDateormtype
- timestampserializable
- truerequired
- falsenotnull
- falsedefault
- any renderedContent
required
- falseserializable
- truepersistent
- falsedefault
- any settingService
inject
- id:settingService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- any slug
index
- idx_slug,idx_publishedSlugunique
- trueserializable
- truerequired
- falsenotnull
- truelength
- 200default
- any title
index
- idx_searchserializable
- truerequired
- falsenotnull
- truelength
- 200default
- Method Detail |
---|
public void ADDACTIVECONTENT(ContentVersion activeContent)
activeContent
public void ADDCHILD(BaseContent child)
child
public void ADDCOMMENT(Comment comment)
comment
public void ADDCONTENTVERSION(ContentVersion contentVersion)
contentVersion
public void ADDCUSTOMFIELD(CustomField customField)
customField
public any GETALLOWCOMMENTS()
public any GETCACHE()
public any GETCACHEBOX()
public any GETCACHELASTACCESSTIMEOUT()
public any GETCACHELAYOUT()
public any GETCACHETIMEOUT()
public array GETCATEGORIES()
public any GETCATEGORYSERVICE()
public array GETCHILDREN()
public array GETCOMMENTS()
public any GETCONTENTID()
public any GETCONTENTSERVICE()
public any GETCONTENTTYPE()
public array GETCONTENTVERSIONS()
public any GETCONTENTVERSIONSERVICE()
public any GETCREATEDDATE()
public any GETCREATOR()
public array GETCUSTOMFIELDS()
public any GETCUSTOMFIELDSERVICE()
public any GETEXPIREDATE()
public any GETHITS()
public any GETHTMLDESCRIPTION()
public any GETHTMLKEYWORDS()
public any GETINTERCEPTORSERVICE()
public any GETISPUBLISHED()
public any GETMARKUP()
public any GETNUMBEROFAPPROVEDCOMMENTS()
public any GETNUMBEROFCHILDREN()
public any GETNUMBEROFCOMMENTS()
public any GETNUMBEROFVERSIONS()
public any GETPARENT()
public any GETPASSWORDPROTECTION()
public any GETPUBLISHEDDATE()
public any GETRENDEREDCONTENT()
public any GETSETTINGSERVICE()
public any GETSLUG()
public any GETTITLE()
public boolean HASACTIVECONTENT([ContentVersion activeContent])
activeContent
public boolean HASCATEGORIES([Category categories])
categories
public boolean HASCHILD([BaseContent children])
children
public boolean HASCOMMENT([Comment comments])
comments
public boolean HASCONTENTVERSION([ContentVersion contentVersions])
contentVersions
public boolean HASCREATOR()
public boolean HASCUSTOMFIELD([CustomField customFields])
customFields
public boolean HASPARENT()
public boolean REMOVEACTIVECONTENT(ContentVersion activeContent)
activeContent
public boolean REMOVECHILD(BaseContent child)
child
public boolean REMOVECOMMENT(Comment comment)
comment
public boolean REMOVECONTENTVERSION(ContentVersion contentVersion)
contentVersion
public boolean REMOVECUSTOMFIELD(CustomField customField)
customField
public BaseContent SETACTIVECONTENT(array activeContent)
activeContent
public BaseContent SETALLOWCOMMENTS(any allowComments)
allowComments
public BaseContent SETCACHE(any cache)
cache
public BaseContent SETCACHEBOX(any cachebox)
cachebox
public BaseContent SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
cacheLastAccessTimeout
public BaseContent SETCACHELAYOUT(any cacheLayout)
cacheLayout
public BaseContent SETCACHETIMEOUT(any cacheTimeout)
cacheTimeout
public BaseContent SETCATEGORYSERVICE(any categoryService)
categoryService
public BaseContent SETCONTENTSERVICE(any contentService)
contentService
public BaseContent SETCONTENTVERSIONSERVICE(any contentVersionService)
contentVersionService
public BaseContent SETCREATEDDATE(any createdDate)
createdDate
public BaseContent SETCREATOR(any creator)
creator
public BaseContent SETCUSTOMFIELDSERVICE(any customFieldService)
customFieldService
public BaseContent SETEXPIREDATE(any expireDate)
expireDate
public BaseContent SETHITS(any hits)
hits
public BaseContent SETHTMLDESCRIPTION(any HTMLDescription)
HTMLDescription
public BaseContent SETHTMLKEYWORDS(any HTMLKeywords)
HTMLKeywords
public BaseContent SETINTERCEPTORSERVICE(any interceptorService)
interceptorService
public BaseContent SETISPUBLISHED(any isPublished)
isPublished
public BaseContent SETMARKUP(any markup)
markup
public BaseContent SETNUMBEROFAPPROVEDCOMMENTS(any numberOfApprovedComments)
numberOfApprovedComments
public BaseContent SETNUMBEROFCHILDREN(any numberOfChildren)
numberOfChildren
public BaseContent SETNUMBEROFCOMMENTS(any numberOfComments)
numberOfComments
public BaseContent SETNUMBEROFVERSIONS(any numberOfVersions)
numberOfVersions
public BaseContent SETPARENT(any parent)
parent
public BaseContent SETPASSWORDPROTECTION(any passwordProtection)
passwordProtection
public BaseContent SETPUBLISHEDDATE(any publishedDate)
publishedDate
public BaseContent SETRENDEREDCONTENT(any renderedContent)
renderedContent
public BaseContent SETSETTINGSERVICE(any settingService)
settingService
public BaseContent SETSLUG(any slug)
slug
public BaseContent SETTITLE(any title)
title
public BaseContent addCategories(any category)
category
public any addExpiredTime(any hour, any minute)
hour
minute
public any addNewContentVersion(any content, [any changelog=''], any author)
content
changelog
author
public any addPublishedTime(any hour, any minute)
hour
minute
public string buildContentCacheKey()
public boolean canCacheContent()
public any getActiveContent()
public any getAuthor()
public string getAuthorEmail()
public string getAuthorName()
public any getCategoriesList()
public any getContent()
public string getCreatorEmail()
public string getCreatorName()
public struct getCustomFieldsAsStruct()
public string getDisplayCreatedDate()
public string getDisplayExpireDate()
public string getDisplayPublishedDate()
public string getExpireDateForEditor([boolean showTime='false'])
showTime
public any getMemento()
public any getParentID()
public any getParentName()
public string getPublishedDateForEditor([boolean showTime='false'])
showTime
public any getRecursiveSlug([any separator='/'])
separator
public any inflateCustomFields(numeric fieldCount, struct memento)
fieldCount
memento
public boolean isContentPublished()
public boolean isExpired()
public boolean isLoaded()
public boolean isPasswordProtected()
public boolean isPublishedInFuture()
private any maxContentVersionChecks()
public BaseContent prepareForClone(any author, any original, any originalService, boolean publish, any originalSlugRoot, any newSlugRoot)
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 contentpublic BaseContent removeAllCategories()
public BaseContent removeCategories(any category)
category
public any renderContent()
public any renderContentSilent([any content='[runtime expression]'])
content
- The content markup to translate, by default it uses the active content version's contentpublic BaseContent setCategories(array categories)
categories
public BaseContent setChildren(array children)
children
public BaseContent setComments(array comments)
comments
public BaseContent setContentVersions(array contentVersions)
contentVersions
public BaseContent setCustomFields(array customFields)
customFields
|
ContentBox Core API 1.6.0 | ||||
FRAMES |