NotificationsGridHandler.inc.php

<?php
 
// Import UI base classes.
import('lib.pkp.classes.controllers.grid.GridHandler');
 
// Other classes associated with this grid
import('lib.pkp.controllers.grid.notifications.NotificationsGridCellProvider');
 
class NotificationsGridHandler extends GridHandler {
   var $_selectedNotificationIds;
 
 
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_SUBMISSION, LOCALE_COMPONENT_PKP_SUBMISSION);
 
      $this->_selectedNotificationIds = (array) $request->getUserVar('selectedNotificationIds');
 
      $cellProvider = new NotificationsGridCellProvider();
      $this->addColumn(
         new GridColumn(
            'task',
            $this->getNotificationsColumnTitle(),
            null,
            null,
            $cellProvider,
            array('anyhtml' => true,
                  'alignment' => COLUMN_ALIGNMENT_LEFT)
         )
      );
 
      // Set the no items row text
      $this->setEmptyRowText('grid.noItems');
 
      import('lib.pkp.classes.linkAction.request.NullAction');
      $this->addAction(
         new LinkAction(
            'markNew',
            new NullAction(),
            __('grid.action.markNew'),
            'edit' // FIXME: Icon
         ),
         GRID_ACTION_POSITION_BELOW
      );
      $this->addAction(
         new LinkAction(
            'markRead',
            new NullAction(),
            __('grid.action.markRead'),
            'edit' // FIXME: Icon
         ),
         GRID_ACTION_POSITION_BELOW
      );
 
      $router = $request->getRouter();
      $this->addAction(
         new LinkAction(
            'deleteNotification',
            new NullAction(),
            __('grid.action.delete'),
            'delete'
         ),
         GRID_ACTION_POSITION_BELOW
      );
   }
 
 
   //
   // Overridden methods from GridHandler
   //
   public function getJSHandler() {
      return '$.pkp.controllers.grid.notifications.NotificationsGridHandler';
   }
 
   function setUrls($request, $extraUrls = array()) {
      $router = $request->getRouter();
      parent::setUrls(
         $request,
         array_merge(
            $extraUrls,
            array(
               'markNewUrl' => $router->url($request, null, null, 'markNew', null, $this->getRequestArgs()),
               'markReadUrl' => $router->url($request, null, null, 'markRead', null, $this->getRequestArgs()),
               'deleteUrl' => $router->url($request, null, null, 'deleteNotifications', null, $this->getRequestArgs()),
            )
         )
      );
   }
 
   function getPublishChangeEvents() {
      return array('updateUnreadNotificationsCount');
   }
 
   function initFeatures($request, $args) {
      import('lib.pkp.classes.controllers.grid.feature.selectableItems.SelectableItemsFeature');
      import('lib.pkp.classes.controllers.grid.feature.PagingFeature');
      return array(new SelectableItemsFeature(), new PagingFeature());
   }
 
   function getSelectName() {
      return 'selectedNotifications';
   }
 
   function isDataElementSelected($gridDataElement) {
      return in_array($gridDataElement->getId(), $this->_selectedNotificationIds);
   }
 
 
   //
   // Protected methods.
   //
   protected function getNotificationsColumnTitle() {
      return 'common.tasks';
   }
 
 
   //
   // Public methods
   //
   function markNew($args, $request) {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $user = $request->getUser();
 
      $selectedElements = (array) $request->getUserVar('selectedElements');
      foreach ($selectedElements as $notificationId) {
         if ($notificationDao->getById($notificationId, $user->getId())) {
            $notificationDao->setDateRead($notificationId, null);
         }
      }
 
      $json = DAO::getDataChangedEvent(null, null, $selectedElements);
      $json->setGlobalEvent('update:unread-tasks-count', ['count' => $this->getUnreadNotificationsCount($user)]);
      return $json;
   }
 
   function markRead($args, $request) {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $user = $request->getUser();
 
      $selectedElements = (array) $request->getUserVar('selectedElements');
      foreach ($selectedElements as $notificationId) {
         if ($notification = $notificationDao->getById($notificationId, $user->getId())) {
            $notificationDao->setDateRead($notificationId, Core::getCurrentDate());
         }
      }
      if ($request->getUserVar('redirect')) {
         // In this case, the user has clicked on a notification
         // and wants to view it. Mark it read first and redirect
         $notificationMgr = new NotificationManager();
         return $request->redirectUrlJson($notificationMgr->getNotificationUrl($request, $notification));
      } else {
         // The notification has been marked read explicitly.
         // Update its status in the grid.
         $json = DAO::getDataChangedEvent(null, null, $selectedElements);
         $json->setGlobalEvent('update:unread-tasks-count', ['count' => $this->getUnreadNotificationsCount($user)]);
         return $json;
      }
   }
 
   function deleteNotifications($args, $request) {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $user = $request->getUser();
 
      $selectedElements = (array) $request->getUserVar('selectedElements');
      foreach ($selectedElements as $notificationId) {
         if ($notification = $notificationDao->getById($notificationId, $user->getId())) {
            $notificationDao->deleteObject($notification);
         }
      }
      $json = DAO::getDataChangedEvent(null, null, $selectedElements);
      $json->setGlobalEvent('update:unread-tasks-count', ['count' => $this->getUnreadNotificationsCount($user)]);
      return $json;
   }
 
   function getUnreadNotificationsCount($user) {
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      return (int) $notificationDao->getNotificationCount(false, $user->getId(), null, NOTIFICATION_LEVEL_TASK);
   }
}