Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NotificationManagerDelegate Class Reference
Inheritance diagram for NotificationManagerDelegate:
AllReviewsInNotificationManager ApproveSubmissionNotificationManager AuditorRequestNotificationManager CopyeditAssignmentNotificationManager EditorAssignmentNotificationManager EditorDecisionNotificationManager RevisionsNotificationManager SignoffNotificationManager SubmissionNotificationManager

Public Member Functions

 getIconClass ($notification)
 
 getNotificationContents ($request, $notification)
 
 getNotificationMessage ($request, $notification)
 
 getNotificationTitle ($notification)
 
 getNotificationUrl ($request, $notification)
 
 getStyleClass ($notification)
 
 isVisibleToAllUsers ($notificationType, $assocType, $assocId)
 
 NotificationManagerDelegate ($notificationType)
 
 updateNotification ($request, $userIds, $assocType, $assocId)
 

Protected Member Functions

 getNotificationType ()
 

Detailed Description

Abstract class to support notification manager delegates that provide default implementation to the interface that defines notification presentation data. It also introduce a method to be extended by subclasses to update notification objects.

Definition at line 21 of file NotificationManagerDelegate.inc.php.

Member Function Documentation

NotificationManagerDelegate::getIconClass (   $notification)

Get the notification icon class.

Parameters
$notificationNotification
Returns
string

Definition at line 87 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::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

Definition at line 66 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::getNotificationMessage (   $request,
  $notification 
)

Get the notification message. Only return translated locale key strings.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Definition at line 59 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::getNotificationTitle (   $notification)

Get the notification title.

Parameters
$notificationNotification
Returns
string

Definition at line 73 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::getNotificationUrl (   $request,
  $notification 
)

Get a URL for the notification.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Definition at line 52 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::getStyleClass (   $notification)

Get the notification style class.

Parameters
$notificationNotification
Returns
string

Definition at line 80 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::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

Definition at line 94 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::NotificationManagerDelegate (   $notificationType)

Constructor.

Parameters
$requestPKPRequest
$notificationTypeint

Definition at line 30 of file NotificationManagerDelegate.inc.php.

NotificationManagerDelegate::updateNotification (   $request,
  $userIds,
  $assocType,
  $assocId 
)

Define operations to update notifications.

Parameters
$requestPKPRequest
$userIdsarray
$assocTypeint
$assocIdint

Definition at line 105 of file NotificationManagerDelegate.inc.php.


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