Open Journal Systems  3.3.0
NotificationHandler Class Reference
Inheritance diagram for NotificationHandler:
Handler PKPHandler

Public Member Functions

 _addNotificationsToArray ($resultFactory, $notificationArray)
 
 _getNotificationsByOptions ($notificationOptions, $contextId, $userId=null)
 
 fetchNotification ($args, $request)
 
 setupTemplate ($request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 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())
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle requests for viewing notifications.

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

Member Function Documentation

◆ _addNotificationsToArray()

NotificationHandler::_addNotificationsToArray (   $resultFactory,
  $notificationArray 
)

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

Parameters
$resultFactoryDAOResultFactory
$notificationArrayArray

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

Referenced by _getNotificationsByOptions().

◆ _getNotificationsByOptions()

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

Get the notifications using options.

Parameters
$notificationOptionsArray
$contextIdint
$userIdint
Returns
Array

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

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

Referenced by fetchNotification().

◆ fetchNotification()

NotificationHandler::fetchNotification (   $args,
  $request 
)

Return formatted notification data using Json.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

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

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

◆ setupTemplate()

NotificationHandler::setupTemplate (   $request)

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

Parameters
$requestPKPRequest

Reimplemented from PKPHandler.

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

References AppLocale\requireComponents().

Referenced by fetchNotification().


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