class CommentsExtension extends DataExtension (View source)

Extension to DataObject to enable tracking comments.

Properties

DataObject $owner from  DataExtension

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
object
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

public static 
unload_extra_statics($class, $extension) deprecated

No description

public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

public
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

public
augmentDatabase()

Update the database schema as required by this extension.

public
augmentWrite(array $manipulation)

Augment a write-record request.

public
onBeforeWrite()

Extend the owner's onBeforeWrite() logic

public
onAfterWrite()

Extend the owner's onAfterWrite() logic

public
onBeforeDelete()

Extend the owner's onBeforeDelete() logic

public
onAfterDelete()

Extend the owner's onAfterDelete() logic

public
requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

public
populateDefaults()

CMS configurable options should default to the config values, but respect default values specified by the object

public
onAfterBuild()

Extend the owner's onAfterBuild() logic

public
bool|null
can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canEdit(Member $member)

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

public
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().

public
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

public
updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

public
updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

public
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']

public
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']

public
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

public
string
getModerationRequired()

Get comment moderation rules for this parent

public
bool
getCommentsRequireLogin()

Determine if users must be logged in to post comments

public
AllComments()

Returns the RelationList of all comments against this object. Can be used as a data source for a gridfield with write access.

public
AllVisibleComments()

Returns all comments against this object, with with spam and unmoderated items excluded, for use in the frontend

public
Comments()

Returns the root level comments, with spam and unmoderated items excluded, for use in the frontend

public
PagedComments()

Returns a paged list of the root level comments, with spam and unmoderated items excluded, for use in the frontend

public
bool
getCommentsEnabled()

Determine if comments are enabled for this instance

public
string
getCommentHolderID()

Get the HTML ID for the comment holder in the template

public
string|array
getPostingRequiredPermission()

Permission codes required in order to post (or empty if none required)

public
bool
canPostComment(Member $member = null)

Determine if a user can post comments on this item

public
bool
canModerateComments(Member $member = null)

Determine if this member can moderate comments in the CMS

public
string
getCommentRSSLink()

Gets the RSS link to all comments

public
string
getCommentRSSLinkPage()

Get the RSS link to all comments on this page

public
CommentsForm()

Comments interface for the front end. Includes the CommentAddForm and the composition of the comments display.

public
bool
attachedToSiteTree()

Returns whether this extension instance is attached to a SiteTree object

public
mixed
getCommentsOption(string $key)

Get the commenting option for this object.

public
array
getCommentsOptions()

No description

protected
updateModerationFields(FieldList $fields)

Add moderation functions to the current fieldlist

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

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

object getOwner()

Returns the owner of this extension.

Return Value

object

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

static unload_extra_statics($class, $extension) deprecated

deprecated 4.7.0 Will be removed without equivalent functionality

No description

Parameters

$class
$extension

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query

Query to augment.

DataQuery $dataQuery

Container DataQuery for this SQLSelect

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.

Parameters

array $manipulation

Array of operations to augment.

onBeforeWrite()

Extend the owner's onBeforeWrite() logic

See DataObject::onBeforeWrite() for context.

onAfterWrite()

Extend the owner's onAfterWrite() logic

See DataObject::onAfterWrite() for context.

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

onAfterDelete()

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

populateDefaults()

CMS configurable options should default to the config values, but respect default values specified by the object

onAfterBuild()

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

bool|null can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::can()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canEdit(Member $member)

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canEdit()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canDelete()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canCreate()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

array extraStatics(string $class = null, string $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.

Parameters

string $class

since this method might be called on the class directly

string $extension

since this can help to extract parameters to help set indexes

Return Value

array

Returns 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.

Parameters

FieldList $fields

FieldList with a contained TabSet

void updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

Caution: Use CompositeValidator->addValidator() to add Validators.

Parameters

CompositeValidator $compositeValidator

Return Value

void

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.

Parameters

FieldList $fields

FieldList without TabSet nesting

updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

Parameters

FieldList $actions FieldList

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']

Parameters

array $fields

Array of field names

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']

Parameters

array $labels

Array of 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

Allow customization of other {@link Commenting} configuration

Parameters

FieldList $fields

string getModerationRequired()

Get comment moderation rules for this parent

None: No moderation required Required: All comments NonMembersOnly: Only anonymous users

Return Value

string

bool getCommentsRequireLogin()

Determine if users must be logged in to post comments

Return Value

bool

DataList AllComments()

Returns the RelationList of all comments against this object. Can be used as a data source for a gridfield with write access.

Return Value

DataList

DataList AllVisibleComments()

Returns all comments against this object, with with spam and unmoderated items excluded, for use in the frontend

Return Value

DataList

DataList Comments()

Returns the root level comments, with spam and unmoderated items excluded, for use in the frontend

Return Value

DataList

PaginatedList PagedComments()

Returns a paged list of the root level comments, with spam and unmoderated items excluded, for use in the frontend

Return Value

PaginatedList

bool getCommentsEnabled()

Determine if comments are enabled for this instance

Return Value

bool

string getCommentHolderID()

Get the HTML ID for the comment holder in the template

Return Value

string

string|array getPostingRequiredPermission()

Permission codes required in order to post (or empty if none required)

Return Value

string|array

Permission or list of permissions, if required

bool canPostComment(Member $member = null)

Determine if a user can post comments on this item

Parameters

Member $member

Member to check

Return Value

bool

bool canModerateComments(Member $member = null)

Determine if this member can moderate comments in the CMS

Parameters

Member $member

Return Value

bool

Gets the RSS link to all comments

Return Value

string

string getCommentRSSLinkPage()

Get the RSS link to all comments on this page

Return Value

string

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.

Cleanup the passing of all this configuration based functionality

See also

docs/en/Extending

bool attachedToSiteTree()

Returns whether this extension instance is attached to a SiteTree object

Return Value

bool

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.

Parameters

string $key

Return Value

mixed

Result if the setting is available, or null otherwise

array getCommentsOptions()

No description

Return Value

array

protected updateModerationFields(FieldList $fields)

Add moderation functions to the current fieldlist

Parameters

FieldList $fields