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

Public Member Functions

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

Protected Member Functions

 getQuerySubmission ($query)
 
- 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

Query notification types manager delegate.

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

Constructor & Destructor Documentation

◆ __construct()

QueryNotificationManager::__construct (   $notificationType)

Constructor.

Parameters
$notificationTypeint NOTIFICATION_TYPE_...

Reimplemented from NotificationManagerDelegate.

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

Member Function Documentation

◆ getNotificationContents()

QueryNotificationManager::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 112 of file QueryNotificationManager.inc.php.

References DAORegistry\getDAO(), and getQuerySubmission().

◆ getNotificationMessage()

QueryNotificationManager::getNotificationMessage (   $request,
  $notification 
)

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

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 46 of file QueryNotificationManager.inc.php.

References DAORegistry\getDAO(), and PKPString\html2text().

◆ getNotificationTitle()

QueryNotificationManager::getNotificationTitle (   $notification)

Reimplemented from PKPNotificationOperationManager.

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

◆ getNotificationUrl()

QueryNotificationManager::getNotificationUrl (   $request,
  $notification 
)

Get a URL for the notification.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 98 of file QueryNotificationManager.inc.php.

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

◆ getQuerySubmission()

QueryNotificationManager::getQuerySubmission (   $query)
protected

Get the submission for a query.

Parameters
$queryQuery
Returns
Submission

Definition at line 81 of file QueryNotificationManager.inc.php.

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

Referenced by getNotificationContents(), and getNotificationUrl().

◆ getStyleClass()

QueryNotificationManager::getStyleClass (   $notification)

Get the notification style class.

Parameters
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 145 of file QueryNotificationManager.inc.php.


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