EditorDecisionNotificationManager Class Reference

Inheritance diagram for EditorDecisionNotificationManager:

Public Member Functions
	__construct ($notificationType)
	_getAllEditorDecisionNotificationTypes ()
	_getNotificationTaskLevel ($type)
	getNotificationMessage ($request, $notification)
	getNotificationTitle ($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)
	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

Editor decision notification types manager delegate.

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

Constructor & Destructor Documentation

__construct()

EditorDecisionNotificationManager::__construct

(

$notificationType

)

Constructor.

Parameters

$notificationType

int NOTIFICATION_TYPE_...

Reimplemented from NotificationManagerDelegate.

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

Member Function Documentation

_getAllEditorDecisionNotificationTypes()

EditorDecisionNotificationManager::_getAllEditorDecisionNotificationTypes

(

)

Get all notification types corresponding to editor decisions.

Returns

array

Definition at line 140 of file EditorDecisionNotificationManager.inc.php.

Referenced by updateNotification().

_getNotificationTaskLevel()

EditorDecisionNotificationManager::_getNotificationTaskLevel

(

$type

)

Get the notification level for the type of notification being created.

Parameters

int

$type

Returns

int

Definition at line 158 of file EditorDecisionNotificationManager.inc.php.

getNotificationMessage()

EditorDecisionNotificationManager::getNotificationMessage	(		$request,
			$notification
	)

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

Parameters

$request	PKPRequest
$notification	Notification

Returns

string

Reimplemented from PKPNotificationOperationManager.

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

getNotificationTitle()

EditorDecisionNotificationManager::getNotificationTitle

(

$notification

)

Get the notification title.

Parameters

$notification

Notification

Returns

string

Reimplemented from PKPNotificationOperationManager.

Definition at line 64 of file EditorDecisionNotificationManager.inc.php.

getNotificationUrl()

EditorDecisionNotificationManager::getNotificationUrl	(		$request,
			$notification
	)

Get a URL for the notification.

Parameters

$request	PKPRequest
$notification	Notification

Returns

string

Reimplemented from PKPNotificationOperationManager.

Definition at line 114 of file EditorDecisionNotificationManager.inc.php.

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

getStyleClass()

EditorDecisionNotificationManager::getStyleClass

(

$notification

)

Get the notification style class.

Parameters

$notification

Notification

Returns

string

Reimplemented from PKPNotificationOperationManager.

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

updateNotification()

EditorDecisionNotificationManager::updateNotification	(		$request,
			$userIds,
			$assocType,
			$assocId
	)

Define operations to update notifications.

Parameters

$request	PKPRequest Request object
$userIds	array List of user IDs to notify
$assocType	int ASSOC_TYPE_...
$assocId	int ID corresponding to $assocType

Returns

boolean True iff success

Reimplemented from NotificationManagerDelegate.

Definition at line 71 of file EditorDecisionNotificationManager.inc.php.

References _getAllEditorDecisionNotificationTypes(), NotificationManagerDelegate\createNotification(), DAORegistry\getDAO(), and NotificationManagerDelegate\getNotificationType().

---

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

• EditorDecisionNotificationManager.inc.php