Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($notificationType) | |
createNotification ($request, $userId=null, $notificationType, $contextId=null, $assocType=null, $assocId=null, $level=NOTIFICATION_LEVEL_NORMAL, $params=null, $suppressEmail=false, callable $mailConfigurator=null) | |
getNotificationType () | |
updateNotification ($request, $userIds, $assocType, $assocId) | |
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) | |
getNotificationMessage ($request, $notification) | |
getNotificationTitle ($notification) | |
getNotificationUrl ($request, $notification) | |
getParamsForCurrentLocale ($params) | |
getStyleClass ($notification) | |
isVisibleToAllUsers ($notificationType, $assocType, $assocId) | |
Protected Member Functions | |
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) | |
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.
NotificationManagerDelegate::__construct | ( | $notificationType | ) |
Constructor.
$notificationType | int NOTIFICATION_TYPE_... |
Reimplemented in ApproveSubmissionNotificationManager, PendingRevisionsNotificationManager, EditorAssignmentNotificationManager, EditorDecisionNotificationManager, PKPApproveSubmissionNotificationManager, PKPEditingProductionStatusNotificationManager, QueryNotificationManager, and SubmissionNotificationManager.
Definition at line 33 of file NotificationManagerDelegate.inc.php.
NotificationManagerDelegate::createNotification | ( | $request, | |
$userId = null , |
|||
$notificationType, | |||
$contextId = null , |
|||
$assocType = null , |
|||
$assocId = null , |
|||
$level = NOTIFICATION_LEVEL_NORMAL , |
|||
$params = null , |
|||
$suppressEmail = false , |
|||
callable | $mailConfigurator = null |
||
) |
Check if this manager delegate can handle the creation of the passed notification type. Create a new notification with the specified arguments and insert into DB
$request | PKPRequest |
$userId | int (optional) |
$notificationType | int |
$contextId | int |
$assocType | int |
$assocId | int |
$level | int |
$params | array |
$suppressEmail | boolean Whether or not to suppress the notification email. |
$mailConfigurator | callable Enables the customization of the Notification email |
Reimplemented from PKPNotificationOperationManager.
Definition at line 62 of file NotificationManagerDelegate.inc.php.
References getNotificationType(), and multipleTypesUpdate().
Referenced by PKPApproveSubmissionNotificationManager\updateNotification(), EditorAssignmentNotificationManager\updateNotification(), and EditorDecisionNotificationManager\updateNotification().
NotificationManagerDelegate::getNotificationType | ( | ) |
Get the current notification type this manager is handling.
Definition at line 41 of file NotificationManagerDelegate.inc.php.
Referenced by EditorAssignmentNotificationManager\_getStageIdByNotificationType(), createNotification(), EditorAssignmentNotificationManager\updateNotification(), EditorDecisionNotificationManager\updateNotification(), PKPEditingProductionStatusNotificationManager\updateNotification(), and PendingRevisionsNotificationManager\updateNotification().
|
protected |
Flag a notification manager that handles multiple notification types inside the update method within the same call. Only set this to true if you're sure the notification manager provides all information for all notification types you're handling (via the getNotification... methods).
Reimplemented in PKPApproveSubmissionNotificationManager.
Definition at line 75 of file NotificationManagerDelegate.inc.php.
Referenced by createNotification().
NotificationManagerDelegate::updateNotification | ( | $request, | |
$userIds, | |||
$assocType, | |||
$assocId | |||
) |
Define operations to update notifications.
$request | PKPRequest Request object |
$userIds | array List of user IDs to notify |
$assocType | int ASSOC_TYPE_... |
$assocId | int ID corresponding to $assocType |
Reimplemented in PendingRevisionsNotificationManager, PKPEditingProductionStatusNotificationManager, EditorDecisionNotificationManager, EditorAssignmentNotificationManager, and PKPApproveSubmissionNotificationManager.
Definition at line 53 of file NotificationManagerDelegate.inc.php.