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

Public Member Functions

 __construct ($notificationType)
 
 _createNotification ($request, $submissionId, $userId, $notificationType, $contextId)
 
 _removeNotification ($submissionId, $userId, $notificationType, $contextId)
 
 getNotificationMessage ($request, $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)
 
 getNotificationContents ($request, $notification)
 
 getNotificationTitle ($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

Editing and productionstatus notifications types manager delegate.

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

Constructor & Destructor Documentation

◆ __construct()

PKPEditingProductionStatusNotificationManager::__construct (   $notificationType)

Constructor.

Parameters
$notificationTypeint NOTIFICATION_TYPE_...

Reimplemented from NotificationManagerDelegate.

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

Member Function Documentation

◆ _createNotification()

PKPEditingProductionStatusNotificationManager::_createNotification (   $request,
  $submissionId,
  $userId,
  $notificationType,
  $contextId 
)

Create a notification if none exists.

Parameters
$requestPKPRequest
$submissionIdint
$userIdint
$notificationTypeint NOTIFICATION_TYPE_
$contextIdint

Definition at line 219 of file PKPEditingProductionStatusNotificationManager.inc.php.

References DAORegistry\getDAO().

Referenced by updateNotification().

◆ _removeNotification()

PKPEditingProductionStatusNotificationManager::_removeNotification (   $submissionId,
  $userId,
  $notificationType,
  $contextId 
)

Remove a notification.

Parameters
$submissionIdint
$userIdint
$notificationTypeint NOTIFICATION_TYPE_
$contextIdint

Definition at line 200 of file PKPEditingProductionStatusNotificationManager.inc.php.

References DAORegistry\getDAO().

Referenced by updateNotification().

◆ getNotificationMessage()

PKPEditingProductionStatusNotificationManager::getNotificationMessage (   $request,
  $notification 
)

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

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

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

◆ getNotificationUrl()

PKPEditingProductionStatusNotificationManager::getNotificationUrl (   $request,
  $notification 
)

Get a URL for the notification.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 49 of file PKPEditingProductionStatusNotificationManager.inc.php.

References PKPApplication\get(), and Application\getContextDAO().

◆ getStyleClass()

PKPEditingProductionStatusNotificationManager::getStyleClass (   $notification)

Get the notification style class.

Parameters
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 69 of file PKPEditingProductionStatusNotificationManager.inc.php.

◆ updateNotification()

PKPEditingProductionStatusNotificationManager::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 76 of file PKPEditingProductionStatusNotificationManager.inc.php.

References _createNotification(), _removeNotification(), DAORegistry\getDAO(), NotificationManagerDelegate\getNotificationType(), and Application\getRepresentationDAO().


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