Open Monograph Press  3.3.0
EditorialReportNotificationManager Class Reference
Inheritance diagram for EditorialReportNotificationManager:
NotificationManagerDelegate PKPNotificationOperationManager INotificationInfoProvider

Public Member Functions

 __construct (int $notificationType)
 
 _getLocalizedMonthName (\DateTimeInterface $date, ?string $locale=null)
 
 getIconClass ($notification)
 
 getNotificationContents ($request, $notification)
 
 getNotificationMessage ($request, $notification)
 
 getNotificationUrl ($request, $notification)
 
 getStyleClass ($notification)
 
 initialize (Context $context, DateTimeInterface $dateStart, DateTimeInterface $dateEnd)
 
 notify (User $user)
 
- Public Member Functions inherited from NotificationManagerDelegate
 __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')
 
 getNotificationTitle ($notification)
 
 getParamsForCurrentLocale ($params)
 
 isVisibleToAllUsers ($notificationType, $assocType, $assocId)
 

Protected Member Functions

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

Detailed Description

Editorial report notification manager.

Definition at line 17 of file EditorialReportNotificationManager.inc.php.

Constructor & Destructor Documentation

◆ __construct()

EditorialReportNotificationManager::__construct ( int  $notificationType)

Constructor.

Parameters
$notificationTypeint NOTIFICATION_TYPE_...

Definition at line 57 of file EditorialReportNotificationManager.inc.php.

References PKPApplication\get().

Member Function Documentation

◆ _getLocalizedMonthName()

EditorialReportNotificationManager::_getLocalizedMonthName ( \DateTimeInterface  $date,
?string  $locale = null 
)

Retrieves the localized month name for the given date and locale

Parameters

Definition at line 175 of file EditorialReportNotificationManager.inc.php.

References AppLocale\getLocale().

Referenced by initialize().

◆ getIconClass()

EditorialReportNotificationManager::getIconClass (   $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 211 of file EditorialReportNotificationManager.inc.php.

◆ getMailTemplate()

EditorialReportNotificationManager::getMailTemplate (   $emailKey = null)
protected

Get a template mail instance.

Parameters
$emailKeystring
Returns
MailTemplate
See also
MailTemplate

Reimplemented from PKPNotificationOperationManager.

Definition at line 250 of file EditorialReportNotificationManager.inc.php.

◆ getNotificationContents()

EditorialReportNotificationManager::getNotificationContents (   $request,
  $notification 
)

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

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 194 of file EditorialReportNotificationManager.inc.php.

References PKPServices\get().

◆ getNotificationMessage()

EditorialReportNotificationManager::getNotificationMessage (   $request,
  $notification 
)

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

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 186 of file EditorialReportNotificationManager.inc.php.

◆ getNotificationUrl()

EditorialReportNotificationManager::getNotificationUrl (   $request,
  $notification 
)

Get a URL for the notification.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string

Reimplemented from PKPNotificationOperationManager.

Definition at line 202 of file EditorialReportNotificationManager.inc.php.

References $application, and PKPApplication\get().

◆ getStyleClass()

EditorialReportNotificationManager::getStyleClass (   $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 219 of file EditorialReportNotificationManager.inc.php.

◆ initialize()

EditorialReportNotificationManager::initialize ( Context  $context,
DateTimeInterface  $dateStart,
DateTimeInterface  $dateEnd 
)

Initializes the class.

Parameters
$contextContext The context from where the statistics shall be retrieved
$contextDateTimeInterface Start date filter for the ranged statistics
$contextDateTimeInterface End date filter for the ranged statistics

Definition at line 68 of file EditorialReportNotificationManager.inc.php.

References _getLocalizedMonthName(), PKPServices\get(), PKPApplication\get(), Context\getPrimaryLocale(), and AppLocale\requireComponents().

◆ notify()

EditorialReportNotificationManager::notify ( User  $user)

Sends a notification to the given user.

Parameters
$userUser The user who will be notified
Returns
PKPNotification The notification instance

Definition at line 229 of file EditorialReportNotificationManager.inc.php.

References DataObject\getId().


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