Class humhub\modules\comment\notifications\NewComment

Inheritancehumhub\modules\comment\notifications\NewComment » humhub\modules\notification\components\BaseNotification » humhub\components\SocialActivity » yii\base\BaseObject
ImplementsSerializable, humhub\components\rendering\Viewable
Available since version0.5

Notification for new comments

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$groupCount integer Number of combined notifications humhub\modules\notification\components\BaseNotification
$markAsSeenOnClick boolean Automatically mark notification as seen after click on it humhub\modules\notification\components\BaseNotification
$moduleId string The module id which this activity belongs to (required) humhub\modules\comment\notifications\NewComment
$originator humhub\modules\user\models\User humhub\components\SocialActivity
$priority boolean If set to true marks this notification type as high priority. humhub\modules\notification\components\BaseNotification
$record \yii\db\ActiveRecord The related record for this activitiy humhub\components\SocialActivity
$recordClass string Record class used for instantiation. humhub\components\SocialActivity
$requireOriginator boolean Ensure originator existence humhub\components\SocialActivity
$requireSource boolean Ensure source existence humhub\components\SocialActivity
$source \yii\db\ActiveRecord humhub\components\SocialActivity
$suppressSendToOriginator boolean Do not send this notification also to the originator humhub\modules\notification\components\BaseNotification
$viewName string View name used for rendering the activity humhub\modules\comment\notifications\NewComment

Public Methods

Hide inherited methods

MethodDescriptionDefined By
about() Builder function for the source. humhub\components\SocialActivity
asArray() Returns an array representation of this notification. humhub\components\SocialActivity
beforeMailSend() This method is invoked right before a mail will be send for this notificatoin humhub\modules\notification\components\BaseNotification
category() Returns a new NotificationCategory instance. humhub\modules\comment\notifications\NewComment
delete() Deletes this notification humhub\modules\notification\components\BaseNotification
from() Builder function for the originator. humhub\components\SocialActivity
getAsHtml() Use html() instead humhub\modules\notification\components\BaseNotification
getAsText() Use text() instead humhub\modules\notification\components\BaseNotification
getCategory() Returns the notification category instance. If no category class is set (default) the default notification settings can't be overwritten. humhub\modules\notification\components\BaseNotification
getCommentedRecord() The commented record e.g. a Post humhub\modules\comment\notifications\NewComment
getContent() Returns the related content instance in case the source is of type ContentOwner. humhub\components\SocialActivity
getContentContainer() Determines if the activity source is related to an ContentContainer. humhub\components\SocialActivity
getContentInfo() Build info text about a content humhub\components\SocialActivity
getContentName() Returns the content name of $content or if not $content is provided of the notification source. humhub\components\SocialActivity
getContentPreview() Returns a short preview text of the content. The max length can be defined by setting $maxLength (25 by default). humhub\components\SocialActivity
getGroupKey() Returns a key for grouping notifications. humhub\modules\comment\notifications\NewComment
getGroupLastUsers() Returns the last users of a grouped notification humhub\modules\notification\components\BaseNotification
getGroupUserDisplayNames() Returns the combined display names of a grouped notification. humhub\modules\notification\components\BaseNotification
getMailSubject() Returns the mail subject which will be used in the notification e-mail humhub\modules\comment\notifications\NewComment
getSpace() humhub\components\SocialActivity
getSpaceId() humhub\components\SocialActivity
getUrl() Url of the origin of this notification If source is a Content / ContentAddon / ContentContainer this will automatically generated. humhub\components\SocialActivity
getViewName() humhub\components\SocialActivity
getViewParams() Returns an array of view parameter, required for rendering. humhub\components\SocialActivity
hasContent() Determines if this activity is related to a content. This is the case if the activitiy source is of type ContentOwner. humhub\components\SocialActivity
hasMentioning() humhub\modules\comment\notifications\NewComment
html() Should be overwritten by subclasses for a html representation of the notification. humhub\modules\comment\notifications\NewComment
init() humhub\components\SocialActivity
instance() Static initializer should be prefered over new initialization, since it makes use of Yii::createObject dependency injection/configuration. humhub\components\SocialActivity
isOriginator() Checks if the given $user is the originator of this notification. humhub\modules\notification\components\BaseNotification
json() humhub\components\SocialActivity
markAsSeen() Marks notification as seen humhub\modules\notification\components\BaseNotification
render() Renders the Notificaiton for the given notification target. humhub\modules\notification\components\BaseNotification
saveRecord() Creates the Notification instance of the current BaseNotification type for the given $user. humhub\modules\notification\components\BaseNotification
send() Sends this notification to all notification targets of the given User. humhub\modules\comment\notifications\NewComment
sendBulk() Sends this notification to a set of users. humhub\modules\notification\components\BaseNotification
serialize() Serializes the $source and $originator fields. humhub\components\SocialActivity
text() humhub\components\SocialActivity
unserialize() Unserializes the given string, calls the init() function and sets the $source and $originator fields (and $record indirectyl). humhub\components\SocialActivity
validate() Validates the existence of required attributes humhub\components\SocialActivity

Property Details

$moduleId public property

The module id which this activity belongs to (required)

public string $moduleId 'comment'
$viewName public property

View name used for rendering the activity

public string $viewName 'newComment'

Method Details

category() public method

Returns a new NotificationCategory instance.

This function should be overwritten by subclasses to append this BaseNotification to the returned category. If no category instance is returned, the BaseNotification behavriour (targets) will not be configurable.

public humhub\modules\notification\components\NotificationCategory category ( )
getCommentedRecord() public method

The commented record e.g. a Post

public humhub\modules\content\components\ContentActiveRecord getCommentedRecord ( )
getGroupKey() public method

Returns a key for grouping notifications.

If null is returned (default) the notification grouping for this BaseNotification type disabled.

The returned key could for example be a combination of classname related content id.

public string getGroupKey ( )
return string

The group key

getMailSubject() public method

Returns the mail subject which will be used in the notification e-mail

public string getMailSubject ( )
return string

The subject

hasMentioning() public method

public void hasMentioning ( humhub\modules\user\models\User $user )
html() public method

Should be overwritten by subclasses for a html representation of the notification.

public string html ( )
send() public method

Sends this notification to all notification targets of the given User.

This function will not send notifications to the originator itself.

public void send ( humhub\modules\user\models\User $user )
$user humhub\modules\user\models\User
throws \yii\base\InvalidConfigException