Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
INotificationInfoProvider Class Reference

Public Member Functions

 getIconClass ($notification)
 
 getNotificationContents ($request, $notification)
 
 getNotificationMessage ($request, $notification)
 
 getNotificationTitle ($notification)
 
 getNotificationUrl ($request, $notification)
 
 getStyleClass ($notification)
 
 isVisibleToAllUsers ($notificationType, $assocType, $assocId)
 

Detailed Description

Interface to retrieve notification presentation information.

Definition at line 23 of file INotificationInfoProvider.inc.php.

Member Function Documentation

INotificationInfoProvider::getIconClass (   $notification)

Get the notification icon class.

Parameters
$notificationNotification
Returns
string
INotificationInfoProvider::getNotificationContents (   $request,
  $notification 
)

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
INotificationInfoProvider::getNotificationMessage (   $request,
  $notification 
)

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

Parameters
$requestPKPRequest
$notificationNotification
Returns
string
INotificationInfoProvider::getNotificationTitle (   $notification)

Get the notification title.

Parameters
$notificationNotification
Returns
string
INotificationInfoProvider::getNotificationUrl (   $request,
  $notification 
)

Get a URL for the notification.

Parameters
$requestPKPRequest
$notificationNotification
Returns
string
INotificationInfoProvider::getStyleClass (   $notification)

Get the notification style class.

Parameters
$notificationNotification
Returns
string
INotificationInfoProvider::isVisibleToAllUsers (   $notificationType,
  $assocType,
  $assocId 
)

Whether any notification with the passed notification type is visible to all users or not.

Parameters
$notificationTypeint
$assocTypeint ASSOC_TYPE_...
$assocIdint
Returns
boolean

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