|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.content.CustomHTML
public class CustomHTML
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* I model a custom HTML content piece
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
cache
Attributes:
|
true
|
true
|
false
|
any
|
cacheLastAccessTimeout
Attributes:
|
0
|
true
|
false
|
any
|
cacheTimeout
Attributes:
|
0
|
true
|
false
|
any
|
cachebox
Attributes:
|
|
true
|
false
|
any
|
content
Attributes:
|
|
true
|
false
|
any
|
contentID
Attributes:
|
|
true
|
false
|
any
|
createdDate
Attributes:
|
|
true
|
false
|
any
|
creator
Attributes:
|
|
true
|
false
|
any
|
description
Attributes:
|
|
true
|
false
|
any
|
expireDate
Attributes:
|
|
true
|
false
|
any
|
interceptorService
Attributes:
|
|
true
|
false
|
any
|
isPublished
Attributes:
|
true
|
true
|
false
|
any
|
markup
Attributes:
|
html
|
true
|
false
|
any
|
populator
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
|
Constructor Summary | |
---|---|
init()
constructor |
Method Summary | |
---|---|
any |
GETCACHE()
|
any |
GETCACHEBOX()
|
any |
GETCACHELASTACCESSTIMEOUT()
|
any |
GETCACHETIMEOUT()
|
any |
GETCONTENT()
|
any |
GETCONTENTID()
|
any |
GETCREATEDDATE()
|
any |
GETCREATOR()
|
any |
GETDESCRIPTION()
|
any |
GETEXPIREDATE()
|
any |
GETINTERCEPTORSERVICE()
|
any |
GETISPUBLISHED()
|
any |
GETMARKUP()
|
any |
GETPOPULATOR()
|
any |
GETPUBLISHEDDATE()
|
any |
GETRENDEREDCONTENT()
|
any |
GETSETTINGSERVICE()
|
any |
GETSLUG()
|
any |
GETTITLE()
|
boolean |
HASCREATOR()
|
CustomHTML |
SETCACHE(any cache)
|
CustomHTML |
SETCACHEBOX(any cachebox)
|
CustomHTML |
SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
|
CustomHTML |
SETCACHETIMEOUT(any cacheTimeout)
|
CustomHTML |
SETCONTENT(any content)
|
CustomHTML |
SETCREATEDDATE(any createdDate)
|
CustomHTML |
SETCREATOR(any creator)
|
CustomHTML |
SETDESCRIPTION(any description)
|
CustomHTML |
SETEXPIREDATE(any expireDate)
|
CustomHTML |
SETINTERCEPTORSERVICE(any interceptorService)
|
CustomHTML |
SETISPUBLISHED(any isPublished)
|
CustomHTML |
SETMARKUP(any markup)
|
CustomHTML |
SETPOPULATOR(any populator)
|
CustomHTML |
SETPUBLISHEDDATE(any publishedDate)
|
CustomHTML |
SETRENDEREDCONTENT(any renderedContent)
|
CustomHTML |
SETSETTINGSERVICE(any settingService)
|
CustomHTML |
SETSLUG(any slug)
|
CustomHTML |
SETTITLE(any title)
|
any |
addExpiredTime(any hour, any minute)
add expired timestamp to property |
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 |
string |
getCreatorEmail()
Shorthand Creator email |
string |
getCreatorName()
Shorthand Creator name |
string |
getDisplayCreatedDate()
Get formatted createdDate |
string |
getDisplayPublishedDate()
Get display publishedDate |
string |
getExpireDateForEditor([boolean showTime='false'])
Get display expireDate |
any |
getMemento()
Get memento representation |
string |
getPublishedDateForEditor([boolean showTime='false'])
Get display publishedDate |
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 |
isPublishedInFuture()
Bit that denotes if the content has been published or not in the future |
void |
preInsert()
|
CustomHTML |
prepareForClone(any author, any original, any originalService, boolean publish)
Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies |
any |
renderContent()
Render content out |
any |
renderContentSilent([any content='[runtime expression]'])
Renders the content silently so no caching, or extra fluff is done, just content translation rendering |
array |
validate()
|
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any cache
index
- idx_cacheormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 1default
- trueany cacheLastAccessTimeout
index
- idx_cachelastaccesstimeoutormtype
- integerserializable
- truerequired
- falsenotnull
- falsedbdefault
- 0default
- 0any cacheTimeout
index
- idx_cachetimeoutormtype
- integerserializable
- truerequired
- falsenotnull
- falsedbdefault
- 0default
- 0any cachebox
inject
- cacheboxserializable
- truerequired
- falsepersistent
- falsedefault
- any content
ormtype
- textserializable
- truerequired
- falsenotnull
- truelength
- 8000default
- any contentID
generator
- nativefieldtype
- idserializable
- truerequired
- falsedefault
- setter
- falseany createdDate
update
- falseindex
- idx_createdDateormtype
- timestampserializable
- truerequired
- falsenotnull
- truedefault
- any creator
fieldtype
- many-to-onefetch
- joinserializable
- truerequired
- falsenotnull
- falselazy
- truecfc
- contentbox.model.security.Authordefault
- fkcolumn
- FK_authorIDany description
serializable
- truerequired
- falsenotnull
- falselength
- 500default
- any expireDate
index
- idx_expireDateormtype
- timestampserializable
- truerequired
- falsenotnull
- falsedefault
- any interceptorService
inject
- coldbox:interceptorServiceserializable
- truerequired
- falsepersistent
- falsedefault
- any isPublished
index
- idx_published,idx_searchormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 1default
- trueany markup
serializable
- truerequired
- falsenotnull
- truedbdefault
- 'HTML'length
- 100default
- htmlany populator
inject
- wirebox:populatorserializable
- truerequired
- falsepersistent
- falsedefault
- any publishedDate
index
- idx_published,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_customHTML_slugunique
- trueserializable
- truerequired
- falsenotnull
- truelength
- 200default
- any title
serializable
- truerequired
- falsenotnull
- truelength
- 200default
- Method Detail |
---|
public any GETCACHE()
public any GETCACHEBOX()
public any GETCACHELASTACCESSTIMEOUT()
public any GETCACHETIMEOUT()
public any GETCONTENT()
public any GETCONTENTID()
public any GETCREATEDDATE()
public any GETCREATOR()
public any GETDESCRIPTION()
public any GETEXPIREDATE()
public any GETINTERCEPTORSERVICE()
public any GETISPUBLISHED()
public any GETMARKUP()
public any GETPOPULATOR()
public any GETPUBLISHEDDATE()
public any GETRENDEREDCONTENT()
public any GETSETTINGSERVICE()
public any GETSLUG()
public any GETTITLE()
public boolean HASCREATOR()
public CustomHTML SETCACHE(any cache)
cache
public CustomHTML SETCACHEBOX(any cachebox)
cachebox
public CustomHTML SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
cacheLastAccessTimeout
public CustomHTML SETCACHETIMEOUT(any cacheTimeout)
cacheTimeout
public CustomHTML SETCONTENT(any content)
content
public CustomHTML SETCREATEDDATE(any createdDate)
createdDate
public CustomHTML SETCREATOR(any creator)
creator
public CustomHTML SETDESCRIPTION(any description)
description
public CustomHTML SETEXPIREDATE(any expireDate)
expireDate
public CustomHTML SETINTERCEPTORSERVICE(any interceptorService)
interceptorService
public CustomHTML SETISPUBLISHED(any isPublished)
isPublished
public CustomHTML SETMARKUP(any markup)
markup
public CustomHTML SETPOPULATOR(any populator)
populator
public CustomHTML SETPUBLISHEDDATE(any publishedDate)
publishedDate
public CustomHTML SETRENDEREDCONTENT(any renderedContent)
renderedContent
public CustomHTML SETSETTINGSERVICE(any settingService)
settingService
public CustomHTML SETSLUG(any slug)
slug
public CustomHTML SETTITLE(any title)
title
public any addExpiredTime(any hour, any minute)
hour
minute
public any addPublishedTime(any hour, any minute)
hour
minute
public string buildContentCacheKey()
public boolean canCacheContent()
public string getCreatorEmail()
public string getCreatorName()
public string getDisplayCreatedDate()
public string getDisplayPublishedDate()
public string getExpireDateForEditor([boolean showTime='false'])
showTime
public any getMemento()
public string getPublishedDateForEditor([boolean showTime='false'])
showTime
public boolean isContentPublished()
public boolean isExpired()
public boolean isLoaded()
public boolean isPublishedInFuture()
public void preInsert()
public CustomHTML prepareForClone(any author, any original, any originalService, boolean publish)
author
- The author doing the cloningoriginal
- The original content object that will be cloned into this content objectoriginalService
- The ContentBox content service object usedpublish
- Publish pages or leave as draftspublic 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 array validate()
|
ContentBox Core API 1.6.0 | ||||
FRAMES |