NotificationManager Class Reference

Inheritance diagram for NotificationManager:

Public Member Functions
	_getArticleTitle ($notification)
	getIconClass ($notification)
	getNotificationMessage ($request, $notification)
	getNotificationUrl ($request, $notification)
	getStyleClass ($notification)
Public Member Functions inherited from PKPNotificationManager
	getNotificationContents ($request, $notification)
	getNotificationTitle ($notification)
	isVisibleToAllUsers ($notificationType, $assocType, $assocId)
	updateNotification ($request, $notificationTypes, $userIds, $assocType, $assocId)
Public Member Functions inherited from PKPNotificationOperationManager
	createNotification ($request, $userId=null, $notificationType, $contextId=null, $assocType=null, $assocId=null, $level=NOTIFICATION_LEVEL_NORMAL, $params=null, $suppressEmail=false, callable $mailConfigurator=null)
	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')
	getParamsForCurrentLocale ($params)

Data Fields
	$privilegedRoles

Protected Member Functions
	getMgrDelegate ($notificationType, $assocType, $assocId)
Protected Member Functions inherited from PKPNotificationManager
	getByDelegate ($notificationType, $assocType, $assocId, $operationName, $parameters)
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

Definition at line 19 of file NotificationManager.inc.php.

Member Function Documentation

_getArticleTitle()

NotificationManager::_getArticleTitle

(

$notification

)

Helper function to get an article title from a notification's associated object

Parameters

$notification

Returns

string

Definition at line 92 of file NotificationManager.inc.php.

References DAORegistry\getDAO().

getIconClass()

NotificationManager::getIconClass

(

$notification

)

Return a CSS class containing the icon of this notification type

Parameters

$notification

Notification

Returns

string

Reimplemented from PKPNotificationManager.

Definition at line 128 of file NotificationManager.inc.php.

getMgrDelegate()

NotificationManager::getMgrDelegate (   $notificationType,   $assocType,   $assocId  )

protected

Get the notification manager delegate based on the passed notification type.

Parameters

$notificationType	int
$assocType	int
$assocId	int

Returns

mixed Null or NotificationManagerDelegate

Reimplemented from PKPNotificationManager.

Definition at line 152 of file NotificationManager.inc.php.

getNotificationMessage()

NotificationManager::getNotificationMessage	(		$request,
			$notification
	)

Construct the contents for the notification based on its type and associated object

Parameters

$request	PKPRequest
$notification	Notification

Returns

string

Reimplemented from PKPNotificationManager.

Definition at line 53 of file NotificationManager.inc.php.

References HookRegistry\call().

getNotificationUrl()

NotificationManager::getNotificationUrl	(		$request,
			$notification
	)

Construct a URL for the notification based on its type and associated object

Parameters

$request	PKPRequest
$notification	Notification

Returns

string

Reimplemented from PKPNotificationManager.

Definition at line 33 of file NotificationManager.inc.php.

References Application\getContextDAO().

getStyleClass()

NotificationManager::getStyleClass

(

$notification

)

get notification style class

Parameters

$notification

Notification

Returns

string

Reimplemented from PKPNotificationManager.

Definition at line 106 of file NotificationManager.inc.php.

Field Documentation

$privilegedRoles

NotificationManager::$privilegedRoles

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

---

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

• NotificationManager.inc.php