Open Journal Systems  3.3.0
PendingRevisionsNotificationManager Class Reference
Inheritance diagram for PendingRevisionsNotificationManager:
NotificationManagerDelegate PKPNotificationOperationManager INotificationInfoProvider

Public Member Functions

 __construct ($notificationType)
 
 getNotificationContents ($request, $notification)
 
 getNotificationMessage ($request, $notification)
 
 getNotificationTitle ($notification)
 
 getNotificationUrl ($request, $notification)
 
 getStyleClass ($notification)
 
 updateNotification ($request, $userIds, $assocType, $assocId)
 
- Public Member Functions inherited from NotificationManagerDelegate
 createNotification ($request, $userId=null, $notificationType, $contextId=null, $assocType=null, $assocId=null, $level=NOTIFICATION_LEVEL_NORMAL, $params=null, $suppressEmail=false, callable $mailConfigurator=null)
 
 getNotificationType ()
 
- Public Member Functions inherited from PKPNotificationOperationManager
 createTrivialNotification ($userId, $notificationType=NOTIFICATION_TYPE_SUCCESS, $params=null)
 
 deleteTrivialNotifications ($notifications)
 
 formatToGeneralNotification ($request, $notifications)
 
 formatToInPlaceNotification ($request, $notifications)
 
 getFormattedNotificationsForUser ($request, $userId, $level=NOTIFICATION_LEVEL_NORMAL, $contextId=null, $rangeInfo=null, $notificationTemplate='notification/notification.tpl')
 
 getIconClass ($notification)
 
 getParamsForCurrentLocale ($params)
 
 isVisibleToAllUsers ($notificationType, $assocType, $assocId)
 

Additional Inherited Members

- Protected Member Functions inherited from NotificationManagerDelegate
 multipleTypesUpdate ()
 
- Protected Member Functions inherited from PKPNotificationOperationManager
 fetchLinkActionNotificationContent ($linkAction, $request)
 
 getMailTemplate ($emailKey=null)
 
 getUserBlockedEmailedNotifications ($userId, $contextId)
 
 getUserBlockedNotifications ($userId, $contextId)
 
 sendNotificationEmail ($request, $notification, ?int $contextId, callable $mailConfigurator=null)
 

Detailed Description

Pending revision notification types manager delegate.

Definition at line 19 of file PendingRevisionsNotificationManager.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PendingRevisionsNotificationManager::__construct (   $notificationType)

Constructor.

Parameters
$notificationTypeint NOTIFICATION_TYPE_...

Reimplemented from NotificationManagerDelegate.

Definition at line 25 of file PendingRevisionsNotificationManager.inc.php.

Member Function Documentation

◆ getNotificationContents()

PendingRevisionsNotificationManager::getNotificationContents (   $request,
  $notification 
)

Provide the notification message as default content. 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 from PKPNotificationOperationManager.

Definition at line 64 of file PendingRevisionsNotificationManager.inc.php.

References PKPNotificationOperationManager\fetchLinkActionNotificationContent(), DAORegistry\getDAO(), and AppLocale\requireComponents().

◆ getNotificationMessage()

PendingRevisionsNotificationManager::getNotificationMessage (   $request,
  $notification 
)

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

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 53 of file PendingRevisionsNotificationManager.inc.php.

References AppLocale\requireComponents().

◆ getNotificationTitle()

PendingRevisionsNotificationManager::getNotificationTitle (   $notification)

Get the notification title.

Parameters
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

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

◆ getNotificationUrl()

PendingRevisionsNotificationManager::getNotificationUrl (   $request,
  $notification 
)

Get a URL for the notification.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 39 of file PendingRevisionsNotificationManager.inc.php.

References PKPServices\get(), and DAORegistry\getDAO().

◆ getStyleClass()

PendingRevisionsNotificationManager::getStyleClass (   $notification)

Get the notification style class.

Parameters
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 32 of file PendingRevisionsNotificationManager.inc.php.

◆ updateNotification()

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

Define operations to update notifications.

Parameters
$requestPKPRequest Request object
$userIdsarray List of user IDs to notify
$assocTypeint ASSOC_TYPE_...
$assocIdint ID corresponding to $assocType
Returns
boolean True iff success

Reimplemented from NotificationManagerDelegate.

Definition at line 96 of file PendingRevisionsNotificationManager.inc.php.

References DAORegistry\getDAO(), and NotificationManagerDelegate\getNotificationType().


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