Open Journal Systems  3.3.0
NotificationsGridHandler Class Reference
Inheritance diagram for NotificationsGridHandler:
GridHandler PKPHandler TaskNotificationsGridHandler

Public Member Functions

 deleteNotifications ($args, $request)
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getSelectName ()
 
 getUnreadNotificationsCount ($user)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 isDataElementSelected ($gridDataElement)
 
 markNew ($args, $request)
 
 markRead ($args, $request)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow ($args, $request)
 
 fetchRows ($args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag=null)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 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)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $_selectedNotificationIds
 
- Data Fields inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_constants = []
 
 $_data
 
 $_dataProvider
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Protected Member Functions

 getNotificationsColumnTitle ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowInstance ()
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle the display of notifications for a given user.

Definition at line 22 of file NotificationsGridHandler.inc.php.

Member Function Documentation

◆ deleteNotifications()

NotificationsGridHandler::deleteNotifications (   $args,
  $request 
)

Delete notifications

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 222 of file NotificationsGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), and getUnreadNotificationsCount().

◆ getJSHandler()

NotificationsGridHandler::getJSHandler ( )
See also
GridHandler::getJSHandler()

Reimplemented from GridHandler.

Definition at line 94 of file NotificationsGridHandler.inc.php.

◆ getNotificationsColumnTitle()

NotificationsGridHandler::getNotificationsColumnTitle ( )
protected

Get the notifications column title.

Returns
string Locale key.

Definition at line 156 of file NotificationsGridHandler.inc.php.

Referenced by initialize().

◆ getPublishChangeEvents()

NotificationsGridHandler::getPublishChangeEvents ( )

Get the list of "publish data changed" events. Used to update the site context switcher upon create/delete.

Returns
array

Reimplemented from GridHandler.

Definition at line 121 of file NotificationsGridHandler.inc.php.

◆ getSelectName()

NotificationsGridHandler::getSelectName ( )

Get the select parameter name to store the selected files.

Returns
string

Reimplemented from GridHandler.

Definition at line 137 of file NotificationsGridHandler.inc.php.

◆ getUnreadNotificationsCount()

NotificationsGridHandler::getUnreadNotificationsCount (   $user)

Get unread notifications count

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 243 of file NotificationsGridHandler.inc.php.

References DAORegistry\getDAO().

Referenced by deleteNotifications(), markNew(), and markRead().

◆ initFeatures()

NotificationsGridHandler::initFeatures (   $request,
  $args 
)

Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.

Parameters
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 128 of file NotificationsGridHandler.inc.php.

◆ initialize()

NotificationsGridHandler::initialize (   $request,
  $args = null 
)

◆ isDataElementSelected()

NotificationsGridHandler::isDataElementSelected (   $gridDataElement)

Returns the current selection state of the grid data element.

Parameters
$gridDataElementmixed
Returns
boolean

Reimplemented from GridHandler.

Definition at line 144 of file NotificationsGridHandler.inc.php.

◆ markNew()

NotificationsGridHandler::markNew (   $args,
  $request 
)

Mark notifications unread

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 170 of file NotificationsGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), and getUnreadNotificationsCount().

◆ markRead()

NotificationsGridHandler::markRead (   $args,
  $request 
)

Mark notifications unread

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 192 of file NotificationsGridHandler.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), and getUnreadNotificationsCount().

◆ setUrls()

NotificationsGridHandler::setUrls (   $request,
  $extraUrls = array() 
)
See also
GridHandler::setUrls()

Reimplemented from GridHandler.

Definition at line 101 of file NotificationsGridHandler.inc.php.

Field Documentation

◆ $_selectedNotificationIds

$_selectedNotificationIds NotificationsGridHandler::$_selectedNotificationIds

array Set of selected IDs

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


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