1. class
  2. SilverStripe
  3. \
  4. CommentNotifications
  5. \
  6. Extensions
  7. \
  8. CommentNotifier

CommentNotifier

class CommentNotifier extends Extension (View source)

Extension applied to CommentingController to invoke notifications

Relies on the parent object to {see \SilverStripe\Comments\Model\Comment} having the {see \SilverStripe\CommentNotifications\Extensions\CommentNotifiable} extension applied..

Methods

__construct()

No description

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

Called when this extension is added to a particular class

from  Extension
setOwner(object $owner)

Set the owner of this extension.

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

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

from  Extension
clearOwner()

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

from  Extension
object
getOwner()

Returns the owner of this extension.

from  Extension
static string
get_classname_without_arguments(string $extensionStr)

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

from  Extension
onAfterPostComment(Comment $comment)

Notify Members of the post there is a new comment.

notifyCommentRecipient(Comment $comment, DataObject $parent, Member|string|array $recipient)

Send comment notification to a given recipient

Details

in Extension at line 39
__construct()

in Extension at line 50
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

in Extension at line 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

in Extension at line 74
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

in Extension at line 87
clearOwner()

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

in Extension at line 100
object getOwner()

Returns the owner of this extension.

Return Value

object

in Extension at line 113
static string get_classname_without_arguments(string $extensionStr)

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

Parameters

string $extensionStr

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

Return Value

string

Extension classname, e.g. "Versioned"

at line 23
onAfterPostComment(Comment $comment)

Notify Members of the post there is a new comment.

Parameters

Comment $comment

at line 47
notifyCommentRecipient(Comment $comment, DataObject $parent, Member|string|array $recipient)

Send comment notification to a given recipient

Parameters

Comment $comment
DataObject $parent

Object with the {see \SilverStripe\CommentNotifications\Extensions\CommentNotifiable} extension applied
Member|string|array $recipient

Either a member object or an email address towhich notifications should be sent