SubscriberSelectGridHandler.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.GridHandler');
import('lib.pkp.controllers.grid.users.userSelect.UserSelectGridCellProvider');
 
class SubscriberSelectGridHandler extends GridHandler {
   var $_userGroupOptions;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER, ROLE_ID_SUBSCRIPTION_MANAGER),
         array('fetchGrid', 'fetchRows')
      );
   }
 
   //
   // Implement template methods from PKPHandler
   //
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
      $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      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()) {
         $this->_userGroupOptions[$userGroup->getId()] = $userGroup->getLocalizedName();
      }
 
      $this->setTitle('editor.submission.findAndSelectUser');
 
      // Columns
      $cellProvider = new UserSelectGridCellProvider($request->getUserVar('userId'));
      $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) {
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      return $users = $userGroupDao->getUsersById(
         $filter['userGroup'],
         $request->getContext()->getId(),
         $filter['searchField'],
         $filter['search']?$filter['search']:null,
         $filter['searchMatch'],
         $this->getGridRangeInfo($request, $this->getId())
      );
   }
 
   function renderFilter($request, $filterData = array()) {
      $context = $request->getContext();
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $userGroups = $userGroupDao->getByContextId($context->getId());
      $userGroupOptions = array('' => __('grid.user.allRoles'));
      while ($userGroup = $userGroups->next()) {
         $userGroupOptions[$userGroup->getId()] = $userGroup->getLocalizedName();
      }
 
      return parent::renderFilter(
         $request,
         array(
            'userGroupOptions' => $userGroupOptions,
         )
      );
   }
 
   function getFilterSelectionData($request) {
      // If we're editing an existing subscription, use the filter form to ensure that
      // the already-selected user is chosen.
      if (($userId = $request->getUserVar('userId')) && !$request->getUserVar('clientSubmit')) {
         $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
         $user = $userDao->getById($userId);
         return array(
            'userGroup' => null,
            'searchField' => USER_FIELD_USERNAME,
            'searchMatch' => 'is',
            'search' => $user->getUsername(),
         );
      }
 
      return array(
         'userGroup' => $request->getUserVar('userGroup') ? (int)$request->getUserVar('userGroup') : null,
         'searchField' => $request->getUserVar('searchField'),
         'searchMatch' => $request->getUserVar('searchMatch'),
         'search' => (string) $request->getUserVar('search'),
      );
   }
 
   protected function getFilterForm() {
      return 'controllers/grid/users/exportableUsers/userGridFilter.tpl';
   }
 
   protected function isFilterFormCollapsible() {
      return false;
   }
 
   protected function getItemsNumber() {
      return 5;
   }
 
   function getRequestArgs() {
      $request = Application::get()->getRequest();
      return array_merge(parent::getRequestArgs(), array(
         'userId' => $request->getUserVar('userId'),
      ));
   }
}