lucee.Componentcborm.models.BaseORMService
cborm.models.VirtualEntityService
contentbox.models.comments.CommentService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Service to handle comment operations.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
CBHelper
|
true
|
false
|
|
any
|
interceptorService
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
mailService
|
true
|
false
|
|
any
|
renderer
|
true
|
false
|
|
any
|
securityService
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
private boolean
|
anyKeywordMatch([any comment], [any matchList])
Regex matching of a list of entries against a comment and matching keyword list. |
any
|
bulkStatus([any commentID], [any status=''])
Bulk Updates. |
CommentService
|
deleteUnApproved([numeric expirationDays='0'])
Deletes unapproved comments. |
struct
|
findAllApproved([any contentID], [any contentType], [any max='0'], [any offset='0'], [string sortOrder='desc'], [string siteID=''])
Comment listing for UI of approved comments, returns struct of results=[comments,count]. |
numeric
|
getApprovedCount([string siteID=''])
Get the total number of approved comments in the system. |
numeric
|
getTotalCount([string siteID=''])
Get the total comment counts in the system. |
numeric
|
getTotalCountByContent([string contentId=''], [boolean isApproved])
Get the total comment counts by content object. |
numeric
|
getUnApprovedCount([string siteID=''])
Get the total number of unapproved comments in the system. |
private boolean
|
runModerationRules(any comment, any settings)
Run moderation rules on an incoming comment and set of contentbox settings. |
struct
|
saveComment(any comment, any loggedInUser)
Save a comment according to our rules and process it. |
struct
|
search([any search=''], [any isApproved], [any contentID], [numeric max='0'], [numeric offset='0'], [any sortOrder='createdDate DESC'], [string siteID=''])
comment search returns struct with keys [comments,count]. |
private void
|
sendNotificationEmails(any comment, any siteSettings)
Send a notification email for comments. |
void
|
sendSubscriptionNotifications(any comment)
Sends subscription emails to subscribers of the content. |
private boolean
|
userHasPreviousAcceptedComment(any email)
Check if the user has already a comment in the system. |
Methods inherited from class cborm.models.VirtualEntityService |
---|
autoCast, convertIdValueToJavaType, convertValueToJavaType, count, countWhere, deleteAll, deleteByID, deleteByQuery, deleteWhere, evictCollection, executeQuery, exists, findAllWhere, findWhere, get, getAll, getEntityName, getKey, getOrFail, getPropertyNames, getTableName, idCast, list, new, newCriteria, onMissingMethod, setEntityName |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- id:CBHelper@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:interceptorServiceserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- mailService@cbmailservicesserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:rendererserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:securityService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:settingService@contentboxserializable
- trueMethod Detail |
---|
Regex matching of a list of entries against a comment and matching keyword list
comment
matchList
Bulk Updates
commentID
- The list or array of ID's to bulk updatestatus
- The status either 'approve' or 'moderate'Deletes unapproved comments
expirationDays
- Required level of staleness in days to delete (0=all unapproved)Comment listing for UI of approved comments, returns struct of results=[comments,count]
contentID
- The content ID to filter oncontentType
- The content type discriminator to filter onmax
- The maximum number of records to return, 0 means alloffset
- The offset in the paging, 0 means 0sortOrder
- Sort the comments asc or desc, by default it is descsiteID
- The site to filter on if neededGet the total number of approved comments in the system
siteID
- The site to filter onGet the total comment counts in the system
siteID
- The site to filter onGet the total comment counts by content object
contentId
- The content id to filter onisApproved
- If passed, use it to filter onGet the total number of unapproved comments in the system
siteID
- The site to filter onRun moderation rules on an incoming comment and set of contentbox settings. If this method returns a false then the comment is moderated and can continue to be saved. If returns false, then it is blocked and must NOT be saved.
comment
- Comment to moderate checksettings
- The contentbox settings to moderate againstSave a comment according to our rules and process it. Returns a structure of information results = [moderated:boolean,messages:array]
comment
- The comment to try to saveloggedInUser
- The current logged in user making the comment. If no logged in User, this is a non-persisted entitycomment search returns struct with keys [comments,count]
search
- Search queryisApproved
- approved bitcontentID
- matching content idmax
- max recordsoffset
- offset for paginationsortOrder
- The sort order, defaults to `createdDate DESC`siteID
- The site to filter on if neededSend a notification email for comments
comment
- Comment to moderate checksiteSettings
- The contentbox site settings to moderate againstSends subscription emails to subscribers of the content
comment
- The comment objectCheck if the user has already a comment in the system
email
- The email address to check.