CommentsExtension
class CommentsExtension extends DataExtension (View source)
Extension to DataObject to enable tracking comments.
Properties
| protected | SS_Object | $owner | The object this extension is applied to. |
from Extension |
| protected | DataObject | $ownerBaseClass | The base class that this extension was applied to; $this->owner must be one of these |
from Extension |
| public | $class | from Extension |
Methods
Called when this extension is added to a particular class
Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().
Update the database schema as required by this extension.
CMS configurable options should default to the config values, but respect default values specified by the object
Define extra database fields
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
If this extension is applied to a SiteTree record then append a Provide Comments checkbox to allow authors to trigger whether or not to display comments
Returns the RelationList of all comments against this object. Can be used as a data source for a gridfield with write access.
Returns all comments against this object, with with spam and unmoderated items excluded, for use in the frontend
Returns the root level comments, with spam and unmoderated items excluded, for use in the frontend
Returns a paged list of the root level comments, with spam and unmoderated items excluded, for use in the frontend
Check if comments are configured for this page even if they are currently disabled.
Permission codes required in order to post (or empty if none required)
Determine if this member can moderate comments in the CMS
Comments interface for the front end. Includes the CommentAddForm and the composition of the comments display.
Returns whether this extension instance is attached to a SiteTree object
Details
__construct()
No description
static
add_to_class(string $class, string $extensionClass, mixed $args = null)
Called when this extension is added to a particular class
setOwner(SS_Object $owner, string $ownerBaseClass = null)
Set the owner of this extension.
clearOwner()
No description
SS_Object
getOwner()
Returns the owner of this extension.
static string
get_classname_without_arguments(string $extensionStr)
Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().
static
get_extra_config($class, $extension, $args)
No description
static
unload_extra_statics($class, $extension)
No description
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLQuery $query)
Edit the given query object to support queries for this extension
augmentDatabase()
Update the database schema as required by this extension.
When duplicating a table's structure, remember to duplicate the create options as well. See Versioned->augmentDatabase for an example.
augmentWrite(array $manipulation)
Augment a write-record request.
onBeforeWrite()
No description
onAfterWrite()
No description
onBeforeDelete()
No description
onAfterDelete()
No description
requireDefaultRecords()
No description
populateDefaults()
CMS configurable options should default to the config values, but respect default values specified by the object
can($member)
No description
canEdit($member)
No description
canDelete($member)
No description
canCreate($member)
No description
array
extraStatics($class = null, $extension = null)
Define extra database fields
Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.
updateCMSFields(FieldList $fields)
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().
Please consider using updateFormFields() to globally add formfields to the record. The method updateCMSFields() should just be used to add or modify tabs, or fields which are specific to the CMS-context.
Caution: Use FieldList->addFieldToTab() to add fields.
updateFrontEndFields(FieldList $fields)
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
Caution: Use FieldList->push() to add fields.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
updateSummaryFields(array $fields)
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
updateFieldLabels(array $labels)
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
updateSettingsFields(FieldList $fields)
If this extension is applied to a SiteTree record then append a Provide Comments checkbox to allow authors to trigger whether or not to display comments
string
getModerationRequired()
Get comment moderation rules for this parent
None: No moderation required Required: All comments NonMembersOnly: Only anonymous users
bool
getCommentsRequireLogin()
Determine if users must be logged in to post comments
CommentList
AllComments()
Returns the RelationList of all comments against this object. Can be used as a data source for a gridfield with write access.
CommentList
AllVisibleComments()
Returns all comments against this object, with with spam and unmoderated items excluded, for use in the frontend
CommentList
Comments()
Returns the root level comments, with spam and unmoderated items excluded, for use in the frontend
PaginatedList
PagedComments()
Returns a paged list of the root level comments, with spam and unmoderated items excluded, for use in the frontend
bool
getCommentsConfigured()
deprecated
deprecated
Check if comments are configured for this page even if they are currently disabled.
Do not include the comments on pages which don't have id's such as security pages
bool
getCommentsEnabled()
Determine if comments are enabled for this instance
string
getCommentHolderID()
Get the HTML ID for the comment holder in the template
getPostingRequiresPermission()
deprecated
deprecated
No description
string|array
getPostingRequiredPermission()
Permission codes required in order to post (or empty if none required)
canPost()
No description
bool
canPostComment(Member $member = null)
Determine if a user can post comments on this item
bool
canModerateComments(Member $member = null)
Determine if this member can moderate comments in the CMS
getRssLink()
No description
string
getCommentRSSLink()
Gets the RSS link to all comments
getRssLinkPage()
No description
string
getCommentRSSLinkPage()
Get the RSS link to all comments on this page
CommentsForm()
Comments interface for the front end. Includes the CommentAddForm and the composition of the comments display.
To customize the html see templates/CommentInterface.ss or extend this function with your own extension.
bool
attachedToSiteTree()
Returns whether this extension instance is attached to a SiteTree object
PageComments()
deprecated
deprecated
No description
mixed
getCommentsOption(string $key)
Get the commenting option for this object
This can be overridden in any instance or extension to customise the option available
protected
updateModerationFields(FieldList $fields)
Add moderation functions to the current fieldlist