PHP Class NotificationManager, ojs

Inheritance: extends PKPNotificationManager
Exibir arquivo Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$privilegedRoles * @var array Cache each user's most privileged role for each submission

Public Methods

Method Description
__construct ( ) Constructor.
_getArticleTitle ( $notification ) : string Helper function to get an article title from a notification's associated object
getIconClass ( $notification ) : string Return a CSS class containing the icon of this notification type
getNotificationMessage ( $request, $notification ) : string Construct the contents for the notification based on its type and associated object
getNotificationUrl ( $request, $notification ) : string Construct a URL for the notification based on its type and associated object
getStyleClass ( $notification ) : string get notification style class

Protected Methods

Method Description
getMgrDelegate ( $notificationType, $assocType, $assocId )

Method Details

__construct() public method

Constructor.
public __construct ( )

_getArticleTitle() public method

Helper function to get an article title from a notification's associated object
public _getArticleTitle ( $notification ) : string
$notification
return string

getIconClass() public method

Return a CSS class containing the icon of this notification type
public getIconClass ( $notification ) : string
$notification Notification
return string

getMgrDelegate() protected method

protected getMgrDelegate ( $notificationType, $assocType, $assocId )

getNotificationMessage() public method

Construct the contents for the notification based on its type and associated object
public getNotificationMessage ( $request, $notification ) : string
$request PKPRequest
$notification Notification
return string

getNotificationUrl() public method

Construct a URL for the notification based on its type and associated object
public getNotificationUrl ( $request, $notification ) : string
$request PKPRequest
$notification Notification
return string

getStyleClass() public method

get notification style class
public getStyleClass ( $notification ) : string
$notification Notification
return string

Property Details

$privilegedRoles public_oe property

* @var array Cache each user's most privileged role for each submission
public $privilegedRoles