CommentsExtension
class CommentsExtension extends DataExtension (View source)
Extension to DataObject to enable tracking comments.
Properties
| DataObject | $owner | from DataExtension | 
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Edit the given query object to support queries for this 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
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.
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.
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.
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.
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 Validators used on a DataObject.
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
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(object $owner)
        
    
    Set the owner of this extension.
        
                            mixed
    withOwner(mixed $owner, callable $callback, array $args = [])
        
    
    Temporarily modify the owner. The original owner is ensured to be restored
        
                            
    clearOwner()
        
    
    Clear the current owner, and restore extension to the state prior to the last setOwner()
        
                            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 that's passed to DataObject::$extensions or Object::add_extension().
        
                static            
    unload_extra_statics($class, $extension)
        deprecated
    
    deprecated
No description
        
                            
    validate(ValidationResult $validationResult)
        
    
    Hook for extension-specific validation.
        
                            
    augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
        
    
    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()
        
    
    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.
        
                            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.
        
                            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.
        
                            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.
        
                            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.
        
                            
    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.
        
                            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.
        
                            
    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
        
                            DataList
    AllComments()
        
    
    Returns the RelationList of all comments against this object. Can be used as a data source for a gridfield with write access.
        
                            DataList
    AllVisibleComments()
        
    
    Returns all comments against this object, with with spam and unmoderated items excluded, for use in the frontend
        
                            DataList
    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
    getCommentsEnabled()
        
    
    Determine if comments are enabled for this instance
        
                            string
    getCommentHolderID()
        
    
    Get the HTML ID for the comment holder in the template
        
                            string|array
    getPostingRequiredPermission()
        
    
    Permission codes required in order to post (or empty if none required)
        
                            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
        
                            string
    getCommentRSSLink()
        
    
    Gets the RSS link to all comments
        
                            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
        
                            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.
        
                            array
    getCommentsOptions()
        
    
    No description
        
                    protected        
    updateModerationFields(FieldList $fields)
        
    
    Add moderation functions to the current fieldlist