Public Member Functions | |
| getIconClass ($notification) | |
| getNotificationContents ($request, $notification) | |
| getNotificationMessage ($request, $notification) | |
| getNotificationTitle ($notification) | |
| getNotificationUrl ($request, $notification) | |
| getStyleClass ($notification) | |
| isVisibleToAllUsers ($notificationType, $assocType, $assocId) | |
Detailed Description
Interface to retrieve notification presentation information.
Definition at line 23 of file INotificationInfoProvider.inc.php.
Member Function Documentation
◆ getIconClass()
| INotificationInfoProvider::getIconClass | ( | $notification | ) |
Get the notification icon class.
- Parameters
-
$notification Notification
- Returns
- string
Reimplemented in PKPNotificationManager, EditorialReportNotificationManager, SubmissionNotificationManager, PKPNotificationOperationManager, AnnouncementNotificationManager, and NotificationManager.
◆ getNotificationContents()
| INotificationInfoProvider::getNotificationContents | ( | $request, | |
| $notification | |||
| ) |
Get the notification contents. Content is anything that's more than text, like presenting link actions inside fetched template files.
- Parameters
-
$request PKPRequest $notification Notification
- Returns
- string
Reimplemented in EditorialReportNotificationManager, PKPNotificationManager, QueryNotificationManager, PendingRevisionsNotificationManager, PKPNotificationOperationManager, and AnnouncementNotificationManager.
◆ getNotificationMessage()
| INotificationInfoProvider::getNotificationMessage | ( | $request, | |
| $notification | |||
| ) |
Get the notification message. Only return translated locale key strings.
- Parameters
-
$request PKPRequest $notification Notification
- Returns
- string
Reimplemented in EditorialReportNotificationManager, PKPNotificationManager, ApproveSubmissionNotificationManager, PendingRevisionsNotificationManager, QueryNotificationManager, PKPNotificationOperationManager, AnnouncementNotificationManager, EditorAssignmentNotificationManager, EditorDecisionNotificationManager, PKPEditingProductionStatusNotificationManager, and SubmissionNotificationManager.
◆ getNotificationTitle()
| INotificationInfoProvider::getNotificationTitle | ( | $notification | ) |
Get the notification title.
- Parameters
-
$notification Notification
- Returns
- string
Reimplemented in PKPNotificationManager, PendingRevisionsNotificationManager, EditorDecisionNotificationManager, PKPNotificationOperationManager, ApproveSubmissionNotificationManager, QueryNotificationManager, and NotificationManager.
◆ getNotificationUrl()
| INotificationInfoProvider::getNotificationUrl | ( | $request, | |
| $notification | |||
| ) |
Get a URL for the notification.
- Parameters
-
$request PKPRequest $notification Notification
- Returns
- string
Reimplemented in EditorialReportNotificationManager, EditorDecisionNotificationManager, QueryNotificationManager, SubmissionNotificationManager, AnnouncementNotificationManager, PKPEditingProductionStatusNotificationManager, PendingRevisionsNotificationManager, ApproveSubmissionNotificationManager, PKPApproveSubmissionNotificationManager, PKPNotificationOperationManager, and PKPNotificationManager.
◆ getStyleClass()
| INotificationInfoProvider::getStyleClass | ( | $notification | ) |
Get the notification style class.
- Parameters
-
$notification Notification
- Returns
- string
Reimplemented in PKPNotificationManager, EditorialReportNotificationManager, QueryNotificationManager, SubmissionNotificationManager, AnnouncementNotificationManager, PKPEditingProductionStatusNotificationManager, PKPNotificationOperationManager, EditorDecisionNotificationManager, NotificationManager, EditorAssignmentNotificationManager, PKPApproveSubmissionNotificationManager, and PendingRevisionsNotificationManager.
◆ isVisibleToAllUsers()
| INotificationInfoProvider::isVisibleToAllUsers | ( | $notificationType, | |
| $assocType, | |||
| $assocId | |||
| ) |
Whether any notification with the passed notification type is visible to all users or not.
- Parameters
-
$notificationType int $assocType int ASSOC_TYPE_... $assocId int
- Returns
- boolean
Reimplemented in PKPNotificationManager, PKPNotificationOperationManager, NotificationManager, EditorAssignmentNotificationManager, and PKPApproveSubmissionNotificationManager.
The documentation for this class was generated from the following file:
