PHP Class NotificationHandler, pkp-lib

Inheritance: extends Handler
Show file Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
_addNotificationsToArray ( $resultFactory, $notificationArray ) Add notifications from a result factory to an array of existing notifications.
_getNotificationsByOptions ( $notificationOptions, $contextId, $userId = null ) : Array Get the notifications using options.
confirmMailListSubscription ( $args, $request ) Confirm the subscription (accessed via emailed link)
fetchNotification ( $args, $request ) : JSONMessage Return formatted notification data using Json.
getNotificationFeedUrl ( $args, $request ) Fetch the existing or create a new URL for the user's RSS feed
index ( $args, $request ) Display help table of contents.
mailListSubscribed ( $args, $request ) Display a success or error message if the user was subscribed
notificationFeed ( $args, $request ) Fetch the actual RSS feed
saveSubscribeMailList ( $args, $request ) Save the public notification email subscription form
setupTemplate ( $request ) Override setupTemplate() so we can load other locale components.
subscribeMailList ( $args, $request ) Display the public notification email subscription form
unsubscribeMailList ( $args, $request ) Save the maillist unsubscribe form

Method Details

__construct() public method

Constructor
public __construct ( )

_addNotificationsToArray() public method

Add notifications from a result factory to an array of existing notifications.
public _addNotificationsToArray ( $resultFactory, $notificationArray )
$resultFactory DAOResultFactory
$notificationArray Array

_getNotificationsByOptions() public method

Get the notifications using options.
public _getNotificationsByOptions ( $notificationOptions, $contextId, $userId = null ) : Array
$notificationOptions Array
$contextId int
$userId int
return Array

confirmMailListSubscription() public method

Confirm the subscription (accessed via emailed link)
public confirmMailListSubscription ( $args, $request )
$args array
$request Request

fetchNotification() public method

Return formatted notification data using Json.
public fetchNotification ( $args, $request ) : JSONMessage
$args array
$request Request
return JSONMessage JSON object

getNotificationFeedUrl() public method

Fetch the existing or create a new URL for the user's RSS feed
public getNotificationFeedUrl ( $args, $request )
$args array
$request Request

index() public method

Display help table of contents.
public index ( $args, $request )
$args array
$request Request

mailListSubscribed() public method

Display a success or error message if the user was subscribed
public mailListSubscribed ( $args, $request )
$args array
$request Request

notificationFeed() public method

Fetch the actual RSS feed
public notificationFeed ( $args, $request )
$args array
$request Request

saveSubscribeMailList() public method

Save the public notification email subscription form
public saveSubscribeMailList ( $args, $request )
$args array
$request Request

setupTemplate() public method

Override setupTemplate() so we can load other locale components.
public setupTemplate ( $request )

subscribeMailList() public method

Display the public notification email subscription form
public subscribeMailList ( $args, $request )
$args array
$request Request

unsubscribeMailList() public method

Save the maillist unsubscribe form
public unsubscribeMailList ( $args, $request )
$args array
$request Request