Class humhub\modules\admin\notifications\NewVersionAvailable
| Inheritance | humhub\modules\admin\notifications\NewVersionAvailable » humhub\modules\notification\components\BaseNotification » humhub\components\SocialActivity » yii\base\BaseObject |
|---|---|
| Implements | Serializable, humhub\components\rendering\Viewable |
| Available since version | 0.11 |
HumHubUpdateNotification
Notifies about new HumHub Version
Public Properties
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $_category | humhub\modules\notification\components\NotificationCategory | Cached category instance | humhub\modules\notification\components\BaseNotification |
| $_groupKey | string | The group key | humhub\modules\notification\components\BaseNotification |
Public Methods
| Method | Description | Defined 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\admin\notifications\NewVersionAvailable |
| 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 |
| 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 |
| getContentPlainTextInfo() | Builds plain text info text about a given content | humhub\components\SocialActivity |
| getContentPlainTextPreview() | Returns a short preview text of the content in plain text. The max length can be defined by setting $maxLength (25 by default). | 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\notification\components\BaseNotification |
| 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 |
| getLatestHumHubVersion() | humhub\modules\admin\notifications\NewVersionAvailable | |
| getMailSubject() | Returns the mail subject which will be used in the notification e-mail | humhub\modules\notification\components\BaseNotification |
| 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\modules\admin\notifications\NewVersionAvailable |
| 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 |
| html() | Should be overwritten by subclasses for a html representation of the notification. | humhub\modules\admin\notifications\NewVersionAvailable |
| 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\notification\components\BaseNotification |
| 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
The module id which this activity belongs to (required)
Ensure originator existence
Ensure source existence
Method Details
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 ( ) |
| public void getLatestHumHubVersion ( ) |
Url of the origin of this notification If source is a Content / ContentAddon / ContentContainer this will automatically generated.
| public string getUrl ( ) |
Should be overwritten by subclasses for a html representation of the notification.
| public string html ( ) |