Open Journal Systems  3.3.0
INotificationInfoProvider Class Reference
Inheritance diagram for INotificationInfoProvider:
PKPNotificationOperationManager NotificationManagerDelegate PKPNotificationManager AnnouncementNotificationManager EditorAssignmentNotificationManager EditorDecisionNotificationManager EditorialReportNotificationManager PendingRevisionsNotificationManager PKPApproveSubmissionNotificationManager PKPEditingProductionStatusNotificationManager QueryNotificationManager SubmissionNotificationManager NotificationManager

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)

◆ 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
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented in EditorialReportNotificationManager, PKPNotificationManager, QueryNotificationManager, PendingRevisionsNotificationManager, PKPNotificationOperationManager, and AnnouncementNotificationManager.

◆ getNotificationMessage()

◆ getNotificationTitle()

INotificationInfoProvider::getNotificationTitle (   $notification)

◆ getNotificationUrl()

◆ getStyleClass()

◆ isVisibleToAllUsers()

INotificationInfoProvider::isVisibleToAllUsers (   $notificationType,
  $assocType,
  $assocId 
)

Whether any notification with the passed notification type is visible to all users or not.

Parameters
$notificationTypeint
$assocTypeint ASSOC_TYPE_...
$assocIdint
Returns
boolean

Reimplemented in PKPNotificationManager, PKPNotificationOperationManager, EditorAssignmentNotificationManager, and PKPApproveSubmissionNotificationManager.


The documentation for this class was generated from the following file: