UserSelectGridHandler.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.GridHandler');
import('lib.pkp.controllers.grid.users.userSelect.UserSelectGridCellProvider');
 
class UserSelectGridHandler extends GridHandler {
   var $_userGroupOptions;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_SUB_EDITOR, ROLE_ID_MANAGER, ROLE_ID_ASSISTANT),
         array('fetchGrid', 'fetchRows')
      );
   }
 
   //
   // Implement template methods from PKPHandler
   //
   function authorize($request, &$args, $roleAssignments) {
      $stageId = (int)$request->getUserVar('stageId');
 
      import('lib.pkp.classes.security.authorization.WorkflowStageAccessPolicy');
      $this->addPolicy(new WorkflowStageAccessPolicy($request, $args, $roleAssignments, 'submissionId', $stageId));
 
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
 
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_PKP_MANAGER,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_PKP_EDITOR,
         LOCALE_COMPONENT_APP_EDITOR
      );
 
      $stageId = $this->getAuthorizedContextObject(ASSOC_TYPE_WORKFLOW_STAGE);
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $userGroups = $userGroupDao->getUserGroupsByStage(
         $request->getContext()->getId(),
         $stageId
      );
      $this->_userGroupOptions = array();
      while ($userGroup = $userGroups->next()) {
         // Exclude reviewers.
         if ($userGroup->getRoleId() == ROLE_ID_REVIEWER) continue;
         $this->_userGroupOptions[$userGroup->getId()] = $userGroup->getLocalizedName();
      }
 
      $this->setTitle('editor.submission.findAndSelectUser');
 
      // Columns
      $cellProvider = new UserSelectGridCellProvider();
      $this->addColumn(
         new GridColumn(
            'select',
            '',
            null,
            'controllers/grid/users/userSelect/userSelectRadioButton.tpl',
            $cellProvider,
            array('width' => 5)
         )
      );
      $this->addColumn(
         new GridColumn(
            'name',
            'author.users.contributor.name',
            null,
            null,
            $cellProvider,
            array('alignment' => COLUMN_ALIGNMENT_LEFT,
               'width' => 30
            )
         )
      );
   }
 
 
   //
   // Overridden methods from GridHandler
   //
   function initFeatures($request, $args) {
      import('lib.pkp.classes.controllers.grid.feature.InfiniteScrollingFeature');
      import('lib.pkp.classes.controllers.grid.feature.CollapsibleGridFeature');
      return array(new InfiniteScrollingFeature('infiniteScrolling', $this->getItemsNumber()), new CollapsibleGridFeature());
   }
 
   protected function loadData($request, $filter) {
      list($filterUserGroupId, $name) = $this->getFilterValues($filter);
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      $stageId = $this->getAuthorizedContextObject(ASSOC_TYPE_WORKFLOW_STAGE);
      $rangeInfo = $this->getGridRangeInfo($request, $this->getId());
      $userStageAssignmentDao = DAORegistry::getDAO('UserStageAssignmentDAO'); /* @var $userStageAssignmentDao UserStageAssignmentDAO */
      return $userStageAssignmentDao->filterUsersNotAssignedToStageInUserGroup($submission->getId(), $stageId, $filterUserGroupId, $name, $rangeInfo);
   }
 
   function renderFilter($request, $filterData = array()) {
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      $stageId = $this->getAuthorizedContextObject(ASSOC_TYPE_WORKFLOW_STAGE);
 
      $keys = array_keys($this->_userGroupOptions);
      $allFilterData = array_merge(
         $filterData,
         array(
            'userGroupOptions' => $this->_userGroupOptions,
            'selectedUserGroupId' => reset($keys),
            'gridId' => $this->getId(),
            'submissionId' => $submission->getId(),
            'stageId' => $stageId,
         ));
      return parent::renderFilter($request, $allFilterData);
   }
 
   function getFilterSelectionData($request) {
      $name = (string) $request->getUserVar('name');
      $filterUserGroupId = (int) $request->getUserVar('filterUserGroupId');
      return array(
         'name' => $name,
         'filterUserGroupId' => $filterUserGroupId,
      );
   }
 
   protected function getFilterForm() {
      return 'controllers/grid/users/userSelect/searchUserFilter.tpl';
   }
 
   function getRequestArgs() {
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      $stageId = $this->getAuthorizedContextObject(ASSOC_TYPE_WORKFLOW_STAGE);
      return array(
         'submissionId' => $submission->getId(),
         'stageId' => $stageId,
      );
   }
 
   protected function isFilterFormCollapsible() {
      return false;
   }
 
   protected function getItemsNumber() {
      return 20;
   }
 
   protected function getFilterValues($filter) {
      if (isset($filter['filterUserGroupId']) && $filter['filterUserGroupId']) {
         $filterUserGroupId = $filter['filterUserGroupId'];
      } else {
         $keys = array_keys($this->_userGroupOptions);
         $filterUserGroupId = reset($keys);
      }
      if (isset($filter['name']) && $filter['name']) {
         $name = $filter['name'];
      } else {
         $name = null;
      }
      return array($filterUserGroupId, $name);
   }
 
}