Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NotificationHandler Class Reference
Inheritance diagram for NotificationHandler:
Handler PKPHandler

Public Member Functions

 _addNotificationsToArray ($resultFactory, $notificationArray)
 
 _getNotificationsByOptions ($notificationOptions, $contextId, $userId=null)
 
 confirmMailListSubscription ($args, $request)
 
 delete ($args, $request)
 
 fetchNotification ($args, $request)
 
 getNotificationFeedUrl ($args, $request)
 
 index ($args, $request)
 
 mailListSubscribed ($args, $request)
 
 notificationFeed ($args, $request)
 
 NotificationHandler ()
 
 saveSettings ($args, $request)
 
 saveSubscribeMailList ($args, $request)
 
 settings ($args, $request)
 
 setupTemplate ($request)
 
 subscribeMailList ($args, $request)
 
 unsubscribeMailList ($args, $request)
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

Handle requests for viewing notifications.

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

Member Function Documentation

NotificationHandler::_addNotificationsToArray (   $resultFactory,
  $notificationArray 
)

Add notifications from a result factory to an array of existing notifications.

Parameters
$resultFactoryDAOResultFactory
$notificationArrayArray

Definition at line 438 of file NotificationHandler.inc.php.

Referenced by _getNotificationsByOptions().

NotificationHandler::_getNotificationsByOptions (   $notificationOptions,
  $contextId,
  $userId = null 
)

Get the notifications using options.

Parameters
$notificationOptionsArray
$contextIdint
$userIdint
Returns
Array

Definition at line 401 of file NotificationHandler.inc.php.

References _addNotificationsToArray(), and DAORegistry\getDAO().

Referenced by fetchNotification().

NotificationHandler::confirmMailListSubscription (   $args,
  $request 
)

Confirm the subscription (accessed via emailed link)

Parameters
$argsarray
$requestRequest

Definition at line 297 of file NotificationHandler.inc.php.

References DAORegistry\getDAO(), and setupTemplate().

NotificationHandler::delete (   $args,
  $request 
)

Delete a notification

Parameters
$argsarray
$requestRequest

Definition at line 76 of file NotificationHandler.inc.php.

References DAORegistry\getDAO(), and PKPHandler\validate().

NotificationHandler::fetchNotification (   $args,
  $request 
)

Return formatted notification data using Json.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage

Definition at line 353 of file NotificationHandler.inc.php.

References _getNotificationsByOptions(), DAORegistry\getDAO(), and setupTemplate().

NotificationHandler::getNotificationFeedUrl (   $args,
  $request 
)

Fetch the existing or create a new URL for the user's RSS feed

Parameters
$argsarray
$requestRequest

Definition at line 147 of file NotificationHandler.inc.php.

References DAORegistry\getDAO().

NotificationHandler::index (   $args,
  $request 
)

Display help table of contents.

Parameters
$argsarray
$requestRequest

Definition at line 32 of file NotificationHandler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getRangeInfo(), setupTemplate(), and PKPHandler\validate().

NotificationHandler::mailListSubscribed (   $args,
  $request 
)

Display a success or error message if the user was subscribed

Parameters
$argsarray
$requestRequest

Definition at line 277 of file NotificationHandler.inc.php.

References setupTemplate().

NotificationHandler::notificationFeed (   $args,
  $request 
)

Fetch the actual RSS feed

Parameters
$argsarray
$requestRequest

Definition at line 176 of file NotificationHandler.inc.php.

References DAORegistry\getDAO(), AppLocale\getPrimaryLocale(), and setupTemplate().

NotificationHandler::NotificationHandler ( )

Constructor

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

NotificationHandler::saveSettings (   $args,
  $request 
)

Save user notification settings

Parameters
$argsarray
$requestRequest

Definition at line 124 of file NotificationHandler.inc.php.

References setupTemplate(), and PKPHandler\validate().

NotificationHandler::saveSubscribeMailList (   $args,
  $request 
)

Save the public notification email subscription form

Parameters
$argsarray
$requestRequest

Definition at line 254 of file NotificationHandler.inc.php.

References setupTemplate(), and PKPHandler\validate().

NotificationHandler::settings (   $args,
  $request 
)

View and modify notification settings

Parameters
$argsarray
$requestRequest

Definition at line 103 of file NotificationHandler.inc.php.

References setupTemplate(), and PKPHandler\validate().

NotificationHandler::setupTemplate (   $request)

Override setupTemplate() so we can load other locale components. Set up the basic template.

Parameters
$requestPKPRequest

Definition at line 450 of file NotificationHandler.inc.php.

References AppLocale\requireComponents().

Referenced by confirmMailListSubscription(), fetchNotification(), index(), mailListSubscribed(), notificationFeed(), saveSettings(), saveSubscribeMailList(), settings(), subscribeMailList(), and unsubscribeMailList().

NotificationHandler::subscribeMailList (   $args,
  $request 
)

Display the public notification email subscription form

Parameters
$argsarray
$requestRequest

Definition at line 234 of file NotificationHandler.inc.php.

References setupTemplate().

NotificationHandler::unsubscribeMailList (   $args,
  $request 
)

Save the maillist unsubscribe form

Parameters
$argsarray
$requestRequest

Definition at line 325 of file NotificationHandler.inc.php.

References DAORegistry\getDAO(), and setupTemplate().


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