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

Public Member Functions

 __construct ($notificationType)
 
 _getStageIdByNotificationType ()
 
 getNotificationMessage ($request, $notification)
 
 getStyleClass ($notification)
 
 isVisibleToAllUsers ($notificationType, $assocType, $assocId)
 
 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)
 
 getNotificationContents ($request, $notification)
 
 getNotificationTitle ($notification)
 
 getNotificationUrl ($request, $notification)
 
 getParamsForCurrentLocale ($params)
 

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

Editor assignment notification types manager delegate.

Definition at line 18 of file EditorAssignmentNotificationManager.inc.php.

Constructor & Destructor Documentation

◆ __construct()

EditorAssignmentNotificationManager::__construct (   $notificationType)

Constructor.

Parameters
$notificationTypeint NOTIFICATION_TYPE_...

Reimplemented from NotificationManagerDelegate.

Definition at line 24 of file EditorAssignmentNotificationManager.inc.php.

Member Function Documentation

◆ _getStageIdByNotificationType()

EditorAssignmentNotificationManager::_getStageIdByNotificationType ( )

Return the correct stage id based on the notification type.

Returns
int

Definition at line 107 of file EditorAssignmentNotificationManager.inc.php.

References NotificationManagerDelegate\getNotificationType().

Referenced by updateNotification().

◆ getNotificationMessage()

EditorAssignmentNotificationManager::getNotificationMessage (   $request,
  $notification 
)

Reimplemented from PKPNotificationOperationManager.

Definition at line 31 of file EditorAssignmentNotificationManager.inc.php.

◆ getStyleClass()

EditorAssignmentNotificationManager::getStyleClass (   $notification)

Get the notification style class.

Parameters
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 47 of file EditorAssignmentNotificationManager.inc.php.

◆ isVisibleToAllUsers()

EditorAssignmentNotificationManager::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 from PKPNotificationOperationManager.

Definition at line 54 of file EditorAssignmentNotificationManager.inc.php.

◆ updateNotification()

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

If we have a stage without a manager role user, then a notification must be inserted or maintained for the submission. If a user with this role is assigned to the stage, the notification should be deleted. Every user that have access to the stage should see the notification.

Reimplemented from NotificationManagerDelegate.

Definition at line 67 of file EditorAssignmentNotificationManager.inc.php.

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


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